PaymentRequestMetadata

Metadata about the request being made.

appName
string

A company-specific name for the mobile app (if any) the payment is made through. For instance, use 'MyCompany Android App' instead of 'Android App'

appVersion
string

The version of the mobile app (if any) the payment is made through. You can use any string to represent the app version. There are no format or content requirements.

required
object (BillingAddress)

An international billing address including name and phone number. A BillingAddress object for a PaymentRequestMetadata billingAddress value must exactly match address information you provide in encrypted credit card data.

cardFirst6
required
string

The first six digits of the credit card number. The first six digits are the bank identification number (BIN) for the card. Must exactly match that provided in the encrypted card data.

cardLast4
required
string

The last four digits of the credit card number. Must exactly match that provided in the encrypted card data.

object (DeliveryAddress)

A generic international delivery address including name and phone number.

guestEmail
string

The email address of the guest placing the payment.

guestIdentifier
required
string

An identifier for the guest making the payment such as an email address or phone number. Must consist of the following characters: a-z, A-Z, 0-9, =, ., -, _, +, @, :, &, ^, %, !, $

localTransactionDate
required
string <date-time>

The date and time, in ISO 8601 format, when the guest presents their credit card.

originIPAddr
required
string

The public ipv4 or ipv6 address of the cardholder making the payment. The origin IP address is essential for detecting and preventing fraud attempts in credit card authorization requests. To prevent disruption to your transaction workflow, ensure the correct origin IP address is used.

required
object (PartnerServiceInfo)

Information about the client that made the payment request. This information can be used for troubleshooting problems.

userAgent
string

For payments taken through a browser, the browser's user agent string.

{
  • "partnerServiceInfo": {
    },
  • "localTransactionDate": "2019-08-24T14:15:22Z",
  • "originIPAddr": "string",
  • "cardFirst6": "string",
  • "cardLast4": "string",
  • "billingAddress": {
    },
  • "deliveryAddress": {
    },
  • "userAgent": "string",
  • "guestIdentifier": "string",
  • "guestEmail": "string",
  • "appName": "string",
  • "appVersion": "string"
}