Show Menu

Update Beneficiary User

Update Beneficiary User Account

This is to update a user's beneficiary account or digital wallet and is where they can send and receive all payments.

post/API/v4/Register/UpdateUser

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

UserIdstring

String length: inclusive between 1 and 25

LegalFirstNamestring

String length: inclusive between 2 and 50

LegalLastNamestring

String length: inclusive between 2 and 40

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

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/UpdateUser

{
    "UpdateUser": {
        "request": {
            "IssuerAccountNumber": "SPN Account Number",
            "UserId":"string",
            "LegalFirstName": "First Name",
            "LegalLastName": "Last Name",
            "EmailAddress": "Email ID",
            "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:


{
  "UpdateUserResponse": {
    "UpdateUserResult": {
      "UserID": "PAT1781888",
       "AccountIdentityLevel": "Pending",
      "OperationStatus": {
        "Success": true,
        "Errors": null
      }
    }
  }
}