Show Menu

Create Beneficiary User

Create Beneficiary User Account

This is a beneficiary user account where they can send and receive all payments. A wallet is also created for them, using the currency for the country specified during create. These will be reviewed for KYC (Know Your Customer) compliance so be sure the information submitted is real and accurate. Do not create test users or emails on production servers.

post/API/v4/Register/CreateUser

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

LegalFirstNamestring

String length: inclusive between 2 and 50. This will be reviewed for KYC (Know Your Customer) compliance so be sure the information submitted is real and accurate. Do not create test companies or emails on production servers.

LegalLastNamestring

String length: inclusive between 2 and 40. This will be reviewed for KYC (Know Your Customer) compliance so be sure the information submitted is real and accurate. Do not create test companies or emails on production servers.

EmailAddressstring

String length: inclusive between 0 and 100. This will be reviewed for KYC (Know Your Customer) compliance so be sure the information submitted is real and accurate. Do not create test companies or emails on production servers.

EmailNotificationboolean

MobilePhonestring

String length: inclusive between 1 and 25

TaxIdstring

String length: inclusive between 1 and 100

DateofBirth

Daystring

Set: Value between 1 and 31

Monthstring

Set: Value between 1 and 12

Yearstring

Set: Value between 1920 and current year

AddressLine1string

String length: inclusive between 1 and 500

AddressLine2string

String length: inclusive between 1 and 500

AptSuitNumstring

String length: inclusive between 1 and 100

Citystring

String length: inclusive between 1 and 25

Countrystring

String length: inclusive between 1 and 50. This will be reviewed for KYC (Know Your Customer) compliance so be sure the information submitted is real and accurate. Do not create test companies or emails on production servers.

CountryISO2string

String length: 2

PostalCodestring

String length: inclusive between 1 and 30

Regionstring

String length: inclusive between 1 and 50

Reponse Parameters

Useridstring

Unique Identifier of the user that was created. Returned if successful.

OperationStatusstring

Always returned Indicates the status of the operation. Allowed parameters are:
Errors - Displays an error message if the Property name Obligation Definition/value operation was unsuccessful. For more information, see API Error Message Appendix.
Success—Indicates whether the operation was successful. Returns True if the action was successful or False if it was not successful.

Sample Request:

sandbox.xapi.xtrm.com/API/v4/Register/CreateUser 

{
    "CreateUser": {
        "request": {
             "IssuerAccountNumber" : "SPN Account Number",                           
            "LegalFirstName": "First Name",
            "LegalLastName": "Last Name",
            "EmailAddress": "Email ID",
            "EmailNotification" :"true/false",
            "MobilePhone": "Mobile Number",
            "TaxId": "Tax id",
            "DateOfBirth": {
                "Day": "DD",
                "Month": "MM",
                "Year": "YYYY"
            },
            "Address": {
                "AddressLine1": "Address Line 1",
                "AddressLine2": "Address Line 2",
                "AptSuitNum": "Apartment or Suit Number",
                "City": "City",
                "Country": "Country",
                "CountryISO2": "Currency Code",
                "PostalCode": "Postal Code",
                "Region": "Region/State/County"
            }
        }
    }
}

Sample Response:


{
    "CreateUserResponse": {
        "CreateUserResult": {
            "UserID": PAT12345678,
            "AccountIdentityLevel": "Pending",
            "OperationStatus": {
                "Success": true,
                "Errors": null
            }
        }
    }
}

Why

Products

Developers

How It Works

Resources

Payment and foreign exchange transactions are powered and provided by Corpay. “Corpay” is the marketing trade name for the International Payment Solutions and Risk Management Solutions provided by certain subsidiaries of FleetCor Technologies, Inc. Use of this service is governed by Corpay’s Terms and Conditions.

➤