Payment: Get Details by ID
Related API Reference
API Reference: Get Payments by ID
Overview
- The Retrieve Payment Details function allows you to access all information related to a specific payment transaction by its ID.
- This includes the payment'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
Payment Status Model
The following table summarizes the statuses a payment may go through:
| Status | Description |
|---|---|
| ACCEPTED | You submitted a payment request. We verified and accept it, and it has been queued for sending for authorization or capturing (depending on your settings) on our side. |
| AUTHORIZATION_REQUESTED | We forwarded your authorisation request to the designated payment method (e.g. bank or wallet). It is now being processed externally; final status pending. |
| AUTHORIZED | The payment method has authorised the requested amount on the payer’s account. Following authorisation, the funds may either be captured through a capture request or released via a cancellation request. |
| CAPTURE_
REQUEST_ACCEPTED | After successful authorization, you submitted a capture request. We verified and accept it, and it has been queued for processing. |
| CAPTURE_
REQUESTED | We forwarded your capturing request to the designated payment method (e.g. bank or wallet). It is now being processed externally; final status pending. |
| CAPTURED | The payment method has captured the authorized amount on the payer’s account. |
| DECLINED | The payment may be declined during authorisation (e.g. insufficient funds or account issues) or during capture (e.g. expired authorisation or policy violations). |
| EXPIRED | The authorisation period has expired — the time window between authorisation and capture or cancellation elapsed without action. |
| CANCELLATION_
REQUEST_ACEPTED | After successful authorization, you submitted a cancellation request. We verified and accept it, and it has been queued for processing |
| CANCELLATION_
REQUESTED | We forwarded your cancellation request to the designated payment method (e.g. bank or wallet). It is now being processed externally; final status pending. |
| CANCELLED | The payment method has released the authorized amount on the payer’s account and cancelled the payment. |
| ERROR | The payment failed due to a technical issue; a retry may be required. |
When to Use
- Get details of the payment transaction
- Check the status of a payment operation.
- Audit and reconcile transactions for your records.
- Support customer queries about a specific payment process.
Payment Structure
The table below describes the general information a payment can contain. These top-level fields provide overall context of a payment transaction.
| Name | Description |
|---|---|
| id | Unique identifier for the payment transaction |
| status | Current status of the payment transaction |
| partnerReferencePaymentId | Reference ID provided by the partner system for the payment |
| submittedAmount | Amount requested for payment, including value and currency |
| authAmount | Amount authorised by the payment method, including value and currency |
| exchangeRate | Exchange rate applied if currency conversion is involved |
| exchangeSource | Name of the source of the exchange rate |
| paymentMethodInstanceId | Identifier of the specific payment method instance used |
| partnerId | Unique identifier of the partner participating in the transaction processing |
| adminAccountId | Identifier of the administrative account associated with the payment |
| settlementAccountId | Identifier of the settlement account where funds will be credited or debited |
| payer | Object containing personal or business details of the payer |
| billingAddress | Billing address of the payer |
| errorCode | Code representing the error if the transaction fails |
| createdAt | Timestamp indicating when the disbursement was created |
| updatedAt | Timestamp indicating the last update to the transaction |
Full list of attributes is available in API Reference Section
Updated 4 months ago
