Create Sender

post

https://sandbox-api.readyremit.com/v1/senders

The POST /senders endpoint is used to register a new sender in the ReadyRemit system. This sender represents the entity initiating fund transfers. The fields required to create a sender vary based on factors such as country and sender type.

Implementation Guide:

Prerequisite: GET /sender-fields endpoint must be called before the POST /senders endpoint to retrieve the required and optional fields necessary for creating a sender record.
Data Retrieval: The fields returned by this endpoint are dynamic and may change based on the sender type and other factors. It is recommended not to cache the response and always fetch the latest field requirements.
Use the response from this endpoint to dynamically collect the necessary information from senders. Ensure that all required fields are included in the data collection process.

Body Params

senderType

string

enum

required

Defaults to PERSON

Defines the type of sender initiating the transfer. This determines the required fields and compliance checks. Possible values include: PERSON (An individual sending funds) and BUSINESS (A company or organization initiating the transfer.) Refer to the Sender Type Enum for the full list of supported values.

Allowed:

fields

array of objects

required

An array containing the sender's personal or business details. Each field represents a specific data point required for Know Your Customer (KYC) verification and compliance purposes.

The structure of each field follows the fieldValue schema, which includes the id and value of the field.
The required fields vary based on the senderType and compliance rules.

fields*

senderGroupId

uuid

Optional sender group identifier for the sender. Assigning a sender to a sender group allows segmentation of senders. When creating a new sender, if this parameter is not included, set to null or empty the sender will be added to the default sender group. When updating an existing sender, if this parameter is not included, set to null or empty the sender group of the sender will be unchanged. Example: "b3b8e7e2-9c1b-4e2b-8a7d-2e4c8e2b7c1d".

Responses

201Created. The sender record was successfully created.

400The request was invalid. This response typically occurs if required parameters are missing or invalid.

401The request requires user authentication. This response occurs if the authentication token is missing or invalid.

403The request was valid, but the server is refusing action. This response occurs if the senderId is incorrect or the user does not have permission to create the sender.