Skip to main content

profile

This is customer's profile details.

idstring

The customer's profile id in the system. If this is present rest all other fields are not required.

statusstring

The status of customer in the system, returned in the response.

merchantCustomerIdstring

This is the reference number for the customer created by the merchant and submitted as part of the request. It must be unique for each customer.

Note: This value is mandatory when fundingTransaction is used.

Possible values: <= 10 characters

localestringrequired

This indicates the customer's locale preference.

Note: Optional for GiroPay, Vippreferred-Direct-Registration. Not required for Paysafe Card Payouts.

Possible values: [en_US, fr_CA, en_GB, en_CA]

firstNamestringrequired

This is the customer’s first name.

Possible values: <= 80 characters

Example: Venkata Suresh
lastNamestringrequired

This is the customer’s last name.

Possible values: <= 80 characters

Example: Chagalamarri
emailstringrequired

This is the customer's email address.

Possible values: <= 255 characters

Example: paysafe@gmail.com
phonestring

This is the customer's phone number.

Note: Optional for GiroPay. Not required for Paysafe Card Payouts.

Possible values: <= 40 characters

Example: 1234567891
dateOfBirth object

This is the recipient's date of birth.

daynumberrequired

This is the day of birth.

Possible values: <= 31

Example: 6
monthnumberrequired

This is the month of birth.

Possible values: <= 12

Example: 5
yearnumberrequired

This is the year of birth.

Possible values: >= 1900

Example: 1998
mobilestring

Customer's mobile number.

Possible values: <= 40 characters

Example: 9846573804
genderstring

This field indicates the Customer's gender.

M - Male

F - Female

Possible values: [M, F]

Example: M
nationalitystring

This field indicates the Customer's nationality.

Possible values: <= 30 characters

Example: Indian
identityDocuments object[]
  • Array [
    • identityDocuments object[]required

    This is array of 2 JSON objects.

    • 1st object contains SSN
    • 2nd object contains Identity document details.
  • Array [
    • anyOf
  • ]
  • ]
    • profile
    {
      "id": "string",
      "status": "string",
      "merchantCustomerId": "string",
      "locale": "en_US",
      "firstName": "Venkata Suresh",
      "lastName": "Chagalamarri",
      "email": "paysafe@gmail.com",
      "phone": "1234567891",
      "dateOfBirth": {
        "day": 6,
        "month": 5,
        "year": 1998
      },
      "mobile": "9846573804",
      "gender": "M",
      "nationality": "Indian",
      "identityDocuments": [
        {
          "identityDocuments": [
            {
              "type": "SOCIAL_SECURITY",
              "documentNumber": "SSN123456"
            },
            {
              "type": "PASSPORT",
              "documentNumber": "1234567",
              "issuingCountry": "USA",
              "issuingCountrySubdvision": "SA",
              "expiryDate": {
                "month": 12,
                "year": 2022
              }
            }
          ]
        }
      ]
    }