Creating a Sender is how your backend introduces an account holder to PayMitto, and it only happens once per account holder. This guide walks through the three calls involved.

Before you begin

• Set up authentication on your backend. See Your backend's responsibilities.

What you'll do

1. Get the required Sender fields.
2. Collect the data from your account holder.
3. Create the Sender and save the senderId.

Sender records represent the entity that owns the funds for the transfer. Your backend creates a Sender for each account holder the first time they launch the transfer flow. The PayMitto SDK handles recipients and recipient accounts.

1. Get sender fields

The first step to creating a Sender in PayMitto is to determine which fields are required. Use the Get Sender Fields endpoint to retrieve that data.

The response will contain a collection of Field Sets and each Field Set will contain a collection of Fields. For more information, see the API reference document regarding Dynamic Fields. An example of a response from one of the Get Fields endpoints can be seen below:

{
    "fieldSets": [
        {
            "fieldSetId": "PERSONAL_INFORMATION",
            "fieldSetName": "Personal Information",
            "fields": [
                {
                    "fieldType": "TEXT",
                    "minLength": 1,
                    "maxLength": 50,
                    "fieldId": "FIRST_NAME",
                    "name": "First name",
                    "hintText": "Enter the recipient's first name as it appears on their ID",
                    "isRequired": true,
                    "visibility": "SHOW_AND_REQUIRED",
                    "placeholderText": "First name"
                },
                {
                    "fieldType": "TEXT",
                    "minLength": 1,
                    "maxLength": 50,
                    "fieldId": "LAST_NAME",
                    "name": "Last name",
                    "hintText": "Enter the recipient's last name as it appears on their ID",
                    "isRequired": true,
                    "visibility": "SHOW_AND_REQUIRED",
                    "placeholderText": "Last name"
                },
                {
                    "fieldType": "PHONE_NUMBER",
                    "minLength": 7,
                    "maxLength": 15,
                    "regex": "^[0-9]{7,15}$",
                    "fieldId": "PHONE_NUMBER",
                    "name": "Mobile phone number",
                    "isRequired": false,
                    "visibility": "HIDE_AND_OPTIONAL",
                    "placeholderText": "Mobile phone number"
                }
            ]
        }
    ]
}

🚧

Warning against saving or caching field requirements

The Get Fields API endpoints are provided as a helpful tool for ensuring you are always requesting the right data for users based on the type of entity and destination of the funds. We discourage saving this response and re-using it as it is unknown when requirements might change.

2. Collect data

The fields required to create a Sender with PayMitto are identical across all corridors. Most information required to create a Sender should already have been collected by your system during user onboarding. The user might need to be prompted for any additional fields.

3. Create the sender

Call the Create Sender endpoint with the field values in a "fields" array. This array should contain an entry for every "required" field returned from Get Sender Fields. If there is an error on the operation related to one of the fields, the error message will contain a "fieldId" so you can display the error at the appropriate place in your form.

When a Sender record is created successfully, you will be provided a unique senderId. This ID should be saved in your system and associated with the user who initiated the transfer.

Next steps

• Posting a transfer: submit a transfer for your new Sender.
• Your backend's responsibilities: see where this step fits.