Skip to main content

profile

This is customer's profile details.

    id string

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

    status string

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

    merchantCustomerId string

    Possible values: <= 10 characters

    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.

    locale stringrequired

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

    This indicates the customer's locale preference.

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

    firstName stringrequired

    Possible values: <= 80 characters

    This is the customer’s first name.

    lastName stringrequired

    Possible values: <= 80 characters

    This is the customer’s last name.

    email stringrequired

    Possible values: <= 255 characters

    This is the customer's email address.

    phone string

    Possible values: <= 40 characters

    This is the customer's phone number.

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

    dateOfBirth

    object

    This is the recipient's date of birth.

    day numberrequired

    Possible values: <= 31

    This is the day of birth.

    month numberrequired

    Possible values: <= 12

    This is the month of birth.

    year numberrequired

    Possible values: >= 1900

    This is the year of birth.

    mobile string

    Possible values: <= 40 characters

    Customer's mobile number.

    gender string

    Possible values: [M, F]

    This field indicates the Customer's gender.

    M - Male

    F - Female

    nationality string

    Possible values: <= 30 characters

    This field indicates the Customer's nationality.

    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

    type stringrequired

    Possible values: [SOCIAL_SECURITY]

    Default value: SOCIAL_SECURITY

    Value will always be "SOCIAL_SECURITY" This is part of 1st JSON object.

    documentNumber stringrequired

    Possible values: <= 9 characters

    The customer’s social security number.

  • ]

  • ]