​
Create a EUR Payout Example

The Payout API allows users to process payouts in Euros (EUR) to recipients via Bank Transfer.

​
Endpoint

Post: {{baseURL}}/v1/payout

​
Request Details

​
Headers

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

​
Sample cURL Request


curl --location --request POST '{{baseURL}}/v1/payout' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--form '{
   "recipient":{
      "name": "Busola Obasanjo",
      "account":{
         "name":"Busola",
         "bankName":"Bank Name",
         "sortCode":"11111",
         "accountNumber":"222222222"
      },
      "paymentChannel":"BANK_TRANSFER",
      "currency":"EUR",
      "country":"DK"
   },
   "quoteId":"2000e048-57a7-4c62-xxxxxxxxxxxxx",
   "reason":"Gift"
}

​
Request Body Breakdown

FieldTypeDescriptionRequired
recipientObjectDetails of the payout recipientYes
recipient.nameStringFull name of the recipientYes
recipient.bankNameObjectRecipient’s bank nameYes
account.accountNumberStringBank account number of the recipientYes
account.sortCodeStringSort code of the recipient’s bankYes
recipient.paymentChannelStringPayment method (BANK_TRANSFER)Yes
recipient.currencyStringCurrency code (e.g., USD)Yes
recipient.countryStringCountry code (e.g., US)Yes
quoteIdStringUnique Quote ID for the payoutYes
reasonStringReason for the payout (e.g., Gift, Invoice Payment)Yes

​
Success Response (200 OK)

If the payout is successfully created, the API returns the following response: 
{
  "message": "Transaction created successfully",
  "status": "success",
  "data": {
    "id": "a8b9c7d6-4e5f-1234-abcd-xxxxxxxxxxxxx",
    "reason": "Gift",
    "referenceNumber": "NGNEURXREF123",
    "type": "SEND",
    "state": "COMPLETED",
    "quote": {
      "id": "2000e048-57a7-4c62-bdc8-xxxxxxxxxxxxx",
      "source": {
        "currency": "NGN",
        "country": "NG",
        "amount": 150000
      },
      "target": {
        "currency": "EUR",
        "country": "DE",
        "amount": 200
      },
      "rate": 750,
      "fee": {
        "amount": 1000
      }
    },
    "recipient": {
      "name": "Busola Obasanjo",
      "type": "BANK",
      "account": {
        "accountNumber": "222222222",
        "sortCode": "11111",
        "bankName": "Bank Name"
      },
      "paymentChannel": "BANK_TRANSFER",
      "currency": "EUR",
      "country": "DK"
    },
    "created": "2025-06-11T10:45:00.000000",
    "processed": null
  }
}

​
Response Breakdown

FieldTypeDescriptionExample
messageStringStatus message of the payout creation"Transaction created successfully"
statusStringStatus of the payout"success"
dataObjectDetails of the payout transaction
data.idStringUnique ID of the transaction"a8b9c7d6-4e5f-1234-abcd-xxxxxxxxxxxxx"
data.remarkStringRemark or note for the payout"Gift"
data.reasonStringReason for the payout"Gift"
data.referenceNumberStringUnique reference number for the payout"NGNEURXREF123"
data.typeStringType of transaction"SEND"
data.stateStringState of the payout (PENDING, COMPLETED, etc.)"PENDING"
data.quoteObjectDetails of the quote
data.quote.idStringQuote ID"2000e048-57a7-4c62-bdc8-xxxxxxxxxxxxx"
data.quote.sourceObjectSource currency details
data.quote.source.currencyStringSource currency code"NGN"
data.quote.source.countryStringSource country code"NG"
data.quote.source.amountNumberAmount sent in source currency150000
data.quote.targetObjectTarget currency details
data.quote.target.currencyStringTarget currency code"EUR"
data.quote.target.countryStringTarget country code"DE"
data.quote.target.amountNumberAmount received in target currency200
data.quote.rateNumberExchange rate used750
data.quote.feeObjectFee details
data.quote.fee.amountNumberFee amount in source currency1000
data.recipientObjectRecipient details
data.recipient.nameStringRecipient’s full name"Busola Obasanjo"
data.recipient.typeStringRecipient type (BANK)"BANK"
data.recipient.accountObjectBank account details
data.recipient.account.accountNumberStringBank account number"222222222"
data.recipient.account.sortCodeStringSort code of the recipient’s bank"11111"
data.recipient.account.bankNameStringBank name of the recipient"Bank Name"
data.recipient.paymentChannelStringPayment method (BANK_TRANSFER)"BANK_TRANSFER"
data.recipient.currencyStringCurrency code of payout"EUR"
data.recipient.countryStringCountry code of the recipient"DE"
data.createdStringTimestamp when the transaction was created"2025-06-11T10:45:00.000000"
data.processedString | nullTimestamp when the payout was processed or nullnull

​
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
400Bad RequestInvalid parameters
401UnauthorizedInvalid API key
422Unprocessable EntityInvalid quote ID
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.