Remittance lifecycle
The diagram below outlines the entire journey of a Payout transaction, from its initiation to its completion. The Payout transaction is also commonly referred to as a remittance transaction. You can refer to the transaction status table for detailed descriptions of each status type within this lifecycle.
Remittance transaction statuses
Status | Description |
---|---|
APPROVED | The transaction is approved for Payout by the authorized personnel. |
AWAITING_FUNDS | The transaction is waiting for funding. |
CANCELLED | The transaction is cancelled by the customer. For a Payout transaction, typically, this can only be done on scheduled payouts that are not yet initiated. |
COMPLIANCE_COMPLETED | The transaction has cleared compliance review and is ready for further processing. |
COMPLIANCE_REJECTED | The transaction is rejected by compliance rules. |
DECLINED | The transaction is declined by the checker or due to monitoring rules. |
ERROR | An error occurred while processing the transaction. Depending on the type of error, the transaction can be retried by returning to the PG_PROCESSING status. |
EXPIRED | The transaction is expired due to insufficient funds or the expiration of the FX rate. |
IN_PROGRESS | The transaction is currently being processed. |
INITIATED | The transaction is initiated for processing. |
PAID | Money has been sent to the beneficiary bank from Nium's partner bank. |
PG_PROCESSING | The payout transaction is ready for processing, and we are finding the optimal route to process the payment using the Nium partner bank network. |
RFI_REQUESTED | The transaction has been flagged by compliance rules. Additional information has been requested for this transaction for compliance purposes. |
RFI_RESPONDED | Nium has received the response to the request for additional compliance information requested per RFI. |
RETURNED | The transaction has been returned by the receiving bank. This status typically applies to a payout transaction when the beneficiary bank returns it for a specific reason. |
SCHEDULED | The transaction is scheduled and is going to be processed on the scheduled date. |
SENT_TO_BANK | The payout instruction has been sent to Nium's partner bank. When the partner bank sends the payment out, the status changes to PAID . |
Testing remittance transaction statuses in sandbox
To simulate transaction status in sandbox, you can use the below table to replicate PG_PROCESSING
, SENT TO BANK
, PAID
and RETURNED
status scenarios.
Create a payout request following the below steps:
- Call Add Beneficiary V2 API to create a beneficiary with:
beneficiaryCountryCode
as USdestinationCurrency
as USD
- Call Transfer Money API to create a transaction with the beneficiary hash ID obtained in Step 1 and the parameters mentioned in the below table -
IMPORTANT
In the below listed simulation scenarios, transition of all status changes occur at one minute intervals.
Scenario | Routing Code | Beneficiary Account Number | Description |
---|---|---|---|
PAID | 111000000 | 000987654321 | The status transitions from PG_PROCESSING --> SENT_TO_BANK --> PAID . |
RETURN | 111000000 | 000897654321 | The status transitions from PG_PROCESSING --> SENT_TO_BANK --> RETURN |
PAID to RETURN | 111000000 | 000879654321 | The status transitions from PG_PROCESSING --> SENT_TO_BANK --> PAID --> RETURN |
PAID | 111000000 | 000987654322 | The status transitions from SENT_TO_BANK --> PAID |
Updated 18 days ago