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	The transfer request has been created and transmitted to the payout network (bank, card, or cash pickup partner). If the transfer is held for partner review, it remains in this state until additional information is provided or the review is cleared.	All Payment Types
Pending	The transfer has been accepted by the payout network and is in process. This state covers cases where the transaction is awaiting settlement, partner confirmation, or compliance clearance.	Bank Account & Cash Pickup
Failed	The transfer submission was rejected by the payout network or issuing bank. This typically occurs due to validation errors, compliance failures, or partner-side declines. End users are notified and may attempt the transfer again.	All Payment Types
Canceled	The transfer was canceled by either the user or the payout partner before completion.	All Payment Types
Complete	The transfer has been successfully released to the payout partner. For bank transfers, funds have been transmitted to the recipient’s bank; for cash pickups, funds are available for collection.	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.