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
      • POSTAdd Bank Account
      • POSTCreate an Iban account
      • POSTCreate Card for Customer
      • POSTCreate Customer
      • DELDelete Bank Account
      • DELDelete Card
      • DELDelete Iban Account
      • GETGet Balances
      • GETGet Customer
      • GETGet Purchase History
      • GETGet Purchase History By ID
      • POSTPlaid Bank Account Status Check
    • POSTGets USDC/SBC/EuroE on testnets
LogoLogo
RegisterLoginSandbox Login
API ReferenceCustomers

Plaid Bank Account Status Check

POST
https://api-sandbox.coinflow.cash/api/customer/plaid-check
POST
/api/customer/plaid-check
$curl -X POST https://api-sandbox.coinflow.cash/api/customer/plaid-check \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "accounts": [
>    {
>      "customerId": "cust_987654321"
>    }
>  ]
>}'
200Successful
1[
2  {
3    "status": "active",
4    "customerId": "cust_987654321",
5    "errorCode": "",
6    "errorMessage": "",
7    "balance": {
8      "current": 2543.75,
9      "available": 2000,
10      "limit": 0,
11      "isoCurrencyCode": "USD",
12      "unofficialCurrencyCode": ""
13    },
14    "bankAccountToken": "bank_tok_123abc456def"
15  }
16]

Checks whether a customer’s Plaid-linked bank account is still active and valid. Returns a normalized status (active, removed, login_required, or error) that merchants can use to gate transaction attempts before submission.

Was this page helpful?
Previous

Report Event

Next
Built with

Authentication

Authorizationstring

The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Request

  • The customerId identifying the customer whose Plaid-linked account should be checked, and an optional bankAccountToken to identify a specific bank account. If no token is provided, the customer’s most recently linked Plaid bank account will be checked.
accountslist of objectsRequired

Response

Ok
statusenum
Allowed values:
customerIdstring
errorCodestring
errorMessagestring
balanceobject or null
bankAccountTokenstring