Create a Payment Request

How to create an API Payment request

Initiating a payment through the BCB API involves a secure, authenticated request to our dedicated payment endpoint. This process allows your application to programmatically send funds to a specified recipient, streamlining your financial operations.

The general flow to create a payment is as follows:

Authentication:

Before making any payment request, you must first obtain a valid Access Token (Bearer token) by authenticating with your Client ID and Client Secret. This token ensures your request is authorized.

Reference: Consult the "Authentication" section for details on obtaining and refreshing your token.

Identify the Payment Endpoint:

Payments are typically created by sending a POST request to a specific endpoint designed for payment initiation.

Construct the Request Body (JSON Payload):

The core details of the payment are sent in the request body, typically as a JSON object. This payload contains all the necessary information for the transaction.

Common Required Fields Include:

{
    "counterparty_id": YOUR_COUNTERPARTY_ID,
    "sender_account_id": YOUR_ACCOUNT_ID,
    "beneficiary_account_id": BENEFICIARY_ACCOUNT_ID,
    "ccy": "GBP",
    "amount": "888.11",
    "reference": "Your Reference",
    "reason": "Payment for goods or services",
    "notes": "URGENT",
    "preferred_scheme": "AUTO" (LEGACY: ALWAYS AUTO, WILL BE DEPRECATED),
    "nonce": "123456789" (OPTIONAL)
}

Example Payloads by Currency

Add Links for Diff Currencies here