Get Recipient Fields

The GET /recipient-fields endpoint retrieves the required and optional fields necessary for creating or updating a recipient record.

Implementation Guide:

• This endpoint must be called before the POST /recipients endpoint to ensure that all necessary data is collected for creating a recipient record.
• The fields returned by this endpoint are dynamic and may change based on the recipient type, destination country, destination currency, and transfer method. 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 generate forms for collecting recipient information. Ensure that all required fields are included in the form.