v1

latestOpenAPI 3.1.02026-07-132363652.9 MB

Merchant Bank Accounts

Create a bank account for a merchant

post/api/v1/merchants/{id}/bank-accounts

Path parameters

idstring uuid required

The unique identifier of the merchant

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

The unique identifier of the merchant

Request body

account_numberstring

The account number or IBAN of the bank account

currencystring required

The currency of the bank account

countrystring required

The country of the bank account

ibanstring

The IBAN of the bank account (for EU market)

bicstring

The BIC of the bank account (for EU market)

sort_codestring

The sort code of the bank account (for UK market)

routing_numberstring

The routing number of the bank account (for US market)

bank_idstring uuid

The optional unique identifier of the associated bank entity

bbanstring

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

plusgiro_numberstring

PlusGiro number (for Sweden)

bsbstring

Bank State Branch code (for Australia)

account_holder_namestring

Name of the account holder

Example request

{
  "account_number": "11223344",
  "currency": "GBP",
  "country": "GB",
  "iban": "DE89370400440532013000",
  "bic": "MARKDEF1100",
  "sort_code": "123456",
  "routing_number": "123456789",
  "bank_id": "123e4567-e89b-12d3-a456-426614174002",
  "bban": "86011117947",
  "plusgiro_number": "41054685",
  "bsb": "062-000",
  "account_holder_name": "John Smith",
  "supported_payment_schemes": [
    {
      "type": "SEPA_CREDIT_TRANSFER",
      "is_active": true
    }
  ],
  "client_evidence": {
    "checkout_page_version": "a1b2c3d",
    "timezone": "Europe/Dublin",
    "consented_agreements": [
      {
        "kind": "merchant_tos",
        "agreement_id": "00000000-0000-0000-0000-000000000001"
      },
      {
        "kind": "quidkey_privacy",
        "agreement_id": "00000000-0000-0000-0000-000000000002"
      },
      {
        "kind": "merchant_dpa",
        "agreement_id": "00000000-0000-0000-0000-000000000003"
      },
      {
        "kind": "merchant_prohibited_use",
        "agreement_id": "00000000-0000-0000-0000-000000000004"
      },
      {
        "kind": "merchant_pricing_plan",
        "agreement_id": "00000000-0000-0000-0000-000000000005"
      },
      {
        "kind": "third_party_provider_agreements",
        "agreement_id": "00000000-0000-0000-0000-000000000006"
      },
      {
        "kind": "transfermate_authorization",
        "agreement_id": "00000000-0000-0000-0000-000000000007"
      }
    ],
    "checkbox_language": [
      {
        "checkbox_id": "consent-quidkey",
        "rendered_text": "I confirm I am an authorized representative of this business and agree to Quidkey's …",
        "covers_kinds": [
          "merchant_tos",
          "quidkey_privacy",
          "merchant_dpa",
          "merchant_prohibited_use",
          "merchant_pricing_plan",
          "third_party_provider_agreements"
        ]
      },
      {
        "checkbox_id": "consent-transfermate",
        "rendered_text": "I confirm by ticking this box I authorise Quidkey to view and enter transactions with TransferMate on my behalf …",
        "covers_kinds": [
          "transfermate_authorization"
        ]
      }
    ]
  }
}

Response

Created

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"
  }
}