v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Merchant Bank Account Payment Schemes

Update/merge payment schemes for a specific bank account. Only modifies specified schemes, preserves existing ones not mentioned.

Update/merge payment schemes for a specific bank account. Only modifies specified schemes, preserves existing ones not mentioned.

put/api/v1/bank-accounts/{bankAccountId}/payment-schemes

Path parameters

bankAccountIdstring uuid required

The unique identifier of the bank account

Example:ef84a547-8956-460e-a4a3-9d313da5efca

The unique identifier of the bank account

Request body

Example request

{
  "supported_payment_schemes": [
    {
      "type": "SEPA_CREDIT_TRANSFER",
      "is_active": true
    }
  ]
}

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "account_number": "11223344",
    "currency": "GBP",
    "country": "GB",
    "created_at": "2024-03-19T12:00:00Z",
    "updated_at": "2024-03-19T12:00:00Z",
    "iban": "DE89370400440532013000",
    "bic": "MARKDEF1100",
    "sort_code": "123456",
    "routing_number": "123456789",
    "bban": "86011117947",
    "plusgiro_number": "41054685",
    "bsb": "062-000",
    "account_holder_name": "John Smith",
    "supported_payment_schemes": [
      {
        "name": "SEPA Credit Transfer"
      }
    ],
    "roles": [
      "receiving",
      "settlement"
    ],
    "balance": "1234.56"
  }
}