v1

latestOpenAPI 3.1.02026-07-132363652.9 MB

Transactions

Link a customer bank account to a transaction for refund payouts

put/api/v1/merchants/{merchantId}/transactions/{transactionId}/customer-bank-account

Path parameters

merchantIdstring uuid required

The unique identifier of the merchant

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

The unique identifier of the merchant

transactionIdstring uuid required

The unique identifier of the transaction

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

The unique identifier of the transaction

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

Example response

{
  "data": {
    "currency": {
      "code": "GBP",
      "symbol": "€",
      "name": "Euro",
      "minor_unit": 2
    },
    "payout_currency": {
      "code": "GBP",
      "symbol": "€",
      "name": "Euro",
      "minor_unit": 2
    },
    "payment_request": {
      "order_id": "ORD-2025-00123",
      "payment_token": "tok_abc123def456"
    },
    "merchant_webhook_deliveries": [
      {
        "event_type": "quidkey.payment_request.succeeded"
      }
    ],
    "fees": {
      "currency": {
        "code": "GBP",
        "symbol": "€",
        "name": "Euro",
        "minor_unit": 2
      },
      "items": [
        {
          "currency": {
            "code": "GBP",
            "symbol": "€",
            "name": "Euro",
            "minor_unit": 2
          }
        }
      ]
    },
    "refunds": [
      {
        "currency": {
          "code": "GBP",
          "symbol": "€",
          "name": "Euro",
          "minor_unit": 2
        },
        "payout_currency": {
          "code": "GBP",
          "symbol": "€",
          "name": "Euro",
          "minor_unit": 2
        },
        "payment_request": {
          "order_id": "ORD-2025-00123",
          "payment_token": "tok_abc123def456"
        },
        "merchant_webhook_deliveries": [
          {
            "event_type": "quidkey.payment_request.succeeded"
          }
        ],
        "fees": {
          "currency": {
            "code": "GBP",
            "symbol": "€",
            "name": "Euro",
            "minor_unit": 2
          },
          "items": [
            {
              "currency": {
                "code": "GBP",
                "symbol": "€",
                "name": "Euro",
                "minor_unit": 2
              }
            }
          ]
        }
      }
    ],
    "reversals": [
      {
        "currency": {
          "code": "GBP",
          "symbol": "€",
          "name": "Euro",
          "minor_unit": 2
        },
        "payout_currency": {
          "code": "GBP",
          "symbol": "€",
          "name": "Euro",
          "minor_unit": 2
        },
        "payment_request": {
          "order_id": "ORD-2025-00123",
          "payment_token": "tok_abc123def456"
        },
        "merchant_webhook_deliveries": [
          {
            "event_type": "quidkey.payment_request.succeeded"
          }
        ],
        "fees": {
          "currency": {
            "code": "GBP",
            "symbol": "€",
            "name": "Euro",
            "minor_unit": 2
          },
          "items": [
            {
              "currency": {
                "code": "GBP",
                "symbol": "€",
                "name": "Euro",
                "minor_unit": 2
              }
            }
          ]
        }
      }
    ]
  }
}