Payment Returned

This webhook is sent when a payment has been returned.

Webhook Structure

string (UUID)

required

Unique identifier for this event

string (ISO 8601)

required

Timestamp of when the event occurred

string

required

The type of event. Value: payment.returned

object

required

The event data containing the details below

Data Fields

string (UUID)

required

Unique identifier of the returned payment

string

required

Payment scheme. Available values: SCT, SCT_INST, INTERNAL

string

required

Payment direction. Available values: INBOUND, OUTBOUND

string

ISO 20022 return reason code surfaced by the payment gateway (for example, AC04 for a closed account or AM05 for a duplicate payment). Optional — omitted when the gateway does not provide a reason.

{ "id": "f2a7b5c4-9d3e-4f8a-c2ba-5e7d1f4a3c6b", "time": "2025-01-15T10:30:00Z", "type": "payment.returned", "data": { "paymentId": "019cde3e-da40-7f7c-eb65-7b2c4d5f8a1e", "scheme": "SCT", "direction": "INBOUND", "reasonCode": "AC04" } }

Getting Started

Parties

Accounts

Account Statements

Payments

Transactions

Transaction Postings

Oversight

Webhooks

Webhook Structure

Data Fields

Request Example

​Webhook Structure

​Data Fields

​Request Example

Webhook Structure

Data Fields

Request Example