Webhooks: Disbursements

Overview

  • Disbursement webhooks allow clients to receive real-time notifications about the status and progression of their disbursement transactions.
  • Once a disbursement intent is created, the platform will send webhook callbacks to the URLs provided by the client.

Note: We do not modify, transform, or alter in any way the webhook URLs received from clients. The exact URL provided in the intent creation request is the one used for all webhook callbacks.


Type "Disbursement status updates"

  • Sent when a payment status changes (e.g., ACCEPTED, DECLINED, ERROR). Not only terminal statuses, but all. Full status model is available on the link
  • Triggered By: Internal processing events after disbursement intent creation.
  • Client must provide URL in: disbursements[].webhookUrl inside the request: POST /processing/api/v1/intents

Example:

{  
  "transactionType": "DISBURSEMENT",
  "transactionId": "111122223333444455",
	"status": "ACCEPTED"
}
{
  "transactionType": "DISBURSEMENT",
  "transactionId": "111122223333444455",
  "status": "ERROR",
  "errorCode": "CODE_PT0000",
  "errorMessage": "string"
}

Fields Description

Field

Type

Description

transactionType

String

Identifies the transaction type.
Enum: PAYMENT, DISBURSEMENT, REFUND

transactionId

String

Our internal Transaction ID on the platform

status

String

The status of the transaction

errorCode

String

Client-defined error code if the transaction cannot be processed

errorMessage

String

Human-readable description of the error.