Activate multiple bank rails

Create or upsert Bank rows for multiple rails in one request. Returns a per-rail result so one pending or failed rail does not abort the batch.

POST /api/v1/banks/activate

Activate multiple bank rails

cURL

curl --request POST \
  --url https://api.example.com/api/v1/banks/activate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "rails": []
}'

200

{
  "results": [
    {
      "rail": "uaefts_named-zand",
      "ok": true,
      "bank": {
        "rail": "uaefts_named-zand",
        "bankName": "<string>",
        "country": "<string>",
        "currency": "<string>",
        "type": "sepa",
        "method": "sepa",
        "methods": [
          "sepa"
        ],
        "pooled": true,
        "compliance": 123,
        "bankIcon": "<string>",
        "depositFee": 123,
        "feeBps": "<string>",
        "timeToOpen": "<1 day",
        "status": "not_started",
        "capabilities": {
          "memoSupported": true,
          "minAmount": 123,
          "rails": [
            {
              "method": "<string>",
              "name": "<string>",
              "minAmount": 123,
              "fixedFee": 123,
              "memoLengthLimit": 123,
              "amountToSupported": false,
              "sourceTokens": [
                "USDC"
              ]
            }
          ],
          "memoLengthLimit": 123,
          "supportedTokens": [
            "USDC"
          ]
        },
        "accountHolderBusinessName": "<string>",
        "accountHolderFirstName": "<string>",
        "accountHolderLastName": "<string>",
        "ibanData": {
          "bankName": "<string>",
          "accountHolderType": "individual",
          "beneficiaryName": "<string>",
          "bankAddress": {
            "addressLine1": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postalCode": "<string>",
            "country": "<string>"
          },
          "currency": "<string>",
          "accountHolderFirstName": "<string>",
          "accountHolderLastName": "<string>",
          "accountHolderBusinessName": "<string>",
          "accountHolderAddress": {
            "streetAddress": "<string>",
            "addressLine2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "country": "AF",
            "zip": "<string>"
          },
          "relationship": "employee",
          "businessIndustry": "<string>",
          "paymentReference": "<string>",
          "accountType": "sepa",
          "ibanNumber": "<string>",
          "bic": "<string>"
        },
        "features": {
          "1pt_payin": "enabled",
          "3pt_payin": "enabled",
          "1pt_payout": "enabled",
          "3pt_payout": "enabled"
        },
        "depositToken": "USDC",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "externalAccountId": "<string>",
        "psp": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "error": {
        "statusCode": 123,
        "message": "<string>",
        "detail": null
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Body

application/json

Bulk bank activation request.

rails · enum<string>[] · required

Client-visible bank transfer route; provider identity lives separately.

Available options: uaefts_named-zand, ach_pooled-hsbc, ach_pooled-citi, ach_named-citi, ach_named-jpmorgan_chase, ach_named-cfsb, fedwire_pooled-hsbc, fedwire_pooled-jpmorgan_chase, fedwire_pooled-cfsb, fedwire_named-hsbc, fedwire_named-citi, fedwire_named-jpmorgan_chase, fedwire_named-cfsb, sepa_pooled-zen, sepa_named-zen, sepa_named-banking_circle_dm, pix_pooled-stark_bank, spei_pooled-nvio_pagos, pse_pooled-slx, transfers_3_0_pooled-swipelux, swift_named-zand, swift_named-zenus, ukfps_named-banking_circle, swift_pooled-hsbc, swift_named-hsbc, ach_named-lead_bank, swift_named-lead_bank, wire_named, swift_named-conduit, sepa_pooled-due, sepa_named-due, ukfps_named-due, uaefts_named-due, ach_named-due, fedwire_named-due, swift_named-due, pix_named-due, spei_named-due

Response

200

application/json

Successful Response

Bulk bank activation response.

results · BankActivateRailResult · object[] · required

Show child attributes