Transfer status updates
In this guide, you will learn how to receive Transfer status updates in near-real time from the ReadyRemit API.
Transfer statuses change frequently, and by integrating with the Transfer Status Update endpoint, you can respond to status updates quickly, and provide your users a better experience.
Transfer status updates also play a key role in quickly and accurately returning funds to a sender's account in the event of a transfer cancelation.
1. Authentication
The ReadyRemit Integrations team will generate a unique API key and provide it to you via secure email. The token will appear in the request header Authorization.
Any request to your webhook endpoint that doesn't include the Authorization header, or that includes an incorrect API key should should return an HTTP 401 response.
2. Expose a status update endpoint
Your system must be able to consume REST API messages from ReadyRemit in the following format:
curl --location 'https://YOUR_DOMAIN/YOUR_ENDPOINT' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic API_KEY' \
--data '{
"TransferId": "ffffee5e-4e37-4945-a6ca-40fdb8a16851",
"Status": "Canceled",
"StatusChangedDate": "2023-02-13T21:40:02.08577Z",
"CancellationReason": "AMOUNT_INCORRECT"
}'
This endpoint should respond with an HTTP status code 200 if the status update was received successfully. Any 4XX or 5XX status codes should be treated as failures.
Transfer statuses
| Status | Description | Payment Types |
|---|---|---|
| Initiated | Indicates when transfer data has been successfully collected and is being reviewed for submission. | Push to Card |
| Pending | Indicates when a transfer has been successfully submitted and is in process. | Bank Account & Cash Pickup |
| Failed | Indicates when a transfer cannot be processed. The status typically correlates to transfers that have failed data validation or compliance checks. | Push to Card |
| Canceled | Indicates when a request to cancel a transfer has been completed for transfers that meet cancelation eligibility requirements. | Bank Account & Cash Pickup |
| Complete | Indicates when a transfer has been successfully accepted and processed. | All Payment Types |
3. Share your endpoint with the ReadyRemit Integrations Team
Once it's ready, share the URL for your status update endpoint with the ReadyRemit Integrations Team.
Sandbox
You can provide a separate URL to connect to the ReadyRemit Sandbox environment for testing purposes.
That's it!
You'll begin receiving status updates as soon as the ReadyRemit Integrations Team configures your endpoint.
Updated 26 days ago