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

Initiated: The status shall be sent when transfer data has been successfully collected and is being reviewed for submission. The status typically correlates to Push to Card transfers.

Pending: The status shall be sent when a transfer has been successfully submitted and is in process. The status typically correlates to Bank Account and Cash Pickup transfers.

Failed: The status shall be sent when a transfer cannot be processed. The status typically correlates to transfers that have failed data validation or compliance checks.

Canceled: The status shall be sent when a request to cancel a transfer has been successfully completed. The status typically correlates to Bank Account and Cash Pickup transfers that meet cancelation eligibility requirements.

Complete: The status shall be sent when a transfer has been successfully accepted and processed.

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.