Disbursement: Get Details
This page explains how to monitor a disbursement’s progress using its ID with the API, covering statuses, usage scenarios, and best practices, with a link to the API Reference for details.
Related API Reference
API Reference: Get Disbursement by id
Overview
- The Retrieve Disbursement Details function allows you to access all information related to a specific disbursement transaction.
- This includes the disbursement's current status, the details, and any relevant reference data.
- Use this feature to monitor progress, perform reconciliations, or provide customer support
How It Works
Disbursement Status Model
The following table summarizes the statuses a disbursement may go through:
| Status | Description |
|---|---|
| ACCEPTED | You submitted a disbursement request. We verified and accepted it, and it has been queued for processing on our side. |
| DISBURSEMENT_REQUESTED | We forwarded your disbursement request to the designated payment method (e.g. bank or wallet). It is now being processed externally; final status pending. |
| PAID_OUT | Funds have been successfully transferred to the recipient’s account. |
| DECLINED | The payout was rejected due to invalid details or restrictions. |
| ERROR | The payout failed due to a technical issue; a retry may be required. |
When to Use
- Get details of the disbursement transaction
- Check the status of a disbursement operation.
- Audit and reconcile transactions for your records.
- Support customer queries about a specific disbursement process.
Disbursement Structure
The table below describes the general information a disbursement can contain. These top-level fields provide overall context of a disbursement transaction.
| Name | Description |
|---|---|
| id | Unique identifier for the disbursement transaction |
| paymentMethodId | Identifier of the payment method used for the disbursement |
| paymentMethodName | Human-readable name of the payment method |
| submittedAmount | Amount requested for disbursement, including value and currency |
| authAmount | Amount authorised by the payment method, including value and currency |
| payer | Object containing personal or business details of the sender |
| payee | Object containing personal or business details of the recipient |
| payerPaymentInstrument | Details of the payment instrument used by the payer |
| payeePaymentInstrument | Details of the payment instrument receiving the funds |
| disbursementLink | Optional reference or URL linking to additional disbursement info |
| createdAt | Timestamp indicating when the disbursement was created |
| processingStatusCode | Internal code indicating processing status or outcome |
| statusMessage | Human-readable explanation of the current status |
| status | Current status of the disbursement |
Full list of attributes is available in API Reference Section
Updated 2 months ago