checkout

Get Bank Link

Changed on

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.

post/checkout/bank-link

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/checkout/bank-link
  • Auth
    API key in header x-coinflow-auth-user-id

Headers

x-coinflow-submerchant-idstring

Request body

blockchain'solana' | 'eth' | 'polygon' | 'base' | 'arbitrum' | 'stellar' | 'monad' | 'tempo' | 'user'

Coinflow Types *

emailstring

Prefills the customer's email on the hosted page.

callbackUrlstring

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

linkstring required

Changes

  • 81b590227b14Revision changes
    • warning

      deleted the header request parameter x-coinflow-auth-user-id

    • info

      the endpoint scheme security userId was added to the API

  • 66b771d6d31fRevision changes
    • info

      api operation id get-bank-link removed and replaced with checkout_GetBankLink