# Add a payment instrument

You must create a payment instrument for each holding currency you specify. The account details are saved securely in the Checkout.com [Vault](https://www.checkout.com/docs/payments/store-and-manage-credentials.md). You receive a unique instrument ID to use in payout requests, instead of entering the bank details every time.

Call the [Add a payment instrument](https://api-reference.checkout.com/tag/Payment-instruments/#operation/addPlatformsPaymentInstrument) endpoint, and provide the sub-entity ID as the `{id}` path parameter.

In the request body, provide the following:

- `label` – Your reference for the payment instrument
- `type` – Set to `bank_account`.
- `currency` – The account's currency, as an ISO 4217 currency code
- `country`– The account's country, as an ISO 3166 alpha-2 country code
- `instrument_details.account_number` – The alphanumeric value that identifies the account
- `instrument_details.bank_code` – The code that identifies the bank
- `document.type`– Set to `bank_statement`.
- `document.file_id`– The file ID of the document uploaded when adding bank account details

If you're using a SEPA account, see the [API reference](https://api-reference.checkout.com/tag/Payment-instruments/#operation/addPlatformsPaymentInstrument) for more information.

> **Information**
>
> Your base URL's `{prefix}` value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see [API endpoints](https://www.checkout.com/docs/developer-resources/api/api-endpoints.md).

**Production**

`POST` `https://{prefix}.api.checkout.com/accounts/entities/{id}/payment-instruments`

**Sandbox**

`POST` `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{id}/payment-instruments`

### Request example

```json
{
  "label": "Bob's Bank Account",
  "type": "bank_account",
  "currency": "GBP",
  "country": "GB",
  "default": true,
  "instrument_details": {
    "account_number": "12345678",
    "bank_code": "050389"
  },
  "document": {
    "type": "bank_statement",
    "file_id": "file_wxglze3wwywujg4nna5fb7ldli"
  }
}
```
When you create a payment instrument, it automatically goes through a due diligence verification process.
It must successfully pass the verification process before you can proceed to the next step.

When the result is available, you receive one of the following webhooks:
- [Payment instrument verification passed](https://www.checkout.com/docs/developer-resources/event-notifications/event-types/payment_instrument_verification_passed.md)
- [Payment instrument verification failed](https://www.checkout.com/docs/developer-resources/event-notifications/event-types/payment_instrument_verification_failed.md)

The first payment instrument added for a specific currency is automatically associated to the payouts schedule for that currency. You need to associate any subsequent payment instruments to use as the destination when a payout is made. For more information, see [Scheduled payouts](#Scheduled_payouts).

After creating a payment instrument, you can [retrieve the details of a payment instrument](https://api-reference.checkout.com/tag/Payment-instruments/#operation/getPlatformsPaymentInstrument), [update the payment instrument details](https://api-reference.checkout.com/tag/Payment-instruments/#operation/updatePlatformsPaymentInstrument), or [fetch all payment instruments for a sub-entity](https://api-reference.checkout.com/tag/Payment-instruments/#operation/queryPlatformsPaymentInstruments).
---