Skip to main content
When your GBP payouts are confirmed, details about the transaction are sent in a payload that provides essential information for record-keeping and reconciliation.

​
Parameter overview

ParameterDescription
messageIndicates the status of the transaction.
transaction_idA unique identifier for the transaction.
transaction_referenceA unique identifier for the transaction.
transaction_statusThe status of the transaction (e.g., SUCCESSFUL).
transaction_feeThe fee charged for the transaction.
transaction_amount_without_feeThe amount sent excluding fees.
transaction_amountThe total amount including fees.
transaction_currencyThe currency in which the transaction is conducted (GBP).
customer_idThe customer associated with the transaction
recipientDetails of the recipient, including:
recipient.account_numberThe recipient’s bank account number.
recipient.account_nameThe name associated with the recipient’s bank account.
recipient.bank_nameThe name of the bank holding the recipient’s account.
recipient.amountThe net amount that the recipient received.
recipient.sort_codeThe sort code of the recipient.
event_idA unique identifier for the event.
typeThe type of transaction (e.g., payout).

​
Example payload

{
  "message": "Transaction Completed",
  "transaction_id": "20580e50-1b32-40a6-aa46-ac8e795b3zas",
  "transaction_reference": "90980e50-0b83-40a6-aa46-ac8e795b1acd",
  "transaction_status": "SUCCESSFUL",
  "transaction_fee": 39.12,
  "transaction_amount_without_fee": 612.88,
  "transaction_amount": 652.0,
  "transaction_currency": "GBP",
  "customer_id": "9d4c4ec5-59ea-4130-bf8a-6a5edec401ee",
  "recipient": {
    "account_number": "FR7612345678901234567890123",
    "account_name": "Pierre Dubois",
    "bank_name": "Lloyds Bank",
    "sort_code": "12-34-56",
    "amount": 495.00
   },
  "event_id": "9d46b957-0cf5-4743-847a-254d92de6a85",
  "type": "payout"
}