Payment Settlement

This notification is triggered when a settlement batch has been processed. Settlements are executed in bulk based on the configured settlement cycle . Once settled, the funds are transferred to the designated Banking Account.

Event metadata

  • name: ACQUIRING
  • types:
    • acquiring.payment.settlement

Request body

FieldsData TypeDescription
event_idstringA unique ID for the event.
event_namestringEvent name.
event_typestringEvent type.
source_idstringSettlement batch id
versionstringAPI Version number.
dataobjectRelated business objects.

Notification example

{
    "version": "V1.6.0", 
    "event_name": "ACQUIRING", 
    "event_type": "acquiring.payment.settlement", 
    "event_id": "c26e83c3-8d3e-4886-94cf-db22472cad6f", 
    "source_id": "2024102509915950201", 
    "data": {
         "settlement_batch_id": "2024102509915950201",
         "account_id":"2024102509915950201",
         "account_name":"Account Name",
         "settlement_currency": "USD", 
         "fee_amount": 10.01, 
         "transaction_amount": 10.01, 
         "net_settlement_amount": 10.01,
         "settlement_status":"",
         "complete_time": "2024-03-01T00:00:00+08:00",
    }
}