API ReferenceGet API keysGet Integration SupportBlog

GBP Payouts (CHAPS)

Suggest Edits

This section covers the parameters needed to process payments to bank accounts in the UK.

📘

Understanding the sections below is required to fully comprehend how the payout API works.


CHAPS Transfers

The processing parameters for the Clearing House Automated Payment System (CHAPS) scheme are described in this section. These parameters can be used to process payments to UK bank accounts. Please be aware that the CHAPS payment is available Monday to Friday excluding bank holidays, and usually has a cut-off time of 5.30 pm. Please see the bank of England documentation on chaps for more details.

To make payments you will need to send the required parameters to the payout endpoint

Individual Beneficiary

FieldMandatoryTypeDescription
businessYesstringThe ID of the business making the payout.
sourceCurrencyYesstringThe currency which is used to fund the payout
destinationCurrencyYesstringThe currency in which the recipient will be receiving funds
amountYesstringThe value that is to be transferred from the source currency wallet.
descriptionYesstringThe description of the payout
paymentDestinationYesstringThis is the type of account you want to send your payments to, see payment destinations for more details
customerReferenceNostringThis is the unique reference generated for the transaction on your platform.
quoteReferenceNostringThis is the reference generated when the source currency is compared against the destination currency. This is required when the source currency is not the same as the destination currency. You can generate a quote using the Generate quote endpoint.
beneficiaryYesobjectThe recipient of the funds. Depending on the currency and beneficiary type, the properties of the beneficiaries are different.
beneficiary.firstNameYesstringThe first name of the beneficiary .
beneficiary.lastNameYesstringThe last name of the beneficiary .
beneficiary.accountHolderNameYesstringThis field is required by all type of beneficiaries.
beneficiary.accountNumberYesstringThis is the bank account number of the beneficiary or phone number if the account is a mobile money wallet.
beneficiary.typeYesstringThe type of beneficiary, see beneficiary types for more details
beneficiary.countryYesstringThe country in which the beneficiary resides.
beneficiary.emailNostringThe beneficiary's email
beneficiary.sortCodeYesstringThe beneficiary's bank sort code. Sort codes are the domestic bank codes used to route money transfers between financial institutions in the United Kingdom, and in the Republic of Ireland. e.g 000000
beneficiary.bankSwiftCodeYesstringThe beneficiary's bank swift code according to ISO9362 . e.g UBSWCHZH80A

The payload should look like this :

{
    "business": "{{The business ID}}",
    "sourceCurrency": "GBP",
    "destinationCurrency": "GBP",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "bank_account",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",,
        "sortCode" : "hhgghxgh",
        "bankSwiftCode" : "hhgghxgh"
    },
    "paymentScheme": "chaps",
    "quoteReference": "d187b2fa-27cd-43e6-b622-66361e409c6d"
}

Corporate Beneficiary

FieldMandatoryTypeDescription
businessYesstringThe ID of the business making the payout.
sourceCurrencyYesstringThe currency which is used to fund the payout
destinationCurrencyYesstringThe currency in which the recipient will be receiving funds
amountYesstringThe amount to be sent.This should be in larger units
descriptionYesstringThe description of the payout
paymentDestinationYesstringThis is the type of account you want to send your payments to, see payment destinations for more details
customerReferenceNostringThis is the unique reference generated for the transaction on your platform.
quoteReferenceNostringThis is the reference generated when the source currency is compared against the destination currency. This is required when the source currency is not the same as the destination currency. You can generate a quote using the Generate quote endpoint.
beneficiaryYesobjectThe recipient of the funds. Depending on the currency and beneficiary type, the properties of the beneficiaries are different.
beneficiary.accountHolderNameYesstringThis field is required by all type of beneficiaries.
beneficiary.accountNumberYesstringThis is the bank account number of the beneficiary or phone number if the account is a mobile money wallet.
beneficiary.typeYesstringThe type of beneficiary, see beneficiary types for more details
beneficiary.countryYesstringThe country in which the beneficiary resides.
beneficiary.emailNostringThe beneficiary's email
beneficiary.sortCodeYesstringThe beneficiary's bank sort code
beneficiary.bankSwiftCodeYesstringThe beneficiary's bank swift code

The payload should look like this :

{
    "business": "{{The business ID}}",
    "sourceCurrency": "GBP",
    "destinationCurrency": "GBP",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "bank_account",
    "beneficiary": {
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "corporate",
        "email": "[email protected]",,
        "sortCode" : "hhgghxgh",
        "bankSwiftCode" : "hhgghxgh"
    },
    "paymentScheme": "chaps",
    "quoteReference": "d187b2fa-27cd-43e6-b622-66361e409c6d"
}

Updated almost 2 years ago