Sign in

v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Customer Bank Accounts

Update a customer bank account

Update a customer bank account

put/api/v1/merchants/{merchantId}/customer-bank-accounts/{id}

Path parameters

merchantIdstring uuid required

The unique identifier of the merchant

Example:123e4567-e89b-12d3-a456-426614174000

The unique identifier of the merchant

idstring uuid required

The unique identifier of the customer bank account

Example:123e4567-e89b-12d3-a456-426614174001

The unique identifier of the customer bank account

Request body

account_holder_namestring required

Name of the account holder

customer_idstring uuid

The customer who owns this bank account. Required when minting accounts outside the Flinks-linking flow.

currencystring required

The currency of the bank account

countrystring required

The country of the bank account

ibanstring

The IBAN of the bank account

account_numberstring

The account number of the bank account

sort_codestring

The sort code of the bank account (UK)

routing_numberstring

The routing number of the bank account (US)

bbanstring

Basic Bank Account Number (e.g., Norway)

plusgiro_numberstring

PlusGiro number (Sweden)

bsbstring

Bank State Branch code (Australia)

bicstring

The BIC/SWIFT code of the bank account

Example request

{
  "account_holder_name": "John Smith",
  "customer_id": "123e4567-e89b-12d3-a456-426614174002",
  "currency": "GBP",
  "country": "GB",
  "iban": "DE89370400440532013000",
  "account_number": "11223344",
  "sort_code": "123456",
  "routing_number": "123456789",
  "bban": "86011117947",
  "plusgiro_number": "41054685",
  "bsb": "062-000",
  "bic": "MARKDEF1100"
}

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "currency": "GBP",
    "country": "GB",
    "status": "active",
    "account_holder_name": "John Smith",
    "iban": "DE89370400440532013000",
    "account_number": "11223344",
    "sort_code": "123456",
    "routing_number": "123456789",
    "bban": "86011117947",
    "plusgiro_number": "41054685",
    "bsb": "062-000",
    "bic": "MARKDEF1100",
    "created_at": "2024-03-19T12:00:00Z",
    "updated_at": "2024-03-19T12:00:00Z"
  }
}