This release features the addition of a request-id header to ReadyRemit API response headers, and several changes to API operations that tend to simplify the interface.

General

Request ID

Each API operation (except Get Access Token) includes a request-id response header that uniquely identifies the specific request:

request-id: 0f749497-08be-40ef-8d29-050ce86fe619

ReadyRemit API consumers together with ReadyRemit support engineers can use this identifier to troubleshoot a particular request. See 18600.

Transfer Status

This release establishes the following transfer statuses:

Pending release
Released
Canceled

See 17979.

API operations

Create Recipient

This operation no longer supports dstCountryIso3Code, dstCurrencyIso3ode, and transferMethod query parameters. See 18655.

Create Recipient Account

The request data no longer requires a senderId property. The ReadyRemit service now uses the recipientId path parameter to determine the associated senderId without assistance from the API client. See 18668.

Get Recipient

For recipientType=PERSON, this operation returns firstName and lastName properties and fields:

{
  "recipientId": "6f5ba7ce-0d40-449e-81de-b12c618eb6dd",
  "senderId": "55ef79b0-0f0f-459f-ad62-effcf516df7d",
  "recipientType": "PERSON",
  "firstName": "Jane",
  "lastName": "Doe",
  "fields": [
    {
      "id": "FIRST_NAME",
      "type": "TEXT",
      "value": "Jane"
    },
    {
      "id": "LAST_NAME",
      "type": "TEXT",
      "value": "Doe"
    }
  ]
}

For recipientType=BUSINESS, this operation returns a companyName property and a corresponding field:

{
  "recipientId": "7aeefa7e-4e2c-4a3f-b702-61cc27f47087",
  "senderId": "55ef79b0-0f0f-459f-ad62-effcf516df7d",
  "recipientType": "BUSINESS",
  "companyName": "Overseas Inc",
  "fields": [
    {
      "id": "COMPANY_NAME",
      "type": "TEXT",
      "value": "Overseas Inc"
    }
  ]
}

See 18765.

Get Recipients

For recipientType=PERSON, this operation returns firstName and lastName properties and fields, and for recipientType=BUSINESS, this operation returns a companyName property and a corresponding field:

{
  "recipients": [
    {
      "recipientId": "986d85c1-72b8-47ef-85d5-619b308fa6fa",
      "senderId": "55ef79b0-0f0f-459f-ad62-effcf516df7d",
      "recipientType": "PERSON",
      "firstName": "Alpha",
      "lastName": "Flight",
      "fields": [
        {
          "id": "FIRST_NAME",
          "type": "TEXT",
          "value": "Alpha"
        },
        {
          "id": "LAST_NAME",
          "type": "TEXT",
          "value": "Flight"
        }
      ]
    },
    {
      "recipientId": "59555d87-5357-4e17-bcb1-83cbcf59a711",
      "senderId": "55ef79b0-0f0f-459f-ad62-effcf516df7d",
      "recipientType": "BUSINESS",
      "companyName": "Overseas Inc",
      "fields": [
        {
          "id": "COMPANY_NAME",
          "type": "TEXT",
          "value": "Overseas Inc"
        }
      ]
    }

See 18765.

Get Transfer Fields

The API now includes a Get Transfer Fields operation which, given destination country & currency codes and a transfer method, returns required or optional fields for inclusion in Execute Transfer. One such field is Purpose of Remittance ("fieldId": "REMITTANCE_PURPOSE"). This field includes a list of options (e.g. Family Maintenance, Education, Medical, etc.) for use in a dropdown menu. See 18361.

Update Recipient

This operation no longer supports dstCountryIso3Code, dstCurrencyIso3ode, and transferMethod query parameters. See 18655.

Update Recipient Account

The request data no longer requires a senderId property. The ReadyRemit service now uses the recipientId path parameter to determine the associated senderId without assistance from the API client. See 18668.

Changelog

API v1 2022-07-04

API v1 2022-04-15

API v1 2022-04-01