Payment Status Updated Event | Redpin

Sent when the status of a payment changes at various stages of the payment journey.

Once you have subscribed to the “PAYMENT STATUS” event type, Redpin will call your designated API endpoint with the payload described below when there is an update to one of your payment’s statuses.

Payment Status Flows:

Payment status updates follow different flows depending on whether currency conversion (FX) is required:

Flow 1: Payments with FX Conversion (Different Currencies)

Flow 2: Same Currency Payments (No FX Conversion)

Status to Schema Mapping:

Status	Description	Applies To
PROCESSING	Payment is being processed. Immediately after the response from Payment v3 call for same-currency payments	Same currency payments only
AWAITING_FUNDS	Payment created, waiting for funds to be received	FX conversion payments
RECEIVED_FUNDS	Funds have been received and credited to customer’s Redpin wallet	FX conversion payments
FX_COMPLETED	Foreign exchange conversion completed successfully	FX conversion payments only
PAYOUT_INITIATED	Payment transfer to recipient has been initiated	All payments
PAYOUT_CREDITED	Payment has been successfully credited to recipient’s account	All payments
CANCELLED	Customer has cancelled the payment (with reason)	All payments
BOUNCED_BACK	Payment has been returned by the recipient bank. Payment transfer failed and bounced back	All payments
REFUNDED	Customer has been refunded for a bounced back payment. Payment has been refunded to the customer	All payments
PAYMENT_COMPLETED	All recipients have been paid and payment is fully completed	All payments

Note: If you receive a status not listed here, log the event and contact support. Your integration should be resilient to new statuses.

Note: All top-level fields (event_id, payment_id, status, customer_id, event_timestamp, data) are always present in every event.

Difference between PAYOUT_CREDITED and PAYMENT_COMPLETED:

If a payment has only one recipient, then PAYOUT_CREDITED is functionally equivalent to PAYMENT_COMPLETED, and both events will be delivered.

If a payment has multiple recipients, PAYOUT_CREDITED will be delivered each time the amount for a recipient is credited to their account. PAYMENT_COMPLETED will be delivered only when all recipients have been credited with their expected amounts.

Example Payloads:

AWAITING_FUNDS

1 {
2   "event_id": "1",
3   "payment_id": "123456",
4   "status": "AWAITING_FUNDS",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {}
9 }

RECEIVED_FUNDS

1 {
2   "event_id": "2",
3   "payment_id": "123456",
4   "status": "RECEIVED_FUNDS",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "amount": {
10       "currency": "GBP",
11       "value": 1000
12     }
13   }
14 }

FX_COMPLETED

1 {
2   "event_id": "3",
3   "payment_id": "123456",
4   "status": "FX_COMPLETED",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "sell_amount": {
10       "currency": "GBP",
11       "value": 1000
12     },
13     "buy_amount": {
14       "currency": "AED",
15       "value": 4982.70
16     },
17     "quote_rate": 4.9827
18   }
19 }

PAYOUT_INITIATED

1 {
2   "event_id": "4",
3   "payment_id": "123456",
4   "status": "PAYOUT_INITIATED",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "amount": {
10       "currency": "AED",
11       "value": 4982.70
12     },
13     "recipient_id": "162345"
14   }
15 }

PAYOUT_CREDITED

1 {
2   "event_id": "5",
3   "payment_id": "123456",
4   "status": "PAYOUT_CREDITED",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "amount": {
10       "currency": "AED",
11       "value": 4982.70
12     },
13     "recipient_id": "162345"
14   }
15 }

CANCELLED

1 {
2   "event_id": "6",
3   "payment_id": "123456",
4   "status": "CANCELLED",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "reason_description": "Customer cancelled the payment"
10   }
11 }

PROCESSING

Note: This status is used for same-currency payments (no FX conversion required). It is sent immediately after the response from Payment v3 call.

1 {
2   "event_id": "7",
3   "payment_id": "123456",
4   "status": "PROCESSING",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "additional_info": "Payment processing initiated"
10   }
11 }

REFUNDED

1 {
2   "event_id": "8",
3   "payment_id": "123456",
4   "status": "REFUNDED",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "refund_amount": {
10       "currency": "GBP",
11       "value": 1000
12     },
13     "refund_reason": "Customer overpaid"
14   }
15 }

PAYMENT_COMPLETED

Note: This status indicates that all payouts in a transaction are in PAYOUT_CREDITED state. This is the final status for all payments (both FX conversion and same-currency payments).

1 {
2   "event_id": "9",
3   "payment_id": "123456",
4   "status": "PAYMENT_COMPLETED",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "recipient_details": [
10       { 
11         "amount": {
12           "currency": "AED",
13           "value": 4982.70
14         }, 
15         "recipient_id": "162345" 
16       },
17       { 
18         "amount": {
19           "currency": "AED",
20           "value": 400.00
21         }, 
22         "recipient_id": "162346" 
23       }
24     ]
25   }
26 }

BOUNCED_BACK

1 {
2   "event_id": "10",
3   "payment_id": "123456",
4   "status": "BOUNCED_BACK",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "amount": {
10       "currency": "AED",
11       "value": 4982.70
12     },
13     "recipient_id": "162345",
14     "bounce_reason": "Invalid account number"
15   }
16 }

Sent when the status of a payment changes at various stages of the payment journey. Once you have subscribed to the "PAYMENT STATUS" event type, Redpin will call your designated API endpoint with the payload described below when there is an update to one of your payment's statuses. **Payment Status Flows:** Payment status updates follow different flows depending on whether currency conversion (FX) is required: **Flow 1: Payments with FX Conversion (Different Currencies)** ```mermaid graph TD; AWAITING_FUNDS --> RECEIVED_FUNDS --> FX_COMPLETED --> PAYOUT_INITIATED --> PAYOUT_CREDITED --> PAYMENT_COMPLETED AWAITING_FUNDS --> CANCELLED RECEIVED_FUNDS --> REFUNDED PAYOUT_INITIATED --> BOUNCED_BACK BOUNCED_BACK --> REFUNDED PAYOUT_INITIATED --> CANCELLED ``` **Flow 2: Same Currency Payments (No FX Conversion)** ```mermaid graph TD; PROCESSING --> PAYOUT_INITIATED --> PAYOUT_CREDITED --> PAYMENT_COMPLETED PROCESSING --> CANCELLED PAYOUT_INITIATED --> BOUNCED_BACK BOUNCED_BACK --> REFUNDED ``` **Status to Schema Mapping:** | Status | Description | Applies To | |--------------------|------------------------------------|------------| | PROCESSING | Payment is being processed. Immediately after the response from Payment v3 call for same-currency payments | Same currency payments only | | AWAITING_FUNDS | Payment created, waiting for funds to be received | FX conversion payments | | RECEIVED_FUNDS | Funds have been received and credited to customer's Redpin wallet | FX conversion payments | | FX_COMPLETED | Foreign exchange conversion completed successfully | FX conversion payments only | | PAYOUT_INITIATED | Payment transfer to recipient has been initiated | All payments | | PAYOUT_CREDITED | Payment has been successfully credited to recipient's account | All payments | | CANCELLED | Customer has cancelled the payment (with reason) | All payments | | BOUNCED_BACK | Payment has been returned by the recipient bank. Payment transfer failed and bounced back | All payments | | REFUNDED | Customer has been refunded for a bounced back payment. Payment has been refunded to the customer | All payments | | PAYMENT_COMPLETED | All recipients have been paid and payment is fully completed | All payments | > **Note:** If you receive a status not listed here, log the event and contact support. Your integration should be resilient to new statuses. > **Note:** All top-level fields (`event_id`, `payment_id`, `status`, `customer_id`, `event_timestamp`, `data`) are always present in every event. **Difference between PAYOUT_CREDITED and PAYMENT_COMPLETED:** >If a payment has only one recipient, then PAYOUT_CREDITED is functionally equivalent to PAYMENT_COMPLETED, and both events will be delivered. > If a payment has multiple recipients, PAYOUT_CREDITED will be delivered each time the amount for a recipient is credited to their account. PAYMENT_COMPLETED will be delivered only when all recipients have been credited with their expected amounts. **Example Payloads:** **AWAITING_FUNDS** ```json { "event_id": "1", "payment_id": "123456", "status": "AWAITING_FUNDS", "customer_id": "0201001008132685", "client_customer_ref": "CUST_001", "event_timestamp": "2025-01-01T00:00:00Z", "data": {} } ``` **RECEIVED_FUNDS** ```json { "event_id": "2", "payment_id": "123456", "status": "RECEIVED_FUNDS", "customer_id": "0201001008132685", "client_customer_ref": "CUST_001", "event_timestamp": "2025-01-01T00:00:00Z", "data": { "amount": { "currency": "GBP", "value": 1000 } } } ``` **FX_COMPLETED** ```json { "event_id": "3", "payment_id": "123456", "status": "FX_COMPLETED", "customer_id": "0201001008132685", "client_customer_ref": "CUST_001", "event_timestamp": "2025-01-01T00:00:00Z", "data": { "sell_amount": { "currency": "GBP", "value": 1000 }, "buy_amount": { "currency": "AED", "value": 4982.70 }, "quote_rate": 4.9827 } } ``` **PAYOUT_INITIATED** ```json { "event_id": "4", "payment_id": "123456", "status": "PAYOUT_INITIATED", "customer_id": "0201001008132685", "client_customer_ref": "CUST_001", "event_timestamp": "2025-01-01T00:00:00Z", "data": { "amount": { "currency": "AED", "value": 4982.70 }, "recipient_id": "162345" } } ``` **PAYOUT_CREDITED** ```json { "event_id": "5", "payment_id": "123456", "status": "PAYOUT_CREDITED", "customer_id": "0201001008132685", "client_customer_ref": "CUST_001", "event_timestamp": "2025-01-01T00:00:00Z", "data": { "amount": { "currency": "AED", "value": 4982.70 }, "recipient_id": "162345" } } ``` **CANCELLED** ```json { "event_id": "6", "payment_id": "123456", "status": "CANCELLED", "customer_id": "0201001008132685", "client_customer_ref": "CUST_001", "event_timestamp": "2025-01-01T00:00:00Z", "data": { "reason_description": "Customer cancelled the payment" } } ``` **PROCESSING** > **Note:** This status is used for same-currency payments (no FX conversion required). It is sent immediately after the response from Payment v3 call. ```json { "event_id": "7", "payment_id": "123456", "status": "PROCESSING", "customer_id": "0201001008132685", "client_customer_ref": "CUST_001", "event_timestamp": "2025-01-01T00:00:00Z", "data": { "additional_info": "Payment processing initiated" } } ``` **REFUNDED** ```json { "event_id": "8", "payment_id": "123456", "status": "REFUNDED", "customer_id": "0201001008132685", "client_customer_ref": "CUST_001", "event_timestamp": "2025-01-01T00:00:00Z", "data": { "refund_amount": { "currency": "GBP", "value": 1000 }, "refund_reason": "Customer overpaid" } } ``` **PAYMENT_COMPLETED** > **Note:** This status indicates that all payouts in a transaction are in PAYOUT_CREDITED state. This is the final status for all payments (both FX conversion and same-currency payments). ```json { "event_id": "9", "payment_id": "123456", "status": "PAYMENT_COMPLETED", "customer_id": "0201001008132685", "client_customer_ref": "CUST_001", "event_timestamp": "2025-01-01T00:00:00Z", "data": { "recipient_details": [ { "amount": { "currency": "AED", "value": 4982.70 }, "recipient_id": "162345" }, { "amount": { "currency": "AED", "value": 400.00 }, "recipient_id": "162346" } ] } } ``` **BOUNCED_BACK** ```json { "event_id": "10", "payment_id": "123456", "status": "BOUNCED_BACK", "customer_id": "0201001008132685", "client_customer_ref": "CUST_001", "event_timestamp": "2025-01-01T00:00:00Z", "data": { "amount": { "currency": "AED", "value": 4982.70 }, "recipient_id": "162345", "bounce_reason": "Invalid account number" } } ```

Payload

The payload of this webhook request is an object.

event_idstringRequired

Unique identifier for the event.

payment_idstringRequired

Unique identifier for the payment. This is the same as the payment_id in the Create a Payment operation.

statusenumRequired

Status of the payment.

customer_idstringRequired

Unique identifier for the customer associated with the payment.

dataobjectRequired

The structure of the data object varies depending on the payment status. See the documentation below for the specific data object schema associated with each status value.

data for AWAITING_FUNDS

(empty object)

data for RECEIVED_FUNDS

amount (object, required):
- currency (string, required): Currency code (ISO 4217).
- value (number, required): Amount credited to the customer’s Redpin wallet.

data for FX_COMPLETED

sell_amount (object, required):
- currency (string, required): Currency code (ISO 4217) of the currency being sold.
- value (number, required): Amount of currency being sold as part of the FX transaction.
buy_amount (object, required):
- currency (string, required): Currency code (ISO 4217) of the currency being bought.
- value (number, required): Amount of currency being bought as part of the FX transaction.
quote_rate (number, required): Exchange rate used for the FX transaction.

data for PAYOUT_INITIATED

Clarification: This status means the payment transfer to the recipient has been initiated by Redpin, but the funds may not yet have reached the recipient’s account.

amount (object, required):
- currency (string, required): Currency code (ISO 4217) of the currency being paid out.
- value (number, required): Amount of currency being paid out to the recipient.
recipient_id (string, required): Unique identifier for the recipient to whom the payout is being made.

data for PAYOUT_CREDITED

Clarification: This status means the payment has been successfully credited to the recipient’s account. This is a confirmation that the funds have reached the recipient.

amount (object, required):
- currency (string, required): Currency code (ISO 4217) of the currency being paid out.
- value (number, required): Amount of currency credited to the recipient.
recipient_id (string, required): Unique identifier for the recipient to whom the payout is being made.

data for CANCELLED

reason_description (string, required): Reason for the cancellation.

data for PROCESSING

Note: This status is used for same-currency payments (no FX conversion required). It is sent immediately after the response from Payment v3 call.

additional_info (string, required): Additional information about the processing status.

data for REFUNDED

refund_amount (object, required):
- currency (string, required): Currency code (ISO 4217) of the currency being refunded.
- value (number, required): Amount of currency being refunded.
refund_reason (string, required): Reason for the refund.

data for PAYMENT_COMPLETED

Clarification: This status indicates that all payouts in a transaction have reached PAYOUT_CREDITED state. This is the final status for all payments (both FX conversion and same-currency payments).

recipient_details (array, required): Details of the recipients of the payment.
- Each item (object, required):
  - amount (object, required):
    - currency (string, required): Currency code (ISO 4217) of the currency credited to the recipient.
    - value (number, required): Amount of currency credited to the recipient.
  - recipient_id (string, required): Unique identifier for the recipient to whom the payment is being made.

data for BOUNCED_BACK

amount (object, required):
- currency (string, required): Currency code (ISO 4217) of the currency that bounced back.
- value (number, required): Amount of currency that bounced back from the recipient.
recipient_id (string, required): Unique identifier for the recipient from whom the payment bounced back.
bounce_reason (string, required): Reason why the payment transfer failed and bounced back.

The structure of the `data` object varies depending on the payment status. See the documentation below for the specific data object schema associated with each status value. <AccordionGroup> <Accordion title='data for AWAITING_FUNDS'> - (empty object) </Accordion> <Accordion title='data for RECEIVED_FUNDS'> - **amount** (object, required): - **currency** (string, required): Currency code (ISO 4217). - **value** (number, required): Amount credited to the customer's Redpin wallet. </Accordion> <Accordion title='data for FX_COMPLETED'> - **sell_amount** (object, required): - **currency** (string, required): Currency code (ISO 4217) of the currency being sold. - **value** (number, required): Amount of currency being sold as part of the FX transaction. - **buy_amount** (object, required): - **currency** (string, required): Currency code (ISO 4217) of the currency being bought. - **value** (number, required): Amount of currency being bought as part of the FX transaction. - **quote_rate** (number, required): Exchange rate used for the FX transaction. </Accordion> <Accordion title='data for PAYOUT_INITIATED'> > **Clarification:** This status means the payment transfer to the recipient has been initiated by Redpin, but the funds may not yet have reached the recipient's account. - **amount** (object, required): - **currency** (string, required): Currency code (ISO 4217) of the currency being paid out. - **value** (number, required): Amount of currency being paid out to the recipient. - **recipient_id** (string, required): Unique identifier for the recipient to whom the payout is being made. </Accordion> <Accordion title='data for PAYOUT_CREDITED'> > **Clarification:** This status means the payment has been successfully credited to the recipient's account. This is a confirmation that the funds have reached the recipient. - **amount** (object, required): - **currency** (string, required): Currency code (ISO 4217) of the currency being paid out. - **value** (number, required): Amount of currency credited to the recipient. - **recipient_id** (string, required): Unique identifier for the recipient to whom the payout is being made. </Accordion> <Accordion title='data for CANCELLED'> - **reason_description** (string, required): Reason for the cancellation. </Accordion> <Accordion title='data for PROCESSING'> > **Note:** This status is used for same-currency payments (no FX conversion required). It is sent immediately after the response from Payment v3 call. - **additional_info** (string, required): Additional information about the processing status. </Accordion> <Accordion title='data for REFUNDED'> - **refund_amount** (object, required): - **currency** (string, required): Currency code (ISO 4217) of the currency being refunded. - **value** (number, required): Amount of currency being refunded. - **refund_reason** (string, required): Reason for the refund. </Accordion> <Accordion title='data for PAYMENT_COMPLETED'> > **Clarification:** This status indicates that all payouts in a transaction have reached PAYOUT_CREDITED state. This is the final status for all payments (both FX conversion and same-currency payments). - **recipient_details** (array, required): Details of the recipients of the payment. - Each item (object, required): - **amount** (object, required): - **currency** (string, required): Currency code (ISO 4217) of the currency credited to the recipient. - **value** (number, required): Amount of currency credited to the recipient. - **recipient_id** (string, required): Unique identifier for the recipient to whom the payment is being made. </Accordion> <Accordion title='data for BOUNCED_BACK'> - **amount** (object, required): - **currency** (string, required): Currency code (ISO 4217) of the currency that bounced back. - **value** (number, required): Amount of currency that bounced back from the recipient. - **recipient_id** (string, required): Unique identifier for the recipient from whom the payment bounced back. - **bounce_reason** (string, required): Reason why the payment transfer failed and bounced back. </Accordion> </AccordionGroup>

event_timestampstringRequired

Timestamp of the event in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

client_customer_refstringOptional

The unique reference identifier of the third party client for whom the third party payment was made.

Response

200

Webhook received successfully

400

Invalid payload

Sent when the status of a payment changes at various stages of the payment journey.

Payment Status Flows:

Payment status updates follow different flows depending on whether currency conversion (FX) is required:

Flow 1: Payments with FX Conversion (Different Currencies)

Flow 2: Same Currency Payments (No FX Conversion)

Status to Schema Mapping:

Status	Description	Applies To
PROCESSING	Payment is being processed. Immediately after the response from Payment v3 call for same-currency payments	Same currency payments only
AWAITING_FUNDS	Payment created, waiting for funds to be received	FX conversion payments
RECEIVED_FUNDS	Funds have been received and credited to customer’s Redpin wallet	FX conversion payments
FX_COMPLETED	Foreign exchange conversion completed successfully	FX conversion payments only
PAYOUT_INITIATED	Payment transfer to recipient has been initiated	All payments
PAYOUT_CREDITED	Payment has been successfully credited to recipient’s account	All payments
CANCELLED	Customer has cancelled the payment (with reason)	All payments
BOUNCED_BACK	Payment has been returned by the recipient bank. Payment transfer failed and bounced back	All payments
REFUNDED	Customer has been refunded for a bounced back payment. Payment has been refunded to the customer	All payments
PAYMENT_COMPLETED	All recipients have been paid and payment is fully completed	All payments

Note: If you receive a status not listed here, log the event and contact support. Your integration should be resilient to new statuses.

Note: All top-level fields (event_id, payment_id, status, customer_id, event_timestamp, data) are always present in every event.

Difference between PAYOUT_CREDITED and PAYMENT_COMPLETED:

If a payment has only one recipient, then PAYOUT_CREDITED is functionally equivalent to PAYMENT_COMPLETED, and both events will be delivered.

If a payment has multiple recipients, PAYOUT_CREDITED will be delivered each time the amount for a recipient is credited to their account. PAYMENT_COMPLETED will be delivered only when all recipients have been credited with their expected amounts.

Example Payloads:

AWAITING_FUNDS

1 {
2   "event_id": "1",
3   "payment_id": "123456",
4   "status": "AWAITING_FUNDS",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {}
9 }

RECEIVED_FUNDS

1 {
2   "event_id": "2",
3   "payment_id": "123456",
4   "status": "RECEIVED_FUNDS",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "amount": {
10       "currency": "GBP",
11       "value": 1000
12     }
13   }
14 }

FX_COMPLETED

1 {
2   "event_id": "3",
3   "payment_id": "123456",
4   "status": "FX_COMPLETED",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "sell_amount": {
10       "currency": "GBP",
11       "value": 1000
12     },
13     "buy_amount": {
14       "currency": "AED",
15       "value": 4982.70
16     },
17     "quote_rate": 4.9827
18   }
19 }

PAYOUT_INITIATED

1 {
2   "event_id": "4",
3   "payment_id": "123456",
4   "status": "PAYOUT_INITIATED",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "amount": {
10       "currency": "AED",
11       "value": 4982.70
12     },
13     "recipient_id": "162345"
14   }
15 }

PAYOUT_CREDITED

1 {
2   "event_id": "5",
3   "payment_id": "123456",
4   "status": "PAYOUT_CREDITED",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "amount": {
10       "currency": "AED",
11       "value": 4982.70
12     },
13     "recipient_id": "162345"
14   }
15 }

CANCELLED

1 {
2   "event_id": "6",
3   "payment_id": "123456",
4   "status": "CANCELLED",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "reason_description": "Customer cancelled the payment"
10   }
11 }

PROCESSING

Note: This status is used for same-currency payments (no FX conversion required). It is sent immediately after the response from Payment v3 call.

1 {
2   "event_id": "7",
3   "payment_id": "123456",
4   "status": "PROCESSING",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "additional_info": "Payment processing initiated"
10   }
11 }

REFUNDED

1 {
2   "event_id": "8",
3   "payment_id": "123456",
4   "status": "REFUNDED",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "refund_amount": {
10       "currency": "GBP",
11       "value": 1000
12     },
13     "refund_reason": "Customer overpaid"
14   }
15 }

PAYMENT_COMPLETED

Note: This status indicates that all payouts in a transaction are in PAYOUT_CREDITED state. This is the final status for all payments (both FX conversion and same-currency payments).

1 {
2   "event_id": "9",
3   "payment_id": "123456",
4   "status": "PAYMENT_COMPLETED",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "recipient_details": [
10       { 
11         "amount": {
12           "currency": "AED",
13           "value": 4982.70
14         }, 
15         "recipient_id": "162345" 
16       },
17       { 
18         "amount": {
19           "currency": "AED",
20           "value": 400.00
21         }, 
22         "recipient_id": "162346" 
23       }
24     ]
25   }
26 }

BOUNCED_BACK

1 {
2   "event_id": "10",
3   "payment_id": "123456",
4   "status": "BOUNCED_BACK",
5   "customer_id": "0201001008132685",
6   "client_customer_ref": "CUST_001",
7   "event_timestamp": "2025-01-01T00:00:00Z",
8   "data": {
9     "amount": {
10       "currency": "AED",
11       "value": 4982.70
12     },
13     "recipient_id": "162345",
14     "bounce_reason": "Invalid account number"
15   }
16 }

1	{
2	"event_id": "string",
3	"payment_id": "string",
4	"status": "AWAITING_FUNDS",
5	"customer_id": "string",
6	"data": {},
7	"event_timestamp": "2025-01-01T00:00:00Z"
8	}

1	{
2	"event_id": "1",
3	"payment_id": "123456",
4	"status": "AWAITING_FUNDS",
5	"customer_id": "0201001008132685",
6	"client_customer_ref": "CUST_001",
7	"event_timestamp": "2025-01-01T00:00:00Z",
8	"data": {}
9	}

1	{
2	"event_id": "2",
3	"payment_id": "123456",
4	"status": "RECEIVED_FUNDS",
5	"customer_id": "0201001008132685",
6	"client_customer_ref": "CUST_001",
7	"event_timestamp": "2025-01-01T00:00:00Z",
8	"data": {
9	"amount": {
10	"currency": "GBP",
11	"value": 1000
12	}
13	}
14	}

1	{
2	"event_id": "3",
3	"payment_id": "123456",
4	"status": "FX_COMPLETED",
5	"customer_id": "0201001008132685",
6	"client_customer_ref": "CUST_001",
7	"event_timestamp": "2025-01-01T00:00:00Z",
8	"data": {
9	"sell_amount": {
10	"currency": "GBP",
11	"value": 1000
12	},
13	"buy_amount": {
14	"currency": "AED",
15	"value": 4982.70
16	},
17	"quote_rate": 4.9827
18	}
19	}

1	{
2	"event_id": "4",
3	"payment_id": "123456",
4	"status": "PAYOUT_INITIATED",
5	"customer_id": "0201001008132685",
6	"client_customer_ref": "CUST_001",
7	"event_timestamp": "2025-01-01T00:00:00Z",
8	"data": {
9	"amount": {
10	"currency": "AED",
11	"value": 4982.70
12	},
13	"recipient_id": "162345"
14	}
15	}

1	{
2	"event_id": "5",
3	"payment_id": "123456",
4	"status": "PAYOUT_CREDITED",
5	"customer_id": "0201001008132685",
6	"client_customer_ref": "CUST_001",
7	"event_timestamp": "2025-01-01T00:00:00Z",
8	"data": {
9	"amount": {
10	"currency": "AED",
11	"value": 4982.70
12	},
13	"recipient_id": "162345"
14	}
15	}

1	{
2	"event_id": "6",
3	"payment_id": "123456",
4	"status": "CANCELLED",
5	"customer_id": "0201001008132685",
6	"client_customer_ref": "CUST_001",
7	"event_timestamp": "2025-01-01T00:00:00Z",
8	"data": {
9	"reason_description": "Customer cancelled the payment"
10	}
11	}

1	{
2	"event_id": "7",
3	"payment_id": "123456",
4	"status": "PROCESSING",
5	"customer_id": "0201001008132685",
6	"client_customer_ref": "CUST_001",
7	"event_timestamp": "2025-01-01T00:00:00Z",
8	"data": {
9	"additional_info": "Payment processing initiated"
10	}
11	}

1	{
2	"event_id": "8",
3	"payment_id": "123456",
4	"status": "REFUNDED",
5	"customer_id": "0201001008132685",
6	"client_customer_ref": "CUST_001",
7	"event_timestamp": "2025-01-01T00:00:00Z",
8	"data": {
9	"refund_amount": {
10	"currency": "GBP",
11	"value": 1000
12	},
13	"refund_reason": "Customer overpaid"
14	}
15	}

1	{
2	"event_id": "9",
3	"payment_id": "123456",
4	"status": "PAYMENT_COMPLETED",
5	"customer_id": "0201001008132685",
6	"client_customer_ref": "CUST_001",
7	"event_timestamp": "2025-01-01T00:00:00Z",
8	"data": {
9	"recipient_details": [
10	{
11	"amount": {
12	"currency": "AED",
13	"value": 4982.70
14	},
15	"recipient_id": "162345"
16	},
17	{
18	"amount": {
19	"currency": "AED",
20	"value": 400.00
21	},
22	"recipient_id": "162346"
23	}
24	]
25	}
26	}

1	{
2	"event_id": "10",
3	"payment_id": "123456",
4	"status": "BOUNCED_BACK",
5	"customer_id": "0201001008132685",
6	"client_customer_ref": "CUST_001",
7	"event_timestamp": "2025-01-01T00:00:00Z",
8	"data": {
9	"amount": {
10	"currency": "AED",
11	"value": 4982.70
12	},
13	"recipient_id": "162345",
14	"bounce_reason": "Invalid account number"
15	}
16	}