Skip to main content
This endpoint allows you to process payouts in Pounds Sterling (GBP) to recipients with a UK bank account via Bank Transfer.

​
Endpoint

POST: {{baseURL}}/v2/payout

​
Request Details

​
Headers

Include these headers in your request:
HeaderValueRequired
Content-Typeapplication/json✅ Yes
x-api-keyYOUR_API_KEY✅ Yes

​
Request Examples

Here are examples of how to make a GBP payout request in different languages. 
curl --location --request POST '{{baseURL}}/v2/payout' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "recipient": {
    "firstName": "Derick",
    "lastName": "Heaney",
    "type": "BUSINESS",
    "account": {
      "bankName": "Investment Account",
      "sortCode": "040004",
      "address": "8190 Amely Freeway",
      "accountNumber": "78355047"
    },
    "paymentChannel": "BANK_TRANSFER",
    "currency": "GBP",
    "country": "GB",
    "stored": true
  },
  "quoteId": "a4f7b2c1-ef14-4999-906b-xxxxxxxxxxxxx",
  "reason": "Gift",
  "remark": "Testing"
}'

​
Request Body Breakdown

FieldTypeDescriptionRequired
quoteIdStringThe unique ID of the quote for this payout.✅ Yes
reasonStringThe purpose of the transfer (e.g., Payment for services).✅ Yes
remarkStringAn optional, additional note about the transaction.✅ Yes
recipientObjectAn object containing all details about the person receiving the funds.✅ Yes
recipient.firstNameStringThe first name of the recipient.✅ Yes
recipient.lastNameStringThe last name of the recipient.✅ Yes
recipient.typeStringThe type of recipient. Enum: INDIVIDUAL, BUSINESS.✅ Yes
recipient.paymentChannelStringThe payment method. Must be BANK_TRANSFER for GBP payouts.✅ Yes
recipient.currencyStringThe ISO currency code. Must be GBP.✅ Yes
recipient.countryStringThe recipient’s two-letter ISO country code. Must be GB.✅ Yes
recipient.storedBooleanA flag indicating whether to save the recipient for future use.✅ Yes
recipient.accountObjectAn object containing the recipient’s bank account details.✅ Yes
recipient.account.bankNameStringThe name of the recipient’s bank.✅ Yes
recipient.account.sortCodeStringThe 6-digit sort code of the UK bank account.✅ Yes
recipient.account.addressStringThe recipient’s residential or business address.✅ Yes
recipient.account.accountNumberStringThe 8-digit bank account number of the recipient.✅ Yes

​
Success Response (200 OK)

If the payout is successfully created, the API returns the following response:
copy
{
  "message": "Transaction created successfully",
  "status": "success",
  "data": {
    "id": "b8c7d6e5-f4a3-210f-fedc-xxxxxxxxxxxxx",
    "reason": "Gift",
    "remark": "Testing",
    "referenceNumber": "GBPPAYOUT12345",
    "type": "SEND",
    "state": "COMPLETED",
    "quote": {
      "id": "a4f7b2c1-ef14-4999-906b-xxxxxxxxxxxxx",
      "source": {
        "currency": "NGN",
        "country": "NG",
        "amount": 250000
      },
      "target": {
        "currency": "GBP",
        "country": "GB",
        "amount": 100
      },
      "rate": 2500,
      "fee": {
        "amount": 1500
      }
    },
    "recipient": {
      "firstName": "Derick",
      "lastName": "Heaney",
      "type": "BUSINESS",
      "account": {
        "accountNumber": "7835XXXX",
        "sortCode": "040004",
        "bankName": "Investment Account",
        "address": "8190 Amely Freeway"
      },
      "paymentChannel": "BANK_TRANSFER",
      "currency": "GBP",
      "country": "GB"
    },
    "created": "2025-09-19T10:05:45.123456Z",
    "processed": "2025-09-19T10:06:12.789101Z"
  }
}

​
Response Breakdown

FieldTypeDescription
messageStringA confirmation message indicating the result of the request.
statusStringThe overall status of the request, e.g., success.
dataObjectA container for all the transaction data.
data.idStringThe unique identifier for this payout transaction.
data.remarkStringThe remark or note that was provided in the request.
data.reasonStringThe reason for the payout provided in the request.
data.referenceNumberStringA unique reference number generated for the payout.
data.typeStringThe type of transaction, e.g., SEND.
data.stateStringThe current state of the payout (COMPLETED, PENDING, etc.).
data.quote.source.currencyStringThe three-letter currency code of the source funds.
data.quote.target.amountNumberThe converted amount that the recipient will receive.
data.recipient.nameStringThe full name of the recipient.
data.recipient.account.accountNumberStringThe recipient’s bank account number.
data.recipient.account.sortCodeStringThe sort code of the recipient’s bank account.
data.recipient.account.bankNameStringThe name of the recipient’s bank.
data.createdStringISO 8601 timestamp of when the transaction was created.
data.processedStringISO 8601 timestamp of when the transaction was processed.---

​
Payout Transaction States

The payout transaction can have one of the following states:
StateDescription
COMPLETEDThe payout was successfully processed.
PENDINGThe payout is still being processed.
FAILEDThe payout failed to process.
REFUNDEDThe payout has been sent back to sender.

​
Error Handling

Status CodeMeaningExample Response
400Insufficient BalanceInsufficient Balance
401UnauthorizedInvalid API key provided.
403ForbiddenIP not whitelisted
404Not FoundThe requested endpoint does not exist.
422Unprocessable EntityInvalid quote ID provided.
500Internal Server ErrorAn internal error occurred.

​
Best Practices

✅ Ensure quoteId is valid and linked to an existing quote.
✅ Confirm that the recipient’s bank account number and bank code are correct.
✅ Use a valid API key in the headers.
✅ Handle error responses correctly in your integration.