Create Bank Account

curl -X POST https://api-sandbox.coinflow.cash/api/withdraw/account \
     -H "x-coinflow-auth-user-id: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "alias": "string",
  "routingNumber": "string",
  "accountNumber": "string",
  "type": "checking"
}'

{
  "withdrawer": {
    "_id": "string",
    "wallet": "string",
    "blockchain": "solana",
    "wallets": [
      {
        "wallet": "string",
        "blockchain": "solana"
      }
    ],
    "email": "string",
    "availability": {
      "status": "Functional",
      "reason": "string",
      "editor": "string",
      "updatedAt": "2024-01-15T09:30:00Z"
    },
    "currency": "USD",
    "merchant": "string",
    "verification": {
      "reference": "string",
      "status": "pending",
      "vendor": "middesk",
      "name": "string",
      "attested": true,
      "shareToken": "string",
      "shareTokenStatus": "string",
      "sessionToken": "string"
    },
    "riskScoreOverride": true,
    "country": "string",
    "bankAccounts": [
      {
        "reference": "string",
        "alias": "string",
        "token": "string",
        "last4": "string",
        "accountHash": "string",
        "accountNumber": "string",
        "accountNumberOnlyHash": "string",
        "isDeleted": true,
        "isTokenized": true
      }
    ],
    "cards": [
      {
        "type": "VISA",
        "createdAt": "2024-01-15T09:30:00Z",
        "token": "string",
        "last4": "string",
        "disbursementStatus": "Immediate",
        "currency": "USD",
        "isDeleted": true,
        "nameOnCard": "string",
        "expMonth": "string",
        "expYear": "string"
      }
    ],
    "ibans": [
      {
        "reference": "string",
        "alias": "string",
        "token": "string",
        "last4": "string",
        "accountHash": "string",
        "sortCode": "string",
        "bic": "string"
      }
    ],
    "pixes": [
      {
        "key": "string",
        "accountHash": "string",
        "token": "string"
      }
    ],
    "efts": [
      {
        "reference": "string",
        "alias": "string",
        "token": "string",
        "accountHash": "string",
        "mask": "string",
        "institutionId": "string",
        "isDeleted": true,
        "institution": "string",
        "transit_number": "string"
      }
    ],
    "p2cAvailable": true,
    "applePayAvailable": true,
    "bankCurrencyOptions": [
      "USD"
    ],
    "originalCurrency": "USD",
    "venmo": {
      "type": "venmo",
      "alias": "string",
      "token": "string",
      "isDeleted": true
    },
    "paypal": {
      "type": "paypal",
      "alias": "string",
      "token": "string",
      "isDeleted": true
    },
    "interac": {
      "type": "interac",
      "alias": "string",
      "token": "string",
      "isDeleted": true
    }
  }
}

Creates a bank account for a particular user or business.

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

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

Authorizationstring

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

Request

This endpoint expects an object.

aliasstringRequired

routingNumberstringRequired

accountNumberstringRequired

typeenumRequired

Allowed values:

wireRoutingNumberstringOptional

addressobjectOptional

If address is not available on the user's KYC,the endpoint will return a 412 error and the request must be retried with the user's address information.

Response

withdrawerobject