WebhookNotification

subscriptionIdstringrequired

The id of the subscription

Example: fa664a60-e4f6-4aa2-8ffc-55fb229110ba

eventTypeWebhookEventTypesrequired

type of the subscription

Possible values: [DEPOSIT, PAYMENT, CLIENT]

Example: PAYMENT

eventStatusWebhookEventStatusrequired

status of the payment or deposit

Possible values: [[object Object], [object Object], [object Object]]

Example: PAYMENT

timestampstring<date-time>required

The publish time of the event

Example: 2024-10-22T03:58:13.000Z

messageIdstringrequired

The unique message ID for webhook events

Possible values: <= 100 characters

Example: 123e4567-e89b-12d3-a456-426614174000

eventObject objectrequired

The data of event object

oneOf

DepositDto
PaymentDto
WebhookClientDto

idstringrequired

id of the deposit

Example: fa664a60-e4f6-4aa2-8ffc-55fb229110ba

clientIdstringrequired

id of the client

Example: fa664a60-e4f6-4aa2-8ffc-55fb229110ba

accountIdstringrequired

id of the virtual account

Example: 65091ba9-649a-4625-8348-939334e7eca7

currencyCodestringrequired

Three letters deposit currency code

Example: AUD

amountnumberrequired

The amount of the deposit

Example: 1055.99

typeDepositSettlementTypesrequired

The type of the deposit

Possible values: [WIRE TRANSFER, PAYID]

Example: WIRE TRANSFER

referenceNostringrequired

Human readable deposit reference No

Example: 20240726-FA8JZ4

depositDatestringrequired

Deposit date (in formart YYYY-MM-DD)

Example: 2024-07-26

notestring

Deposit Reference

Example: Invoice-123

payer object

The payer info of the deposit

namestring

payer name, it may be different from the account name

Example: Abc

amountnumber

for non local payment, the origin payment amount may be differ from the received amount

Example: 1055.99

currencyCodestringrequired

Three letters deposit currency code

Example: AUD

accountNamestring

Bank account name

Example: ABC

accountNumberstring

Bank account number

Example: 123456

routingNumberstring

Bank account routing number

Example: 123456

valueDatestring

The value date of the deposit

Example: 2024-07-26T04:00:44.000Z

createDatestring

The create date of the deposit

Example: 2024-07-26T04:00:44.000Z

paymentReferencestring

Payment reference

Example: 512312

additionalInfostring

Payment description

Example: 512312

createdTimestringrequired

Deposit creation time

Example: 2024-07-26T03:58:13.000Z

clientNamestring

The name of client

Example: abc

statusDepositStatusesrequired

The status of the deposit

Possible values: [SCHEDULED, PENDING DIRECT DEBIT, DIRECT DEBIT PROCESSING, COMPLETED, CANCELLED, REJECTED, PENDING REFUND, REFUNDING, REFUNDED, REFUND REJECTED, REFUND CANCELLED]

Example: COMPLETED

updatedTimestringrequired

Deposit last updated time

Example: 2024-07-26T03:58:13.000Z

WebhookNotification
{
  "subscriptionId": "fa664a60-e4f6-4aa2-8ffc-55fb229110ba",
  "eventType": "PAYMENT",
  "eventStatus": "PAYMENT",
  "timestamp": "2024-10-22T03:58:13.000Z",
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "eventObject": {
    "id": "fa664a60-e4f6-4aa2-8ffc-55fb229110ba",
    "clientId": "fa664a60-e4f6-4aa2-8ffc-55fb229110ba",
    "currencyCode": "AUD",
    "amount": 1055.99,
    "type": "WIRE TRANSFER",
    "referenceNo": "20241016-CZR6AY",
    "depositDate": "2024-10-16",
    "createdTime": "2024-10-16T02:46:37.000Z",
    "clientName": "abc",
    "payer": null,
    "status": "COMPLETED"
  }
}