---
title: "Get Bank Link"
method: POST
path: "/checkout/bank-link"
tags: ["checkout"]
---

# Get Bank Link

`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`

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.

## Headers

- `x-coinflow-submerchant-id` string

## Request body

- GetBankLinkArgs: Request body for getting a standalone bank-account linking link.
  - `blockchain` 'solana' | 'eth' | 'polygon' | 'base' | 'arbitrum' | 'stellar' | 'monad' | 'tempo' | 'user': Coinflow Types *
  - `theme` MerchantTheme
    - `showCardIcon` boolean
    - `placeholderColor` string
    - `expirationPlaceholder` string
    - `cvvPlaceholder` string
    - `cardNumberPlaceholder` string
    - `fontWeight` string
    - `fontSize` string
    - `style` 'rounded' | 'sharp' | 'pill'
    - `font` string
    - `ctaColor` string
    - `textColorAction` string
    - `textColorAccent` string
    - `textColor` string
    - `backgroundAccent2` string
    - `backgroundAccent` string
    - `cardBackground` string
    - `background` string
    - `primary` string
  - `email` string: Prefills the customer's email on the hosted page.
  - `customerInfo` union
    - SplitNameCustomerInfo
      - `verificationId` string
      - `displayName` string
      - `address` string
      - `city` string
      - `state` string
      - `zip` string
      - `country` string
      - `ip` string
      - `lat` string
      - `lng` string
      - `dob` string: Date of birth in YYYY-MM-DD format
      - `email` string
      - `firstName` string, required
      - `lastName` string, required
    - NameCustomerInfo
      - `verificationId` string
      - `displayName` string
      - `address` string
      - `city` string
      - `state` string
      - `zip` string
      - `country` string
      - `ip` string
      - `lat` string
      - `lng` string
      - `dob` string: Date of birth in YYYY-MM-DD format
      - `email` string
      - `name` string
  - `callbackUrl` string: 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 `200`

Ok

- CheckoutGetBankLinkResponse200
  - `link` string, required

## Changes

- **2026-09-17** `81b590227b14`: 1 warning, 1 info
  - deleted the `header` request parameter `x-coinflow-auth-user-id`
  - the endpoint scheme security `userId` was added to the API
- **2026-09-12** `66b771d6d31f`: 1 info
  - api operation id `get-bank-link` removed and replaced with `checkout_GetBankLink`
- **2026-09-03** `7f68c01714c8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/coinflow/apis/api-reference/changes/checkout/bank-link/post.md)

---

[API](https://skmtc.dev/coinflow/apis/api-reference.md) - [All operations](https://skmtc.dev/coinflow/apis/api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/coinflow/apis/api-reference/revisions/96ee3929f3ba?raw)