NAV Navbar
javascript shell

Introduction

We provide two distinct base urls for making API requests depending on whether you would like to utilize the sandbox or live environments. These two environments are completely separate and share no information, including API credentials. For testing please use the Sandbox API and when you are ready to process live transactions use the Live endpoint.

Note: API Key is available in your Remitr Account login.

Payout Process/workflow

Once you have access to your API key, You can go through below steps to send payment to a Beneficiary/Recipient.

Use Authentication endpoint and provide registered email & API key to get Access Token which will be used for further API calls.

Let’s start with the first step by creating an Beneficiary/Identity resource. Each Identity represents either a person or a business. We use this resource to associate bank a/c, cards and payouts. This structure makes it simple to manage and reconcile payment instruments and payout history. Accounting of funds is done using the Beneficiary/Identity so it’s recommended to have an Identity per recipient of funds. Additionally, the Identity resource is optionally used to collect KYC information. Register a Beneficiary using Add Beneficiary end point, "beneficiary_id" is returned in response. Persist "beneficiary_id" in your data store for future use.

Add/Associate an Instrument (Bank a/c, card details etc) to a registered Beneficiary in previous step. Use Add Instrument end point to execute this step. Persist "instrument_id" in your data store for future use.

Use Get Quote end point to see current Fx-rate & Fee for doing payment to an intended Beneficiary's Instrument by providing "beneficiary_id", "instrument_id" & "payout_amount"

Now the final step - time to payout the Beneficiary/Recipient!

Next you’ll need to create a Transfer. What’s a Transfer? A Transfer represents any flow of funds to a Payment Instrument. In this case a Payout to an Instrument or card.

To create a Transfer, you’ll have to use send endpoint and simply supply the Payment Instrument ID (i.e. "beneficiary_instrument_id") of the previously created Instrument of a Beneficiary, Payout amount ( i.e. "amount") .

You’ll also want to store the "pymnt_send_ref" from that Transfer for your future reference. Transfers can have three possible states UNDER_PROCESS, COMPLETED, FAILED. You can use Send payment list endpoint to check the current status of payments.

Authentication

To authorize and get auth_token, use this code:

curl -X POST \
  https://dev-publicapi.remitr.com/api/v1/authenticate \
  -H 'Content-Type: application/json' \
  -d '{
    "login_id":"demo@remitr.com",
    "api_key":"kjhkfshkdsfhkjdsfywq7632ghwehk"
}'
var request = require("request");

var options = { method: 'POST',
  url: 'https://dev-publicapi.remitr.com/api/v1/authenticate',
  headers: 
   { 'Content-Type': 'application/json' },
  body: { login_id: 'demo@remitr.com', api_key: 'kjhkfshkdsfhkjdsfywq7632ghwehk' },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Make sure to replace kjhkfshkdsfhkjdsfywq7632ghwehk with your API key and demo@remitr.com by your login_id

The above command returns JSON structured like this:

{
    "status": "Success",
    "res": {
        "token": {
            "token": "756f7f6e5d2e437d1d4f29c562b741d7.eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNTYsImV4cGlyeSI6MTU1NjgwNjE1NzAwMCwiZXhwaXJlc0luIjoxNTU2ODA2MTU3MDAwLCJleHAiOjE1NTY4MjAzMTcsImlhdCI6MTU1NjgwNTkxN30.rd9tybIox5TeTAUjahf343tsPTIAqoZFx_nmBi28NoY",
            "expiresIn": 1556806157000
        },
        "sessionid": "d98e52dc08bb70b75f696b09f8f7873a"
    }
}

The Remitr API authentication and authorization endpoint. Submit a login ID and API key for a Remitr account. On successful login, a temporary authentication token is returned. An authentication token is required to make requests to all other endpoints in the Remitr API. Tokens expire after 30 minutes of inactivity. Token requests are limited to 10 calls per minute. For security, Remitr accounts are disabled when four unsuccessful login attempts are made within a short period. Account holders must contact Remitr customer care to reactivate their account.

HTTP Request

POST /v1/authenticate

API Parameters

Name In Type Description
login_id formData string,
required
Login ID for a Remitr account. This is usually an email address.
api_key formData string,
required
The unique API key for the Remitr account.

Beneficiary

Add Beneficiary

curl -X POST \
  https://dev-publicapi.remitr.com/api/v1/beneficiaries \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 9307e7f58099731aa731ed3a6818807b' \
  -d '{
  "entity_type": "INDIVIDUAL",
  "first_name": "Sandy",
  "last_name": "D'\''suza",
  "email": "sandy@xyz.com",
  "mobile": "4372341479",
  "mobile_country": "CA",
  "doc_id_type": "DRIVERS_LICENSE",
  "doc_id_value": "57687",
  "vendor_code": "099",
  "date_of_birth": "1970-02-15",
  "address": {
    "line1": "10 Dundas St E",
    "city": "Toronto",
    "postcode": "M5B2G9",
    "state_or_province": "ON",
    "country": "CA"
  },
  "BANK_ACCOUNT_CREDIT": {
    "account_number": "6338474",
    "routing_code_type_1": "INSTITUTION_NO",
    "routing_code_value_1": "001",
    "routing_code_type_2": "TRANSIT_CODE",
    "routing_code_value_2": "23452",
    "bank_address": "",
    "bank_name": "",
    "currency": "CAD",
    "bank_account_type": "SAVINGS"
  },
  "CARD_PAYMENT": {
    "card_number": "4652893794745237",
    "security_code": "683",
    "expiration_month": "07",
    "expiration_year": "2022",
    "currency": "CAD"
  }
}'
var request = require("request");

var options = { method: 'POST',
  url: 'https://dev-publicapi.remitr.com/api/v1/beneficiaries',
  headers: 
   { 'X-Auth-Token': '9307e7f58099731aa731ed3a6818807b',
     'Content-Type': 'application/json' },
  body: 
   { entity_type: 'INDIVIDUAL',
     first_name: 'Sandy',
     last_name: 'D\'suza',
     email: 'sandy@xyz.com',
     mobile: '4372341479',
     mobile_country: 'CA',
     doc_id_type: 'DRIVERS_LICENSE',
     doc_id_value: "57687",
     vendor_code: "099",
     date_of_birth: '1970-02-15',
     address: 
      { line1: '10 Dundas St E',
        city: 'Toronto',
        postcode: 'M5B2G9',
        state_or_province: 'ON',
        country: 'CA' },
     BANK_ACCOUNT_CREDIT: 
      { account_number: '6338474',
        routing_code_type_1: 'INSTITUTION_NO',
        routing_code_value_1: '001',
        routing_code_type_2: 'TRANSIT_CODE',
        routing_code_value_2: '23452',
        bank_address: '',
        bank_name: '',
        currency: 'CAD',
        bank_account_type: "SAVINGS" },
     CARD_PAYMENT: 
      { card_number: '4652893794745237',
        security_code: '683',
        expiration_month: '07',
        expiration_year: '2022',
        currency: 'CAD' } },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

The above command returns JSON structured like this:

{
    "status": "Success",
    "res": {
        "beneficiary_id": "1100002816",
        "record_status": "COMPLETE",
        "entity_type": "INDIVIDUAL",
        "first_name": "Sandy",
        "middle_name": "",
        "last_name": "D'suza",
        "email": "sandy@xyz.com",
        "mobile": "+17889798799",
        "vendor_code": "099",
        "date_of_birth": "1970-02-15",
        "address": {
            "line1": "10 Dundas St E",
            "line2": "",
            "city": "Toronto",
            "postcode": "M5B2G9",
            "state_or_province": "ON",
            "country": "CA",
            "created_at": "2019-05-23 07:40:00"
        },
        "created_at": "2018-12-15 11:34:23",
        "payment_instruments": [
            {
                "instrument_id": "6546567-2c1a-435c-861d-skjhdsf87w4",
                "created_at": "2018-12-15 11:34:23",
                "intrument_type": "BANK_ACCOUNT_CREDIT",
                "account_number": "6338474",
                "routing_code_type_1": "INSTITUTION_NO",
                "routing_code_value_1": "001",
                "routing_code_type_2": "TRANSIT_CODE",
                "routing_code_value_2": "23452",
                "bank_address": "",
                "bank_name": "",
                "currency": "CAD",
                "bank_account_type": "SAVINGS"
            },
            {
                "instrument_id": "64654654-2c1a-435c-861d-sdjnkjsd73we",
                "created_at": "2018-12-15 11:34:23",
                "intrument_type": "CARD_PAYMENT",
                "card_number": "4652893794745237",
                "expiration_month": "07",
                "expiration_year": "2022",
                "currency": "CAD"
            }
        ]
    }
}

Create new beneficiary.
Optionally, you can add the payment instrument (Bank account info OR Card info) details of the beneficiary in this API. You may choose to add instrument details using "Beneficiary - Add Payment Instrument" API later too. On success, returns the beneficiary & payment instrument IDs in Remitr

HTTP Request

POST /v1/beneficiaries

API Parameters

Name In Type Description Enum Default Items
X-Auth-Token header string, required Authentication token
entity_type formData string, required Legal entity. INDIVIDUAL, CORPORATE
company_name formData string, optional Required if "beneficiary_entity_type" is "CORPORATE".
first_name formData string, optional Required if "beneficiary_entity_type" is "INDIVIDUAL".
middle_name formData string, optional if "beneficiary_entity_type" is "INDIVIDUAL".
last_name formData string, optional Required if "beneficiary_entity_type" is "INDIVIDUAL".
email formData string, required Email address
mobile formData string, required Valid Mobile Number without + and country dialing code
mobile_country formData string, optional Provide, if mobile country is different than beneficiary's country
vendor_code formData string, optional Vendor Code
date_of_birth formData string, optional If "beneficiary_entity_type" is "CORPORATE", date of registration. If "beneficiary_entity_type" is "INDIVIDUAL", date of birth. ISO 8601 format YYYY-MM-DD.
doc_id_type formData string, required A legal document that verifies the identity of the beneficiary. Required documentation will vary depending on the country in which the beneficiary's bank account is held. NONE
DRIVERS_LICENSE
SOCIAL_SECURITY_NUMBER
GREEN_CARD
PASSPORT
VISA
MATRICULA_CONSULAR
REGISTRO_FEDERAL_DE_CONTRIBUYENTES
CLAVE_UNICA_DE_REGISTRO_DE_POBLACION
CREDENTIAL_DE_ELECTOR
SOCIAL_INSURANCE_NUMBER
CITIZENSHIP_PAPERS
DRIVERS_LICENSE_CANADIAN
EXISTING_CREDIT_CARD_DETAILS
EMPLOYER_IDENTIFICATION_NUMBER
NATIONAL_ID
INCORPORATION_NUMBER
OTHERS
doc_id_value formData string, optional A unique reference code for the identification document, such as a passport number.
address formData object, required Address details (Full description of child attributes below)
BANK_ACCOUNT_CREDIT formData object, optional Bank account details (Full description of child attributes below)
CARD_PAYMENT formData object, optional Card details (Full description of child attributes below), Please note that card payment feature is disabled by default. Contact us to enable it for you.

address Object attribute details

Name In Type Description Enum Default Items
line1 formData string, required First line of the address (max 60 characters)
line2 formData string, optional Second line of the address (max 60 characters)
city formData string, required City (max 20 characters)
postcode formData string, required Zip or Postal code (max 7 characters)
state_or_province formData string, required 2-letter State or province code
country formData string, required Two-letter country code. If the beneficiary is a COMPANY, the country in which the company is registered. If the beneficiary is an INDIVIDUAL, a country in which the beneficiary holds nationality.

BANK_ACCOUNT_CREDIT Object attribute details

Name In Type Description Enum Default Items
account_number formData string, optional Bank account number.
routing_code_type_1 formData string, required Local payment routing system. SORT_CODE
ABA
BSB_CODE
INSTITUTION_NO
BANK_CODE
BRANCH_CODE
CLABE
CNAPS
IFSC
routing_code_value_1 formData string, required Routing code for "routing_code_type_1".
routing_code_type_2 formData string, required Local payment routing system. SORT_CODE
ABA
BSB_CODE
INSTITUTION_NO
BANK_CODE
BRANCH_CODE
CLABE
CNAPS
routing_code_value_2 formData string, required Routing code for "routing_code_type_2".
bic_swift formData string, optional BIC/SWIFT code.
iban formData string, optional IBAN code.
bank_address formData string, optional First line of address.
bank_name formData string, optional Bank name.
bank_account_type formData string, optional Bank account type. CHECKINGS
SAVINGS
currency formData string, required Bank account currency. Three-char ISO currency code.

CARD_PAYMENT Object attribute details, Please note that card payment feature is disabled by default. Contact us to enable it for you.

Name In Type Description Enum Default Items
card_number formData string, required Primary card account number
security_code formData string, optional The 3-4 digit security code for the card (i.e. CVV code)
expiration_month formData integer, required Expiration month (e.g. 12 for December)
expiration_year formData integer, required 4-digit expiration year
currency formData string, required Currency that should be associated with card

Invite Beneficiary

curl -X POST \
  https://dev-publicapi.remitr.com/api/v1/beneficiaries/invite \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 9307e7f58099731aa731ed3a6818807b' \
  -d '{
  "entity_type": "INDIVIDUAL",
  "first_name": "test1",
  "last_name": "test2",
  "email": "test0@test.com",
  "date_of_birth": "1988-01-07",
  "mobile": "4372341479",
  "mobile_country":"CA",
  "sender_comments":"Please provide your bank account information for invoice payment",
  "address": {
    "line1": "",
    "city": "",
    "postcode": "",
    "state_or_province": "",
    "country": "CA"
  }
}'
var request = require("request");

var options = { method: 'POST',
  url: 'https://dev-publicapi.remitr.com/api/v1/beneficiaries/invite',
  headers: 
   { 'X-Auth-Token': '9307e7f58099731aa731ed3a6818807b',
     'Content-Type': 'application/json' },
  body: 
   {
      entity_type: "INDIVIDUAL",
      first_name: "test1",
      last_name: "test2",
      email: "test0@test.com",
      date_of_birth: "1988-01-07",
      mobile: 4372341479,
      mobile_country: "CA",
      sender_comments: "Please provide your bank account information for invoice payment",
      address: {
        line1: 0,
        city: 0,
        postcode: 0,
        state_or_province: 0,
        country: "CA"
  }
},
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

The above command returns JSON structured like this:

{
    "status": "Success",
    "res": {
        "beneficiary_id": 1100003750,
        "record_status": "PENDING",
        "entity_type": "INDIVIDUAL",
        "email": "test0@test.com",
        "vendor_code": "",
        "mobile": "4372341479",
        "first_name": "test1",
        "middle_name": "",
        "last_name": "test2",
        "date_of_birth": "1988-01-07",
        "address": {
            "line1": "",
            "line2": "",
            "city": "",
            "postcode": "",
            "state_or_province": "",
            "country": "CA",
            "created_at": "2020-04-28 04:40:13"
        },
        "created_at": "2020-04-28 04:40:13",
        "payment_instruments": []
    }
}

Invite new beneficiary for self-onboarding.
This feature can be used if you don't have full details of beneficiary with you. On Success, An email with onboarding link will go to beneficiary's email address. Using this link, Beneficiary can fill his/her address/kyc and payment instrument details.

On success, returns the beneficiary ID with current record status in Remitr.

Note: Beneficiary record status (refer record_status in the response object) can be checked using beneficiary details endpoint.

HTTP Request

POST /v1/beneficiaries/invite

API Parameters

Name In Type Description Enum Default Items
X-Auth-Token header string, required Authentication token
entity_type formData string, required Legal entity. INDIVIDUAL, CORPORATE
company_name formData string, optional Required if "beneficiary_entity_type" is "CORPORATE".
first_name formData string, optional Required if "beneficiary_entity_type" is "INDIVIDUAL".
middle_name formData string, optional if "beneficiary_entity_type" is "INDIVIDUAL".
last_name formData string, optional Required if "beneficiary_entity_type" is "INDIVIDUAL".
email formData string, required Valid Email address of beneficiary, A link will go this email for inputting address & bank account information
date_of_birth formData string, optional If "beneficiary_entity_type" is "CORPORATE", date of registration. If "beneficiary_entity_type" is "INDIVIDUAL", date of birth. ISO 8601 format YYYY-MM-DD.
mobile formData string, required Mobile Number without + and country dialing code, Beneficiary may receive an OTP on this number which will be asked to input while submitting bank account information
mobile_country formData string, optional Provide, if mobile country is different than beneficiary's country
sender_comments formData string Additional comments to let beneficiary know why your asked him to feed address and bank account details through invitation link
address formData object, required Address details (Full description of child attributes below)

address Object attribute details

Name In Type Description Enum Default Items
line1 formData string, optional First line of the address (max 60 characters)
city formData string, optional City (max 20 characters)
postcode formData string, optional Zip or Postal code (max 7 characters)
state_or_province formData, optional string 2-letter State or province code
country formData string, required Two-letter country code. If the beneficiary is a COMPANY, the country in which the company is registered. If the beneficiary is an INDIVIDUAL, a country in which the beneficiary holds nationality.
curl -X POST \
  https://dev-publicapi.remitr.com/api/v1/beneficiaries/1100003766/resend-invite \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 9307e7f58099731aa731ed3a6818807b' \
  -d '{
  "sender_comments":"Please provide your bank account information for invoice payment",
}'
var request = require("request");

var options = { method: 'POST',
  url: 'https://dev-publicapi.remitr.com/api/v1/beneficiaries/1100003766/resend-invite',
  headers: 
   { 'X-Auth-Token': '9307e7f58099731aa731ed3a6818807b',
     'Content-Type': 'application/json' },
  body: 
   {
     sender_comments: "Please provide your bank account information for invoice payment",
   }
},
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

The above command returns JSON structured like this:

{
    "status": "Success",
    "res": {
        "beneficiary_id": 1100003766,
        "record_status": "PENDING",
        "entity_type": "INDIVIDUAL",
        "email": "test0@test.com",
        "vendor_code": "",
        "mobile": "4372341479",
        "first_name": "test1",
        "middle_name": "",
        "last_name": "test2",
        "date_of_birth": "1988-01-07",
        "address": {
            "line1": "",
            "line2": "",
            "city": "",
            "postcode": "",
            "state_or_province": "",
            "country": "CA",
            "created_at": "2020-04-28 04:40:13"
        },
        "created_at": "2020-04-28 04:40:13",
        "payment_instruments": []
    }
}

Resend a fresh link to existing beneficiary for adding new bank details.

On success, returns the beneficiary ID with current record status in Remitr.

HTTP Request

POST /v1/beneficiaries/{{beneficiary_id}}/resend-invite

API Parameters

Name In Type Description Enum Default Items
X-Auth-Token header string, required Authentication token
sender_comments formData string, required Additional comments to let beneficiary know why your asked him to feed bank account details

Add Instrument

curl -X POST \
  https://dev-publicapi.remitr.com/api/v1/beneficiaries/1100002816/instruments \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 9307e7f58099731aa731ed3a6818807b' \
  -d '{
  "BANK_ACCOUNT_CREDIT": {
    "account_number": "6338474",
    "routing_code_type_1": "INSTITUTION_NO",
    "routing_code_value_1": "001",
    "routing_code_type_2": "TRANSIT_CODE",
    "routing_code_value_2": "23452",
    "bank_address": "",
    "bank_name": "",
    "currency": "CAD",
    "bank_account_type": "SAVINGS"
  },
  "CARD_PAYMENT": {
    "card_number": "4652893794745237",
    "security_code": "683",
    "expiration_month": "07",
    "expiration_year": "2022",
    "currency": "CAD"
  }
}'
var request = require("request");

var options = { method: 'POST',
  url: 'https://dev-publicapi.remitr.com/api/v1/beneficiaries/1100002816/instruments',
  headers: 
   { 'X-Auth-Token': '9307e7f58099731aa731ed3a6818807b',
     'Content-Type': 'application/json' },
  body: 
   { BANK_ACCOUNT_CREDIT: 
      { account_number: '6338474',
        routing_code_type_1: 'INSTITUTION_NO',
        routing_code_value_1: '001',
        routing_code_type_2: 'TRANSIT_CODE',
        routing_code_value_2: '23452',
        bank_address: '',
        bank_name: '',
        currency: 'CAD',
        bank_account_type: "SAVINGS" },
     CARD_PAYMENT: 
      { card_number: '4652893794745237',
        security_code: '683',
        expiration_month: '07',
        expiration_year: '2022',
        currency: 'CAD' } },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

The above command returns JSON structured like this:

{
    "status": "Success",
    "res": {
        "payment_instruments": [
            {
                "instrument_id": "6546567-2c1a-435c-861d-skjhdsf87w4",
                "created_at": "2018-12-15 11:34:23",
                "intrument_type": "BANK_ACCOUNT_CREDIT",
                "account_number": "6338474",
                "routing_code_type_1": "INSTITUTION_NO",
                "routing_code_value_1": "001",
                "routing_code_type_2": "TRANSIT_CODE",
                "routing_code_value_2": "23452",
                "bank_address": "",
                "bank_name": "",
                "currency": "CAD",
                "bank_account_type": "SAVINGS"
            },
            {
                "instrument_id": "64654654-2c1a-435c-861d-sdjnkjsd73we",
                "created_at": "2018-12-15 11:34:23",
                "intrument_type": "CARD_PAYMENT",
                "card_number": "4652893794745237",
                "expiration_month": "07",
                "expiration_year": "2022",
                "currency": "CAD"
            }
        ]
    }
}

Add Instrument (i.e. Bank account details or/and Card Details) of the beneficiary created in previous step. On success, returns the instrument_id along with associated beneficiary_id.

HTTP Request

POST /v1/beneficiaries/<:beneficiary_id>/instruments

API Parameters

Name In Type Description Enum Default Items
X-Auth-Token header string, required Authentication token
beneficiary_id urlParams string, required Remitr's ID of the Beneficiary that you created in the last step
BANK_ACCOUNT_CREDIT formData object, required Bank account details (Full description of child attributes below)
CARD_PAYMENT formData object, optional Card details (Full description of child attributes below), Please note that card payment feature is disabled by default. Contact us to enable it for you.

BANK_ACCOUNT_CREDIT Object attribute details

Name In Type Description Enum Default Items
account_number formData string, optional Bank account number.
routing_code_type_1 formData string, required Local payment routing system. SORT_CODE
ABA
BSB_CODE
INSTITUTION_NO
BANK_CODE
BRANCH_CODE
CLABE
CNAPS
IFSC
routing_code_value_1 formData string, required Routing code for "routing_code_type_1".
routing_code_type_2 formData string, required Local payment routing system. SORT_CODE
ABA
BSB_CODE
INSTITUTION_NO
BANK_CODE
BRANCH_CODE
CLABE
CNAPS
routing_code_value_2 formData string, required Routing code for "routing_code_type_2".
bic_swift formData string, optional BIC/SWIFT code.
iban formData string, optional IBAN code.
bank_address formData string, optional First line of address.
bank_name formData string, optional Bank name.
bank_account_type formData string, optional Bank account type. CHECKINGS, SAVINGS
currency formData string, required Bank account currency. Three-char ISO currency code.

CARD_PAYMENT Object attribute details, Please note that card payment feature is disabled by default. Contact us to enable it for you.

Name In Type Description Enum Default Items
card_number formData string, required Primary card account number
security_code formData string, optional The 3-4 digit security code for the card (i.e. CVV code)
expiration_month formData integer, required Expiration month (e.g. 12 for December)
expiration_year formData integer, required 4-digit expiration year
currency formData string, required Currency that should be associated with card

Beneficiary List

curl -X GET \
  https://dev-publicapi.remitr.com/api/v1/beneficiaries \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 9307e7f58099731aa731ed3a6818807b' \
var request = require("request");

var options = { method: 'GET',
  url: 'https://dev-publicapi.remitr.com/api/v1/beneficiaries',
  headers: 
   { 'X-Auth-Token': '9307e7f58099731aa731ed3a6818807b',
     'Content-Type': 'application/json' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});


The above command returns JSON structured like this:

{
    "status": "Success",
    "res": [
        {
            "beneficiary_id": "1100002816",
            "record_status": "COMPLETE",
            "entity_type": "INDIVIDUAL",
            "first_name": "Sandy",
            "middle_name": "",
            "last_name": "D'suza",
            "email": "sandy@xyz.com",
            "mobile": "+17889798799",
            "vendor_code": "099",
            "date_of_birth": "1970-02-15",
            "address": {
                "line1": "10 Dundas St E",
                "line2": "",
                "city": "Toronto",
                "postcode": "M5B2G9",
                "state_or_province": "ON",
                "country": "CA",
                "created_at": "2019-05-23 06:15:43"
            },
            "created_at": "2018-12-15 11:34:23"
        }
    ]
}

Get registered beneficiary list. Filter the list based various beneficiary attributes in query parameters. On success, returns the beneficiary list of objects.

HTTP Request

GET /v1/beneficiaries

API Parameters

Name In Type Description Enum Default Items
X-Auth-Token header string, required Authentication token
entity_type query string, optional Legal entity. INDIVIDUAL, CORPORATE
company_name query string, optional Company/Entity Name
first_name query string, optional First Name
middle_name query string, optional Middle Name
last_name query string, optional Last Name
email query string, optional Email address
mobile query string, optional Mobile Number
created_at_from query string, Required peer if applying filter on created_at_to Beneficiary addition date in 'YYYY-MM-DD' format
created_at_to query string, optional Beneficiary addition date in 'YYYY-MM-DD' format
offset query number, optional Used for pagination, default is 0
limit query number, optional Used for pagination, default is 20

Beneficiary details

curl -X GET \
  https://dev-publicapi.remitr.com/api/v1/beneficiaries/1100002816 \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 9307e7f58099731aa731ed3a6818807b' \
var request = require("request");

var options = { method: 'GET',
  url: 'https://dev-publicapi.remitr.com/api/v1/beneficiaries/1100002816',
  headers: 
   { 'X-Auth-Token': '9307e7f58099731aa731ed3a6818807b',
     'Content-Type': 'application/json' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

The above command returns JSON structured like this:

{
    "status": "Success",
    "res": {
        "beneficiary_id": "1100002816",
        "record_status": "COMPLETE",
        "entity_type": "INDIVIDUAL",
        "first_name": "Sandy",
        "middle_name": "",
        "last_name": "D'suza",
        "email": "sandy@xyz.com",
        "mobile": "+17889798799",
        "vendor_code": "099",
        "date_of_birth": "1970-02-15",
        "address": {
            "line1": "10 Dundas St E",
            "line2": "",
            "city": "Toronto",
            "postcode": "M5B2G9",
            "state_or_province": "ON",
            "country": "CA",
            "created_at": "2019-05-23 07:40:00"
        },
        "created_at": "2018-12-15 11:34:23",
        "payment_instruments": [
            {
                "instrument_id": "6546567-2c1a-435c-861d-skjhdsf87w4",
                "created_at": "2018-12-15 11:34:23",
                "intrument_type": "BANK_ACCOUNT_CREDIT",
                "account_number": "6338474",
                "routing_code_type_1": "INSTITUTION_NO",
                "routing_code_value_1": "001",
                "routing_code_type_2": "TRANSIT_CODE",
                "routing_code_value_2": "23452",
                "bank_address": "",
                "bank_name": "",
                "currency": "CAD",
                "bank_account_type": "SAVINGS"
            },
            {
                "instrument_id": "64654654-2c1a-435c-861d-sdjnkjsd73we",
                "created_at": "2018-12-15 11:34:23",
                "intrument_type": "CARD_PAYMENT",
                "card_number": "4652893794745237",
                "expiration_month": "07",
                "expiration_year": "2022",
                "currency": "CAD"
            }
        ]
    }
}

Get Beneficiary details along with associated payment instruments. . On success, returns the beneficiary details object.

Possible values of record_status field is PENDING, COMPLETE, APPROVED

PENDING - payment instruments/kyc details are yet to be submitted/added.

COMPLETE - all required data is available.

APPROVED - due diligence (eg WLC) is also done.

Note: In case of invited beneficiary record_status will be PENDING till the time beneficiary submits the information

HTTP Request

GET /v1/beneficiaries/<:beneficiary_id>

API Parameters

Name In Type Description Enum Default Items
X-Auth-Token header string,
required
Authentication token

Deactivate Beneficiary

curl -X PUT \
  https://dev-publicapi.remitr.com/api/v1/beneficiaries/1100002816/deactivate \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 9307e7f58099731aa731ed3a6818807b' \
var request = require("request");

var options = { method: 'PUT',
  url: 'https://dev-publicapi.remitr.com/api/v1/beneficiaries/1100002816/deactivate',
  headers: 
   { 'X-Auth-Token': '9307e7f58099731aa731ed3a6818807b',
     'Content-Type': 'application/json' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Deactivate Beneficiary

The above command returns JSON structured like this:

{
    "status": "Success",
    "res": {
        "beneficiary_id": "1100003738",
        "active": 0
    }
}

HTTP Request

PUT /v1/beneficiaries/<:beneficiary_id>/deactivate

API Parameters

Name In Type Description Enum Default Items
X-Auth-Token header string,
required
Authentication token

Deactivate Instrument

curl -X PUT \
  https://dev-publicapi.remitr.com/api/v1/beneficiaries/1100003738/instruments/33b69397-ecbc-481c-9100-c1d06d9369f1/deactivate
  -H 'X-Auth-Token: 9307e7f58099731aa731ed3a6818807b' \
var request = require("request");

var options = { method: 'PUT',
  url: 'https://dev-publicapi.remitr.com/api/v1/beneficiaries/1100003738/instruments/33b69397-ecbc-481c-9100-c1d06d9369f1/deactivate',
  headers: 
   { 'X-Auth-Token': '9307e7f58099731aa731ed3a6818807b',
     'Content-Type': 'application/json' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Deactivate Instrument

The above command returns JSON structured like this:

{
    "status": "Success",
    "res": {
        "beneficiary_id": "1100002927",
        "instrument_id": "73b1e30c-9211-4f09-b66d-2c326e4ba350",
        "active": 0
    }
}

HTTP Request

PUT v1/beneficiaries/<:beneficiary_id>/instruments/<:instrument_id>/deactivate

API Parameters

Name In Type Description Enum Default Items
X-Auth-Token header string,
required
Authentication token

Ledger

Accounts

curl -X GET \
  'https://dev-publicapi.remitr.com/api/v1/accounts' \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 3257cfd62f61b0d4763ff51b87fbfbea.eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNTYsImV4cGlyeSI6MTU1NjgwNjQ4OTAwMCwiZXhwaXJlc0luIjoxNTU2ODA2NDg5MDAwLCJleHAiOjE1NTY4MjA2NDksImlhdCI6MTU1NjgwNjI0OX0.SK3mR5r-bbIzYo7C8EYPck7I2m4tcPo0px773P5Bgsk'
var request = require("request");

var options = { method: 'GET',
  url: 'https://dev-publicapi.remitr.com/api/v1/accounts',
  headers: 
   { 'X-Auth-Token': '3257cfd62f61b0d4763ff51b87fbfbea.eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNTYsImV4cGlyeSI6MTU1NjgwNjQ4OTAwMCwiZXhwaXJlc0luIjoxNTU2ODA2NDg5MDAwLCJleHAiOjE1NTY4MjA2NDksImlhdCI6MTU1NjgwNjI0OX0.SK3mR5r-bbIzYo7C8EYPck7I2m4tcPo0px773P5Bgsk',
     'Content-Type': 'application/json' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});


The above command returns JSON structured like this:

{
    "res": {
        "accounts": [
            {
                "id": 7301,
                "country": "CA",
                "base_currency": "CAD",
                "available_balance": "0.000000",
                "ledger_balance": "0.000000",
                "funcding_bank_account": []
            },
            {
                "id": 7302,
                "country": "CA",
                "base_currency": "USD",
                "available_balance": "0.000000",
                "ledger_balance": "0.000000",
                "funcding_bank_account": []
            }
        ]
    },
    "status": "Success"
}

Get ledger

HTTP Request

GET api/v1/accounts

API Parameters

Name In Type Description Enum Default Items
X-Auth-Token header string, required Authentication token

Send Payment

Get Quote

curl -X GET \
  'https://dev-publicapi.remitr.com/api/v1/payments/quote/{{beneficiary_id}}/{{instrument_id}}/{{payout_amount}}' \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 3257cfd62f61b0d4763ff51b87fbfbea.eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNTYsImV4cGlyeSI6MTU1NjgwNjQ4OTAwMCwiZXhwaXJlc0luIjoxNTU2ODA2NDg5MDAwLCJleHAiOjE1NTY4MjA2NDksImlhdCI6MTU1NjgwNjI0OX0.SK3mR5r-bbIzYo7C8EYPck7I2m4tcPo0px773P5Bgsk'
var request = require("request");

var options = { method: 'GET',
  url: 'https://dev-publicapi.remitr.com/api/v1/payments/quote/{{beneficiary_id}}/{{instrument_id}}/{{payout_amount}}',
  headers: 
   { 'X-Auth-Token': '3257cfd62f61b0d4763ff51b87fbfbea.eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNTYsImV4cGlyeSI6MTU1NjgwNjQ4OTAwMCwiZXhwaXJlc0luIjoxNTU2ODA2NDg5MDAwLCJleHAiOjE1NTY4MjA2NDksImlhdCI6MTU1NjgwNjI0OX0.SK3mR5r-bbIzYo7C8EYPck7I2m4tcPo0px773P5Bgsk',
     'Content-Type': 'application/json' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});


The above command returns JSON structured like this:

{
    "status": "Success",
    "res": {
        "quotations": [
            {
                "amount": "100",
                "src_curr": "USD",
                "dst_curr": "CAD",
                "src_amount": 76.92,
                "dst_amount": 100,
                "dst_amount_raw": 100,
                "src_amount_raw": 76.92201594210492,
                "fx_rate": 0.7592201594210491,
                "remitr_fee": 1,
                "customer_rate": 1.317141,
                "customer_fee": 1
            },
            {
                "amount": "100",
                "src_curr": "CAD",
                "dst_curr": "CAD",
                "src_amount": 101,
                "dst_amount": 100,
                "dst_amount_raw": 100,
                "src_amount_raw": 101,
                "fx_rate": 1,
                "remitr_fee": 1,
                "customer_rate": 1,
                "customer_fee": 1
            }
        ]
    }
}

Get tentative payment quotations for a beneficiary (registered instrument). On success, returns the quotes.

HTTP Request

GET /v1/payments/quote/{{beneficiary_id}}/{{instrument_id}}/{{payout_amount}}

API Parameters

Name In Type Description Enum Default Items
X-Auth-Token header string, required Authentication token
beneficiary_id params string, required Beneficiary's Identifier.
instrument_id params string, required Beneficiary's instrument Identifier.
payout_amount params number, required Amount
remitr_ledger_currency query string, optional Ledger/Funding/Source currency CAD, USD If not specified, two quotes will be returned for respective source ledgers

Send

curl -X POST \
  https://dev-publicapi.remitr.com/api/v1/payments/send \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 9307e7f58099731aa731ed3a6818807b' \
  -d '{
    "beneficiary_id": "1100003760",
    "beneficiary_instrument_id": "a6b8e27e-1aaa-4cee-b4cc-47dfd91b4a00",
    "amount_currency": "CAD",
    "remitr_ledger_currency": "CAD",
    "amount": "20",
    "reason": "B002",
    "reference1": "CUST_REF001",
    "reference2": "",
    "source_of_fund": "SALES PROCEED",
    "ref_invoice": "Invoice#866"
}'
var request = require("request");

var options = { method: 'POST',
  url: 'https://dev-publicapi.remitr.com/api/v1/payments/send',
  headers: 
   { 'X-Auth-Token': '9307e7f58099731aa731ed3a6818807b',
     'Content-Type': 'application/json' },
  body: 
   {
    beneficiary_id: 1100003760,
    beneficiary_instrument_id: "a6b8e27e-1aaa-4cee-b4cc-47dfd91b4a00",
    remitr_ledger_currency: "CAD",
    amount_currency: "CAD",
    amount: 200.50,
    reason: "B002",
    reference1: "CUST_REF001",
    reference2: "",
    source_of_fund: "SALES PROCEED",
    ref_invoice: "Invoice#866"
},
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

The above command returns JSON structured like this:

{
    "status": "Success",
    "res": {
        "pymnt_send_ref": "RE0A140C2C"
    }
}

Send payment to a beneficiary (registered instrument). On success, returns the payment reference number.

HTTP Request

POST /v1/payments/send

API Parameters

Name In Type Description Enum Default Items
X-Auth-Token header string, required Authentication token
beneficiary_id formData number, required Beneficiary's Identifier in Remitr, you can get this value from Beneficiary List API
beneficiary_instrument_id formData string, required Beneficiary's instrument or bank account identifier in Remitr. you can get this value from Beneficiary details API
remitr_ledger_currency formData string, optional Remitr Ledger currency form which funds will be debited CAD, USD CAD
amount_currency formData string, optional Currency in which payment is made to beneficiary. Three-char currency code.
amount formData number, required Amount to be credited in beneficiary's account
source_of_fund fromData string, required Source of fund, Free text input, Max length upto 200 chars
reason formData String, required Purpose/Reason code of the payment Valid reason/purpose codes values are 'B002', 'B005', '200', 'B001', where 'B002' - Bill Payment, 'B005' - Consultancy Payment', '200' - Fund Transfer, 'B001' - Salary Payment
reference1 formData String, required Unique payment identifier in your system, Payment requests with duplicate reference1 will be rejected by Remitr, Max length upto 200 chars
reference2 formData String, optional User-generated reference text/code/number for future reference. Max length upto 200 chars
ref_invoice formData String, optional It can be used to tag your Invoice number with the payment, max length upto 30 chars, This will reflect in the email received by beneficiary

Send payment list

curl -X GET \
  https://dev-publicapi.remitr.com/api/v1/payments/send \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 9307e7f58099731aa731ed3a6818807b'
var request = require("request");

var options = { method: 'GET',
  url: 'https://dev-publicapi.remitr.com/api/v1/payments/send',
  headers: 
   { 'X-Auth-Token': '9307e7f58099731aa731ed3a6818807b',
     'Content-Type': 'application/json' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

The above command returns JSON structured like this:

{
    "status": "Success",
    "res": [
        {
            "pymnt_send_ref": "RA1E759560",
            "status": "UNDER_PROCESS",
            "status_description": "Funds Being Confirmed",
            "beneficiary_id": "1100002816",
            "beneficiary_entity_type": "INDIVIDUAL",
            "beneficiary_first_name": "Sandy",
            "beneficiary_last_name": "D'suza",
            "beneficiary_city": "Toronto",
            "beneficiary_state_or_province": "ON",
            "beneficiary_email": "sandy@xyz.com",
            "beneficiary_mobile": "+17889798799",
            "beneficiary_address": "10 Dundas St E",
            "beneficiary_country": "CA",
            "instrument_id":"6546567-2c1a-435c-861d-skjhdsf87w4",
            "amount_currency": "CAD",
            "amount": 1950,
            "reason": "Consultancy Payment",
            "reference1": "CUST_REF001",
            "reference2": "",
            "failure_reason": ""
        }
    ]
}

All Send payments. On success, returns array of object/s having payment details along with current status. If pymnt_send_ref is passed in query parameter, API will return respective payment details only.

Possible values of "status" are "COMPLETED", "FAILED", "CANCELLED" and "UNDER_PROCESS", "AWAITING_FUNDS" If payment is in "FAILED" state, "failure_reason" will also be returned in the response object.

HTTP Request

GET /v1/payments/send

API Parameters

Name In Type Description Enum
X-Auth-Token header string, required Authentication token
pymnt_send_ref query string, optional Send Payment reference number generated by Remitr
reference1 query string, optional reference1 provided while making the transaction
reference2 query string, optional reference2 provided while making the transaction
amount query number, optional Amount of the transaction
created_at_from query string, Required peer if applying filter on created_at_to Transaction date in 'YYYY-MM-DD' format
created_at_to query string, optional Transaction date in 'YYYY-MM-DD' format
beneficiary_name query string, optional Beneficiary name
beneficiary_id query string, optional Beneficiary Id
status query string, optional payment status COMPLETED, UNDER_PROCESS, AWAITING_FUNDS, FAILED, CANCELLED
amount_currency query string, optional Transaction Currency 3 char ISO code
offset query number, optional Used for pagination, default is 0
limit query number, optional Used for pagination, default is 20

Cancel Payment

curl -X PUT \
  https://dev-publicapi.remitr.com/api/v1/payments/send/REA72218F1/cancel \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 9307e7f58099731aa731ed3a6818807b' \
var request = require("request");

var options = { method: 'PUT',
  url: 'https://dev-publicapi.remitr.com/api/v1/payments/send/REA72218F1/cancel',
  headers: 
   { 'X-Auth-Token': '9307e7f58099731aa731ed3a6818807b',
     'Content-Type': 'application/json' },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

The above command returns JSON structured like this:

{
    "status": "Success",
    "res": {
        "pymnt_send_ref": "REA72218F1",
        "status": "CANCELLED"
    }
}

Cancel a payment which is not processed at Remitr's end yet. Payment Amount will be credited back in ledger, if debited for the payment earlier. On success, returns the payment reference number and status.

HTTP Request

PUT /v1/payments/send/{{pymnt_send_ref}}/cancel

API Parameters

Name In Type Description Enum Default Items
X-Auth-Token header string, required Authentication token
pymnt_send_ref url parameter string, required Payments's Identifier provided by Remitr

Statistics - Awaiting funds

curl -X GET \
  https://dev-publicapi.remitr.com/api/v1/payments/send/awaiting-funds-stats \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 9307e7f58099731aa731ed3a6818807b' \
var request = require("request");

var options = { method: 'GET',
  url: 'https://dev-publicapi.remitr.com/api/v1/payments/send/awaiting-funds-stats',
  headers: 
   { 'X-Auth-Token': '9307e7f58099731aa731ed3a6818807b',
     'Content-Type': 'application/json' },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

The above command returns JSON structured like this:

{
    "status": "Success",
    "res": {
        "awaiting_fund_payments": 0,
        "awaiting_funds": "0.000000"
    }
}

Get the realtime statistics of number of payments awaiting funds and total sum of awaiting funds. On success, returns the payments awaiting funds count in "awaiting_fund_payments" and total awaiting funds amount in "awaiting_funds" .

HTTP Request

GET /v1/payments/send/awaiting-funds-stats

API Parameters

Name In Type Description Enum Default Items
X-Auth-Token header string, required Authentication token

Receive Payment

Get Payment

curl -X POST \
  https://dev-publicapi.remitr.com/api/v1/payments/request \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 9307e7f58099731aa731ed3a6818807b' \
  -d '{
  "entity_type": "INDIVIDUAL",
  "first_name": "Sandy",
  "last_name": "D'\''suza",
  "city": "Toronto",
  "postcode": "M5B2G9",
  "state_or_province": "ON",
  "date_of_birth": "1970-02-15",
  "email": "sandy@xyz.com",
  "mobile": "+17889798799",
  "address": "10 Dundas St E",
  "country": "CA",
  "account_number": "6338474",
  "routing_code_type_1": "INSTITUTION_NO",
  "routing_code_value_1": "001",
  "routing_code_type_2": "TRANSIT_CODE",
  "routing_code_value_2": "23452",
  "bank_address": "",
  "bank_name": "",
  "amount_currency": "CAD",
  "amount": 1950,
  "reason": "",
  "reference1": "",
  "reference2": ""
}'
var request = require("request");

var options = { method: 'POST',
  url: 'https://dev-publicapi.remitr.com/api/v1/payments/request',
  headers: 
   { 'X-Auth-Token': '9307e7f58099731aa731ed3a6818807b',
     'Content-Type': 'application/json' },
  body: 
   { entity_type: 'INDIVIDUAL',
     first_name: 'Sandy',
     last_name: 'D\'suza',
     city: 'Toronto',
     postcode: 'M5B2G9',
     state_or_province: 'ON',
     date_of_birth: '1970-02-15',
     email: 'sandy@xyz.com',
     mobile: '+17889798799',
     address: '10 Dundas St E',
     country: 'CA',
     account_number: '6338474',
     routing_code_type_1: 'INSTITUTION_NO',
     routing_code_value_1: '001',
     routing_code_type_2: 'TRANSIT_CODE',
     routing_code_value_2: '23452',
     bank_address: '',
     bank_name: '',
     amount_currency: 'CAD',
     amount: 1950,
     reason: '',
     reference1: '',
     reference2: '' },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

The above command returns JSON structured like this:

{
    "status": "Success",
    "res": {
        "pymnt_req_ref": "2941609b-2c1a-435c-861d-14d70b780845"
    }
}

Get a payment from payer. On success, returns payment request reference number.

HTTP Request

POST /v1/payments/request

API Parameters

Name In Type Description Enum Default Items
X-Auth-Token header string Authentication token
entity_type formData string Legal entity. INDIVIDUAL, CORPORATE
company_name formData string Required if "entity_type" is "CORPORATE".
first_name formData string Required if "beneficiary_entity_type" is "INDIVIDUAL".
middle_name formData string if "beneficiary_entity_type" is "INDIVIDUAL", Optional
last_name formData string Required if "beneficiary_entity_type" is "INDIVIDUAL".
city formData string City.
postcode formData string Postal code.
state_or_province formData string State or province.
date_of_birth formData string If "entity_type" is "CORPORATE", date of registration. If "entity_type" is "INDIVIDUAL", date of birth. ISO 8601 format YYYY-MM-DD.
identification_type formData string A legal document that verifies the identity of the entity. Required documentation will vary depending on the country in which the entity's bank account is held. NONE
DRIVERS_LICENSE
SOCIAL_SECURITY_NUMBER
GREEN_CARD
PASSPORT
VISA
MATRICULA_CONSULAR
REGISTRO_FEDERAL_DE_CONTRIBUYENTES
CLAVE_UNICA_DE_REGISTRO_DE_POBLACION
CREDENTIAL_DE_ELECTOR
SOCIAL_INSURANCE_NUMBER
CITIZENSHIP_PAPERS
DRIVERS_LICENSE_CANADIAN
EXISTING_CREDIT_CARD_DETAILS
EMPLOYER_IDENTIFICATION_NUMBER
NATIONAL_ID
INCORPORATION_NUMBER
OTHERS
identification_value formData string A unique reference code for the identification document, such as a passport number.
email formData string Email address
mobile formData string Mobile Number
address formData string First line of address.
country formData string Two-letter country code. If the entity is a COMPANY, the country in which the company is registered. If the entity is an INDIVIDUAL, a country in which the entity holds nationality.
account_number formData string Bank account number.
routing_code_type_1 formData string Local payment routing system. SORT_CODE
ABA
BSB_CODE
INSTITUTION_NO
BANK_CODE
BRANCH_CODE
CLABE
CNAPS
IFSC
routing_code_value_1 formData string Routing code for "routing_code_type_1".
routing_code_type_2 formData string Local payment routing system. SORT_CODE
ABA
BSB_CODE
INSTITUTION_NO
BANK_CODE
BRANCH_CODE
CLABE
CNAPS
TRANSIT_CODE
routing_code_value_2 formData string Routing code for "routing_code_type_2".
bic_swift formData string BIC/SWIFT code.
iban formData string IBAN code.
bank_address formData string First line of address.
bank_name formData string Bank name.
bank_account_type formData string Bank account type. CHECKINGS, SAVINGS
amount_currency formData string Currency in which payment is made. Three-char currency code.
amount formData number Amount
reason formData String User-generated reason for payment request. Freeform text.
reference1 formData String User-generated reference code.
reference2 formData String User-generated reference code.

Get Payment list

curl -X GET \
  https://dev-publicapi.remitr.com/api/v1/payments/request \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: 9307e7f58099731aa731ed3a6818807b'
var request = require("request");

var options = { method: 'GET',
  url: 'https://dev-publicapi.remitr.com/api/v1/payments/request',
  headers: 
   { 'X-Auth-Token': '9307e7f58099731aa731ed3a6818807b',
     'Content-Type': 'application/json' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

The above command returns JSON structured like this:

{
    "status": "Success",
    "res": [
        {
            "pymnt_req_ref": "2941609b-2c1a-435c-861d-14d70b780845",
            "status": "UNDER_PROCESS",
            "created_at": "2015-01-02",
            "entity_type": "INDIVIDUAL",
            "first_name": "Sandy",
            "last_name": "D'suza",
            "city": "Toronto",
            "postcode": "M5B2G9",
            "state_or_province": "ON",
            "date_of_birth": "1970-02-15",
            "email": "sandy@xyz.com",
            "mobile": "+17889798799",
            "address": "10 Dundas St E",
            "country": "CA",
            "account_number": "6338474",
            "routing_code_type_1": "INSTITUTION_NO",
            "routing_code_value_1": "001",
            "routing_code_type_2": "TRANSIT_CODE",
            "routing_code_value_2": "23452",
            "bank_address": "",
            "bank_name": "",
            "amount_currency": "CAD",
            "amount": 1950,
            "reason": "",
            "reference1": "",
            "reference2": ""
        }
    ]
}

All Get payments. On success, returns array of object/s having get payment details along with current status. If pymnt_req_ref is passed in query parameter, API will return respective payment details only.

HTTP Request

GET /v1/payments/request

API Parameters

Name In Type Description Enum
X-Auth-Token header string Authentication token
pymnt_req_ref query string Get Payment reference number generated by Remitr
reference1 query string reference1 provided while making the transaction
reference2 query string reference2 provided while making the transaction
amount query number amount of the transaction
created_at query string payment date in 'YYYY-MM-DD' format
name query string Payer name
status query string payment status COMPLETED, UNDER_PROCESS, FAILED
amount_currency query string Transaction Currency 3 char ISO code
offset query number Used for pagination, default is 0
limit query number Used for pagination, default is 20

Errors

The Remitr API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- The data requested is hidden for administrators only.
404 Not Found -- The specified resource could not be found.
405 Method Not Allowed -- You tried to access API with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
429 Too Many Requests -- You're requesting too many payments
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.