external_payment.created

webhook

external_payment.created

Occurs when an external payment is created.

Payload

Base class for transaction types in the ledger service that use the shared ledger status vocabulary. Families with their own status enum reference base_transaction_fields.yaml directly

event_type

const

enum

required

The type of event that occurred.

Allowed:

token

uuid

required

Unique identifier for the transaction

created

date-time

required

ISO 8601 timestamp of when the transaction was created

updated

date-time

required

ISO 8601 timestamp of when the transaction was last updated

status

string

enum

required

The status of the transaction

Allowed:

family

const

enum

required

EXTERNAL_PAYMENT - External Payment Response

Allowed:

result

string

enum

required

Allowed:

category

string

enum

required

Allowed:

settled_amount

integer

required

pending_amount

integer

required

currency

string

required

events

array of objects

required

events*

user_defined_id

string | null

financial_account_token

uuid

required

payment_type

string

enum

required

Allowed:

Response

200

Return a 200 status to indicate that the data was received successfully

Loading…