Skip to main content

Payment-PaymentMethod

Details about the payment method at the time of the transaction.

methodstring

Payment method type.

Enum ValueDescription
alipayAlipay
cardCard
bizumBizum
paypalPayPal
cofidisCofidis
cofidisLoanCofidis Loan
mbwayMB WAY
multibancoMultibanco
iDealiDEAL
bancontactBancontact
sofortSOFORT
trustlyTrustly
sepaSEPA
klarnaKlarna
giropayGiropay
epsEPS
blikBLIK

Possible values: [alipay, card, bizum, paypal, cofidis, cofidisLoan, mbway, multibanco, iDeal, bancontact, sofort, trustly, sepa, klarna, giropay, eps, blik]

Example: card
card object

Details about the card used as payment method at the time of the transaction.

countryCountry (string)

Two-letter country code (ISO 3166-1 alpha-2).

Example: ES
brandstring

Card brand.

Enum ValueDescription
visaVisa credit or debit card
mastercardMastercard credit or debit card
dinersDiners Club credit card
amexAmerican Express credit card
jcbJapan Credit Bureau card
unionpayUnionPay card from China
unknownCard brand could not be determined

Possible values: [visa, mastercard, diners, amex, jcb, unionpay, unknown]

Example: visa
typestring

Card type debit or credit.

Possible values: [debit, credit]

Example: credit
threeDSecureboolean

Whether this transaction used 3D Secure authentication.

Example: false
threeDSecureVersionstring

The protocol version of the 3DS challenge.

Example: 2.1.0
threeDSecureFlowstring

The flow used for 3DS authentication.

Enum ValueDescription
CHALLENGEAuthentication requiring additional shopper interaction through biometrics, 2FA, or other SCA methods
FRICTIONLESSBackground authentication using device fingerprint without additional shopper interaction
FRICTIONLESS_CHALLENGEComplete 3DS flow with additional authentication if initial data collection is insufficient
DIRECTTransaction exempt from SCA due to low risk assessment

Possible values: [CHALLENGE, FRICTIONLESS, FRICTIONLESS_CHALLENGE, DIRECT]

Example: CHALLENGE
expirationint64

Time at which the card will expire. Measured in seconds since the Unix epoch.

Example: 2048544000
last4string

The last four digits of the card.

Example: 0004
tokenizationMethodstring

The digital wallet used to tokenize the card.

Possible values: [applePay, googlePay, clickToPay]

Example: applePay
cardholderNamestring

The name of the cardholder.

Example: John Doe
cardholderEmailstring

The email of the cardholder.

Example: email@example.com
bizum object

Details about the Bizum account used as payment method at the time of the transaction.

phoneNumberstring

Phone number in E.164 format used to pay with bizum.

Example: null
paypal object

Details from Paypal order used as payment method at the time of the transaction.

orderIdstring

The Paypal's order ID.

Example: 7XP21983KL5672104
payerIdstring

The Paypal's payer ID.

Example: QWRTNBFHZXLPD
emailstring

The Paypal's payer email.

Example: john.doe@example.com
namestring

The Paypal's payer name.

Example: John Doe
cofidis object

Details from Cofidis order used as payment method at the time of the transaction.

orderIdstring

The Cofidis' order ID.

Example: null
cofidisLoan object

Details from Cofidis order used as payment method at the time of the transaction.

orderIdstring

The Cofidis' order ID.

Example: null
mbway object

Details from MBWay order used as payment method at the time of the transaction.

phoneNumberstring

Phone number in E.164 format used to pay with mbway.

Example: null
trustly object

Details from Trustly order used as payment method at the time of the transaction.

customerIdstring

The Trustly's customer ID.

Example: null
sepa object

Details from SEPA order used as payment method at the time of the transaction.

accountholderAddressstring

The address of the account holder.

Example: null
accountholderEmailstring

The email of the account holder.

Example: null
accountholderNamestring

The name of the account holder.

Example: null
countryCodestring

The country code of the account holder.

Example: null
bankAddressstring

The address of the bank.

Example: null
bankCodestring

The code of the bank.

Example: null
bankNamestring

The name of the bank.

Example: null
bicstring

The BIC of the bank.

Example: null
last4string

The last 4 digits of the IBAN.

Example: null
klarna object

Details from Klarna order used as payment method at the time of the transaction.

billingCategorystring
Enum ValueDescription
PAY_LATERPay after delivery within a specified timeframe
PAY_NOWImmediate payment at time of purchase
SLICE_ITSplit payment into installments
SLICE_IT_BY_CARDSplit payment into installments using a card

Possible values: [PAY_LATER, PAY_NOW, SLICE_IT, SLICE_IT_BY_CARD]

Example: PAY_LATER
authPaymentMethodstring
Enum ValueDescription
invoiceTraditional invoice payment
fixed_amountPayment with a predetermined fixed amount
pixBrazilian instant payment system
base_accountPayment from a basic account
deferred_interestPayment with delayed interest charges
direct_debitDirect bank account debit
direct_bank_transferImmediate bank transfer
b2b_invoiceBusiness-to-business invoice payment
cardCredit or debit card payment
slice_it_by_cardInstallment payment using a card

Possible values: [invoice, fixed_amount, pix, base_account, deferred_interest, direct_debit, direct_bank_transfer, b2b_invoice, card, slice_it_by_card]

Example: card
Payment-PaymentMethod
{
"method": "card",
"card": {
"country": "ES",
"brand": "visa",
"type": "credit",
"threeDSecure": false,
"threeDSecureVersion": "2.1.0",
"threeDSecureFlow": "CHALLENGE",
"expiration": 2048544000,
"last4": "0004",
"tokenizationMethod": "applePay",
"cardholderName": "John Doe",
"cardholderEmail": "email@example.com"
},
"bizum": {
"phoneNumber": null
},
"paypal": {
"orderId": "7XP21983KL5672104",
"payerId": "QWRTNBFHZXLPD",
"email": "john.doe@example.com",
"name": "John Doe"
},
"cofidis": {
"orderId": null
},
"cofidisLoan": {
"orderId": null
},
"mbway": {
"phoneNumber": null
},
"trustly": {
"customerId": null
},
"sepa": {
"accountholderAddress": null,
"accountholderEmail": null,
"accountholderName": null,
"countryCode": null,
"bankAddress": null,
"bankCode": null,
"bankName": null,
"bic": null,
"last4": null
},
"klarna": {
"billingCategory": "PAY_LATER",
"authPaymentMethod": "card"
}
}