Customer

Saved payer details identified by the customer_id supplied by your integration. A customer can have saved payment instruments for subsequent payments.

Fields

  • customer_idstringrequired

    Identifier you supply when creating the customer. Use an ID from your own system and retain it for subsequent customer, checkout, and saved-payment-instrument requests.

    Example: "831ff8d4cd5958ab5670"

  • Personal details for the customer.

    Show 7 properties
    • First name of the customer.

      Example: "John"

    • last_namestring

      Last name of the customer.

      Example: "Doe"

    • emailstring

      Email address of the customer.

      Example: "user@example.com"

    • phonestring

      Phone number of the customer.

      Example: "+491635559723"

    • format: date

      Date of birth of the customer in YYYY-MM-DD format, without a time or timezone.

      Example: "1993-12-31"

    • tax_idstring
      maxLength: 255

      Identification number used for tax purposes, such as a CPF in Brazil.

      Example: "423.378.593-47"

    • addressobject

      Profile's personal address information.

      Show 6 properties
      • citystring

        City name from the address.

        Example: "Berlin"

      • countrystring

        Two letter country code formatted according to ISO3166-1 alpha-2.

        Example: "DE"

      • line_1string

        First line of the address with details of the street name and number.

        Example: "Sample street"

      • line_2string

        Second line of the address with details of the building, unit, apartment, and floor numbers.

        Example: "ap. 5"

      • Postal code from the address.

        Example: "10115"

      • statestring

        State name or abbreviation from the address.

        Example: "Berlin"

Type to search…