CHcheckout
Instruments

Create an instrument

Create a payment instrument like card, bank, ach or sepa to use for future payments and payouts.

The parameters you need to provide when creating a bank account payment instrument depend on the account's country and currency. See the <a href="https://www.checkout.com/docs/payments/request-payouts/bank-payouts/payout-formatting" target="_blank">payout formatting documentation</a>, or use the GET /validation/bank-accounts/{country}/{currency} <a href="https://api-reference.checkout.com/#operation/getBankAccountFields">endpoint</a>.

post/instruments

Request

Request body

OR
OR
OR
OR
OR

Example request

{
  "account_type": "savings",
  "account_number": "13654567455",
  "bank_code": "123-456",
  "branch_code": "6443",
  "iban": "HU93116000060000000012345676",
  "bban": "3704 0044 0532 0130 00",
  "swift_bic": "37040044",
  "currency": "GBP",
  "country": "GB",
  "processing_channel_id": "pc_u2l6xz5joigedmk7g5vxzt7rqy",
  "account_holder": {
    "type": "individual",
    "first_name": "John",
    "last_name": "Smith",
    "tax_id": "123456",
    "date_of_birth": "1986-01-01T00:00:00.0000000",
    "country_of_birth": "GB",
    "residential_status": "resident",
    "billing_address": {
      "address_line1": "123 High St.",
      "address_line2": "Flat 456",
      "city": "London",
      "zip": "SW1A 1AA",
      "country": "GB"
    },
    "phone": {
      "country_code": "+1",
      "number": "415 555 2671"
    },
    "identification": {
      "type": "SSN"
    }
  },
  "bank": {
    "name": "Lloyds TSB",
    "branch": "Bournemouth",
    "address": {
      "address_line1": "123 High St.",
      "address_line2": "Flat 456",
      "city": "London",
      "zip": "SW1A 1AA",
      "country": "GB"
    }
  },
  "customer": {
    "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
    "email": "brucewayne@gmail.com",
    "name": "Bruce Wayne",
    "phone": {
      "country_code": "+1",
      "number": "415 555 2671"
    },
    "default": true
  },
  "metadata": {
    "documentNumber": "12345678900",
    "partnerId": "partner_123"
  }
}

Response

Existing instrument for customer and card details found

OR
OR
OR
OR

Example response

{
  "type": "bank_account",
  "id": "src_wmlfc3zyhqzehihu7giusaaawu",
  "fingerprint": "vnsdrvikkvre3dtrjjvlm5du4q",
  "customer": {
    "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
    "email": "johnsmith@example.com",
    "name": "John Smith",
    "phone": {
      "country_code": "+1",
      "number": "415 555 2671"
    },
    "summary": {
      "registration_date": "2023-05-01T00:00:00.0000000",
      "first_transaction_date": "2023-07-01T00:00:00.0000000",
      "last_payment_date": "2023-08-01T00:00:00.0000000",
      "total_order_count": 15,
      "last_payment_amount": 500,
      "is_premium_customer": true,
      "is_returning_customer": true,
      "lifetime_value": 500
    }
  },
  "bank": {
    "name": "Lloyds TSB",
    "branch": "Bournemouth",
    "address": {
      "address_line1": "123 High St.",
      "address_line2": "Flat 456",
      "city": "London",
      "zip": "SW1A 1AA",
      "country": "GB"
    }
  },
  "swift_bic": "37040044",
  "account_number": "13654567455",
  "bank_code": "123-456",
  "iban": "HU93116000060000000012345676",
  "metadata": {
    "documentNumber": "12345678900",
    "partnerId": "partner_123"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.