Overview

Before calling the Sender endpoints, there are several prerequisite endpoints that must be parsed first. The purpose is to obtain required values that will be used as input for those endpoints. These values typically consist of ID information from keys within a JSON object sent via POST, PATCH, or PUT methods, or values for path parameters used with other methods.

📌

For example, in the request body of the Create Sender endpoint (/api/v1/partner/payouts/remittances/senders/businesses), there is a key named genderId, which contains an ID value representing a gender type (e.g., 23718861-42ec-4af7-bcf1-1e0de8ff5d3f for Female).ent

Therefore, data mapping must take place before the endpoint integration is implemented. It is highly recommended that developers perform a mapping process by duplicating the relevant RemitPro master data endpoints, so that the integration process runs more efficiently — as all required master data are already stored within the Partner’s database.

The master data used for the Sender endpoints come from the Master > Transaction and Master > Area categories.

Create Sender/Update Sender

Used in the request body. The list of related master data includes:

Get Gender /api/v1/partner/master/remittance/genders

Get Nationalities /api/v1/partner/master/remittance/nationalities

Get Source of Income /api/v1/partner/master/remittance/source-of-incomes

Get Occupation /api/v1/partner/master/remittance/occupations

Get Marital Status /api/v1/partner/master/remittance/marital-statuses

Get Education /api/v1/partner/master/remittance/educations/{country_code}

Get Work Status /api/v1/partner/master/remittance/work-statuses

Get User Position /api/v1/partner/master/remittance/user-positions

Get Countries /api/v1/partner/master/general/countries

10.

Get Countries by ID /api/v1/partner/master/general/countries/{country_id}

11.

Get Phone Prefix /api/v1/partner/master/remittance/phone-prefixs

Deactivate Sender/Reactivate Sender/ Get Sender Detail/Get Sender History

Sender ID is sent through the path parameter.

Sender ID result from the 200 (Success) response of the Create Sender endpoint

/api/v1/partner/payouts/remittances/senders/businesses for Business type

/api/v1/partner/payouts/remittances/senders/personals for Personal type

Create Sender/Update Sender#

Deactivate Sender/Reactivate Sender/ Get Sender Detail/Get Sender History#

Create Sender/Update Sender

Deactivate Sender/Reactivate Sender/ Get Sender Detail/Get Sender History