For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
RegisterLoginSandbox Login
GuidesRecipesAPI Reference
GuidesRecipesAPI Reference
  • API Reference
      • POSTACH Checkout
      • POSTApple Pay Checkout
      • GETApple Pay Validate Merchant
      • POSTCapture Payment
      • POSTCard Checkout
      • POSTCard on File Authorized
      • POSTCard On File Checkout
      • POSTCash App Checkout
      • POSTCreate Pix Payment
      • POSTCrypto Payin
      • POSTGet Checkout Jwt Token
      • POSTGet Checkout Link
      • POSTGet Destination Auth Key
      • POSTGet Interchange Fees
      • GETGet supported chains and tokens
      • POSTGet Totals
      • POSTGet USDC Authorization Message (EVM only)
      • POSTGoogle Pay Checkout
      • POSTMerchant Initiated Transaction
      • POSTRain Checkout
      • PUTReview Payment Protection
      • POSTSaved Card Checkout
      • POSTSepa/Faster Payments Checkout (New Account)
      • POSTSepa/Faster Payments Checkout (Saved Account)
      • POSTUS Wire Domestic Payments Checkout (New Account)
      • POSTUS Wire Domestic Payments Checkout (Saved Account)
      • POSTVoid Payment
      • POSTZero Authorization
    • POSTGets USDC/SBC/EuroE on testnets
LogoLogo
RegisterLoginSandbox Login
API ReferenceCheckout

US Wire Domestic Payments Checkout (New Account)

POST
https://api-sandbox.coinflow.cash/api/checkout/wire
POST
/api/checkout/wire
$curl -X POST https://api-sandbox.coinflow.cash/api/checkout/wire \
>     -H "x-coinflow-auth-session-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "subtotal": {
>    "cents": 150000,
>    "currency": "USD"
>  },
>  "merchantId": "merchant_987654321",
>  "data": {
>    "account_number": "123456789012",
>    "alias": "Primary Checking",
>    "email": "jane.doe@example.com",
>    "firstName": "Jane",
>    "lastName": "Doe",
>    "address1": "123 Maple Street",
>    "city": "Springfield",
>    "state": "IL",
>    "zip": "62704",
>    "wireRoutingNumber": "071000013"
>  }
>}'
1{
2  "address": {},
3  "account_number": "123456789012",
4  "wireRoutingNumber": "071000013",
5  "paymentId": "pay_20240615_001",
6  "recipientName": "Jane Doe",
7  "memo": "Invoice #4567",
8  "amount": {
9    "cents": 150000,
10    "currency": "USD"
11  },
12  "expires": "2024-06-15T15:45:00Z"
13}

Initiates a US Domestic Wire Payments payment order with a new account. Returns destination account info. Must be paid before the returned expiration date (5 minutes).

Was this page helpful?
Previous

US Wire Domestic Payments Checkout (Saved Account)

Next
Built with

Authentication

x-coinflow-auth-session-keystring
The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
OR
x-coinflow-auth-walletstring
The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
x-coinflow-auth-blockchainstring
The blockchain associated with the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Request

This endpoint expects an object.
subtotalobjectRequired
merchantIdstringRequired
Merchant Identifier
dataobjectRequired
customPayInFeeslist of objectsOptional
customerInfoobjectOptional
webhookInfoobjectOptional
feePercentagedoubleOptional0-100

If this purchase is for a seller/submerchant where the marketplace takes a fee, this is the % fee which is taken from the subtotal amount.

fixedFeeobjectOptional
jwtTokenstringOptional
This is a token encoding the parameters for the request. Allows purchase parameters to be verified to prevent manipulation when the checkout page is presented to the user.
rentobjectOptional

(Solana only) if your transaction requires a known amount of Rent to be paid, you can pass it here.

transactionDataobjectOptional

(EVM only) if you want to execute an EVM transaction on a successful purchase, you can pass a transaction request here.

Gas fees for the transaction will be automatically calculated and added to the total charged to the customer. Optionally the merchant can opt to pay for these gas fees.

stellarTransactionstringOptional

(Stellar only) Base64 XDR transaction string for executing a merchant contract call on a successful purchase.

For transaction purchases, pass the base64 XDR string created using .toXDR() on a transaction built with generated TypeScript bindings (e.g., NftClientWrapper.buildNftPurchaseTx).

For direct USDC transfers (no merchant transaction), omit this field or pass undefined.

Gas fees for the transaction will be automatically calculated and added to the total charged to the customer.

settlementTypeenumOptional
Allowed values:
destinationAuthKeystringOptional
If utilizing USDC settlement to addresses other than your main merchant settlement address. Utilize this destinationAuthKey which is a JWT encoded with the information for which address to send the USDC to.
customerUsdcTransferDataobjectOptional

Customer signed USDC transferWithAuthorization data for dual-source payments Used for combined USDC + Credit Card payments on EVM chains

customerUsdcTransferDataV2objectOptional

V2 of CustomerUsdcTransferData — replaces the (v, r, s) triple with a single signature bytes string, matching USDC FiatTokenV2_2’s bytes-overload transferWithAuthorization. All other fields unchanged from V1.

userLocationobjectOptional

End-user geographic coordinates captured at the moment of the withdrawal request. Consumed by BlockingRuleMethod.GEOLOCATION enforcement.

Replay-of-different-coords bypass is prevented server-side: the first resolved {country, state} for a given (merchant, user) pair is pinned in Redis, and subsequent requests are evaluated against that pinned value regardless of the lat/lng they submit.

Response

Ok
addressobject
Make all properties in T optional
account_numberstring
The bank account number that funds should be directed to.
wireRoutingNumberstring
The wire routing number that funds should be directed to.
paymentIdstring
recipientNamestring
memostring
amountobject
expiresstring

Errors

412
Precondition Failed Error
423
Locked Error
428
Precondition Error
451
Unavailable for Legal Reasons Error

The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

The blockchain associated with the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key