Senders

Get Sender Mandatory fields

Changed on

Returns the fields required to create a sender for a given country, sender type and currency type, together with the validation rules applied to them. Fetch it at runtime, then build your payload from the returned inputs and submit it to POST /v3/senders/individual or POST /v3/senders/business.

post/v3/senders/mandatory-fields

Request

Headers

MIDstring required

Merchant or sub-merchant MID

Request body

type'individual' | 'organization' required

Type of sender to fetch mandatory fields for. Use individual before POST /v3/senders/individual and organization before POST /v3/senders/business.

geostring

Two digit country code of the sender being created, for example ID for Indonesia. Send the same value you will send as country when creating the sender.

currencyType'fiat' | 'crypto'

Type of currency the sender will fund with. Send the same value you will send when creating the sender.

Example request

{
  "type": "individual",
  "geo": "ID",
  "currencyType": "fiat"
}

Response

OK

statusstring required
traceIdstring

Example response

{
  "data": {
    "rules": [
      {
        "type": "mutually_required"
      }
    ]
  }
}

Changes