Update Sender

The PUT /senders/{senderId} endpoint updates the details of an existing sender record.

Implementation Guide:

  • Prerequisite: Ensure that the GET /sender-fields endpoint is called first to retrieve the necessary fields for updating a sender record.
  • Dynamic Fields: The fields required for updating a sender record are dynamic and may change based on the sender type and other factors. Always use the latest field requirements from the GET /sender-fields endpoint.
  • Validation: Validate the request body against the field requirements obtained from the GET /sender-fields endpoint to ensure all required fields are included and correctly formatted.

Note : The PUT /senders endpoint replaces the sender's information entirely, rather than adding to it incrementally. Therefore, all necessary fields must be included in the request. To ensure the most current information is included, it is recommended to perform a GET request before making the PUT request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier of the sender.

Body Params

Array of fields to update the sender.

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*
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

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