API Reference
Contact Us

Create a new remittance recipient

post
https://example.com/entities//recipients
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
required
length ≥ 1

First name of the recipient

string

Middle name of the recipient

string
required
length ≥ 1

Last name of the recipient

string

Second last name of the recipient

string

Recipient's phone number

string

Recipient's mobile phone number

string

Mobile phone operator

string
enum

Country of the mobile phone number

string

Recipient's email address

date

Date of birth of the recipient

string
enum

Country of birth of the recipient

address
object
required
document
object

Recipient's identity document

string
enum

Relationships of the recipient

string

Recipient Entity Id Owner

Headers
string

Header parameter to uniquely identifies the request. Must be supplied as an UUID.

string
length ≤ 256

String containing the channel used to originate the request. For example USSD, Web, App.

uri

URL supplied by the client that will be used to return the callback in the form of an HTTP PUT.

string

It is used to send the pre-shared client API key to the server.

string
required

It is used to send the user’s access token when OAuth 2.0/OIDC authorization framework is used for end-user authentication.

Responses

Updated 7 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago