API ReferenceCheckout

Get Bank Link

Gets a standalone link where a customer links a bank account to be used for future ACH checkouts. The link can be opened directly by the customer or embedded in an iframe.

Authentication

x-coinflow-auth-user-idstring
The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
Authorizationstring
The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
OR
Authorizationstring
The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
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

Headers

x-coinflow-submerchant-idstringOptional

Request

This endpoint expects an object.
blockchainenumOptional

Coinflow Types *

themeobjectOptional
emailstringOptional
Prefills the customer's email on the hosted page.
customerInfoobjectOptional
callbackUrlstringOptional

URL the customer is returned to when the linking session ends, however it ends. A bankLinkStatus query parameter reports the outcome (linked, canceled or failed), and is the only parameter added. Reaching this URL is not by itself evidence of a link. Retrieve the linked accounts from Get Customer. Must be an origin whitelisted on your merchant account, the same as any other merchant redirect URL.

Omit it to end the flow on Coinflow’s confirmation rather than redirecting. The linked accounts are still readable from Get Customer.

Response

Ok