payerInfo

Contains information about a shopper who is paying with an alternative payment method.

Request

Property Name

Type

Required

Description

address

string

Optional

Payer's address line 1.
Maximum 100 characters.

address2

string

Optional

Payer's address line 2.
Maximum 100 characters.

city

string

Optional

Payer's city.
2–42 characters.

companyName

string

Optional

Shopper's company name.
Maximum 50 characters.

Note: Required if payment type is ECP and accountType is:

  • CORPORATE_CHECKING
  • CORPORATE_SAVINGS

country

string

Required for the following requests:
Create Sofort Transaction
Otherwise, this is optional.

Payer's country code.
See Country codes.

email

string

Optional

Payer's email address.
3–100 characters.

firstName

string

Required

Payer's first name.
Maximum 100 characters.
For ACH/ECP, the limit is 25 characters.

Note: If you would like to enter a company name instead, provide it in both firstName and lastName fields, or split the name up between them if possible.

lastName

string

Required

Payer's last name.
Maximum 100 characters.
For ACH/ECP, the limit is 25 characters.

Note: If you would like to enter a company name instead, provide it in both firstName and lastName fields, or split the name up between them if possible.

merchantShopperId

string

Optional

A merchant's ID for a specific shopper.
Maximum 50 characters.

personalIdentificationNumber

string

Required for local LatAm processing in Brazil

The shopper's local personal identification number. These are the ID types per country

  • Argentina: DNI (7–11 char)
  • Brazil: CPF/CNPJ (11–14 char)
  • Chile: RUN (8–9 char)
  • Mexico: CURP/RFC (10–18 char)

phone

string

Optional

Payer's phone number.
2–36 characters.
Accepts numbers, letters, and these characters: + . * # / \ ( ) -

state

string

Optional

Payer's state code.
See State and province codes
Supports US and Canada states only. For states in other countries, you must include the state within the address property.

zip

string

Optional

Payer's ZIP code.
Maximum 20 characters.

Response

Property Name

Type

Description

address

string

Payer's address line 1.

address2

string

Payer's address line 2.

city

string

Payer's city.

country

string

Payer's country code.
See Country codes

email

string

Payer's email address.

firstName

  string  

Payer's first name.

lastName

string

Payer's last name.

personalIdentificationNumber

string

The shopper's local personal identification number.
These are the ID types per country:

  • Argentina: DNI
  • Brazil: CPF/CNPJ
  • Chile: RUN
  • Mexico: CURP/RFC

phone

string

Payer's phone number.

state

string

Payer's state code.
See State and province codes

zip

string

Payer's ZIP code.