Intent: Get Details
Related API Reference
API Reference: Get an Intent by Id
Overview
- The Retrieve Intent Details function allows you to access all information related to a specific Intent.
- This includes the Intent’s current status, the details of all associated payment and disbursement transactions, and any relevant reference data.
- Use this feature to monitor progress, perform reconciliations, or provide customer support
How It Works
Intent Lifecycle & Statuses
The Intent object manages the full journey of a payment/disbursement, from initial creation through completion, including any associated updates or reversals. An Intent can have the following statuses:
| Status | Description |
|---|---|
| CREATED | The Intent has been created but no transactions have started processing |
| IN_PROGRESS | At least one linked transaction is in progress |
| FINALIZED | All linked transactions have reached their final statuses |
Note: If a new transaction is added to an Intent after it has been finalised, the Intent status will return to IN_PROGRESS and will be finalised again when all transactions are completed.
When to Use
- Check the status of a payment or disbursement operation.
- View all transactions linked to a particular Intent.
- Audit and reconcile transactions for your records.
- Support customer queries about a specific payment process.
Intent Structure
The table below describes the general information an Intent can contain. These top-level fields provide overall context and grouping for all transactions (such as payments and disbursements) associated with the Intent.
| Name | Description |
|---|---|
| Intent ID | The unique identifier assigned to your Intent. |
| Payments | Details of all payments that were successfully created under this Intent. |
| Disbursements | Details of all disbursements that were successfully created under this Intent. |
| Client Reference | The reference you provided for this Intent, useful for your own tracking or reconciliation. |
| Payment Creation Errors | Any payments that could not be created, along with error details. |
| Disbursement Creation Errors | Any disbursements that could not be created, along with error details. |
| Description | An optional text description of your Intent, as submitted in the request. |
| Intent Status | The current status of your Intent (for example: Created, In Progress, Finalized). |
Updated about 23 hours ago
Useful links