Get Sender Fields

This endpoint returns the required and optional sender fields based on the specified corridor, destination country, currency, transfer method, and sender type. These fields are dynamic and may vary depending on the provided parameters. A corridor refers to a payment route between a sending and receiving country. It defines the regulations, available transfer methods, and required sender details for cross-border transactions.

Implementation Guide:

  • This endpoint must be called before the POST /senders endpoint to ensure that all necessary data is collected for creating a sender record.
  • 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. (For more information, See Dynamic fields.)
  • Use the response from this endpoint to dynamically collect the necessary information from users. Ensure that all required fields are included in the data collection process.
Query Params
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:
Responses

Language
Credentials
Bearer
JWT
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json