Senders

Create Individual Sender

Changed on

Creates an individual sender and returns the userId you use for KYC and for every order they pay for. Call POST /v3/senders/mandatory-fields with type: individual first and build this body from the inputs it returns; the properties below are one corridor's fields, not a fixed list. A sender matching the details you sent returns 200 with the existing userId and code: USER_ALREADY_EXISTS.

post/v3/senders/individual

Request

Headers

MIDstring required

Merchant or sub-merchant MID

Request body

countrystring

Two digit country code of the sender. Must match the geo you sent to POST /v3/senders/mandatory-fields.

currencyType'fiat' | 'crypto'

Currency type the sender will fund with. Must match the currencyType you sent to POST /v3/senders/mandatory-fields.

firstNamestring

Dynamic field — send it only when inputs from POST /v3/senders/mandatory-fields names it for your corridor.

lastNamestring

Dynamic field — send it only when inputs from POST /v3/senders/mandatory-fields names it for your corridor.

emailstring

Email address of the sender. When supplied it is verified and an email verification message may be sent, so send a syntactically valid address.

phonestring

National phone number without the country calling code. Send it together with phoneCode when a mutually_required rule pairs them.

phoneCodestring

International dialling code for phone — digits with an optional leading +, 1-4 characters including the +.

dobstring

Date of birth, in the format the field specification's validationMessage states — DD-MM-YYYY for the corridor shown here.

Example request

{
  "country": "ID",
  "currencyType": "fiat",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "81234567890",
  "phoneCode": "+62",
  "dob": "12-12-2000"
}

Response

OK

statusstring required
traceIdstring

Changes