@datafire/adyen_checkoutservice
v4.0.0
Published
DataFire integration for Adyen Checkout API
Downloads
2
Readme
@datafire/adyen_checkoutservice
Client library for Adyen Checkout API
Installation and Usage
npm install --save @datafire/adyen_checkoutservice
let adyen_checkoutservice = require('@datafire/adyen_checkoutservice').create({
ApiKeyAuth: "",
username: "",
password: ""
});
.then(data => {
console.log(data);
});
Description
Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).
This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit Checkout documentation.
Authentication
Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in How to get the API key. Then set this key to the X-API-Key
header value, for example:
curl
-H "Content-Type: application/json" \
-H "X-API-Key: Your_Checkout_API_key" \
...
Note that when going live, you need to generate a new API Key to access the live endpoints.
Versioning
Checkout API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.
For example:
https://checkout-test.adyen.com/v64/payments
Actions
orders.post
Creates an order to be used for partial payments. Make a POST /orders
call before making a /payments
call when processing payments with different payment methods.
adyen_checkoutservice.orders.post({}, context)
Input
- input
object
Output
- output CheckoutCreateOrderResponse
orders.cancel.post
Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.
adyen_checkoutservice.orders.cancel.post({}, context)
Input
- input
object
Output
- output CheckoutCancelOrderResponse
originKeys.post
This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains.
Instead of using an origin key, consider switching to a client key for your Web Drop-in or Web Component integration. This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form.
adyen_checkoutservice.originKeys.post({}, context)
Input
- input
object
Output
- output CheckoutUtilityResponse
paymentLinks.post
Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the currency
and country
parameters sent in the request.
For more information, refer to Pay by Link documentation.
adyen_checkoutservice.paymentLinks.post({}, context)
Input
- input
object
Output
- output PaymentLinkResource
paymentLinks.linkId.get
Retrieves the payment link details using the payment link id
.
adyen_checkoutservice.paymentLinks.linkId.get({
"linkId": ""
}, context)
Input
- input
object
- linkId required
string
: Unique identifier of the payment link.
- linkId required
Output
- output PaymentLinkResource
paymentLinks.linkId.patch
Updates the status of a payment link. Use this endpoint to force the expiry of a payment link.
adyen_checkoutservice.paymentLinks.linkId.patch({
"linkId": ""
}, context)
Input
- input
object
- linkId required
string
: Unique identifier of the payment link. - body UpdatePaymentLinkRequest
- linkId required
Output
- output PaymentLinkResource
paymentMethods.post
Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to /payments
).
Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the /paymentMethods
response and update it once a week.
adyen_checkoutservice.paymentMethods.post({}, context)
Input
- input
object
Output
- output PaymentMethodsResponse
paymentMethods.balance.post
Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST /paymentMethods/balance
call and include the gift card's details inside a paymentMethod
object.
adyen_checkoutservice.paymentMethods.balance.post({}, context)
Input
- input
object
Output
- output CheckoutBalanceCheckResponse
paymentSession.post
Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.
For more information, refer to How it works.
adyen_checkoutservice.paymentSession.post({}, context)
Input
- input
object
- body PaymentSetupRequest
Output
- output PaymentSetupResponse
payments.post
Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our payment method guides. The response returns the result of the payment request:
- For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the
resultCode
(e.g. Authorised or Refused). - For other payment methods, you'll receive RedirectShopper as
resultCode
together with aredirectUrl
. In this case, the shopper must finalize the payment on the page behind theredirectUrl
.
adyen_checkoutservice.payments.post({}, context)
Input
- input
object
- body PaymentRequest
Output
- output PaymentResponse
payments.details.post
Submits details for a payment created using /payments
. This step is only needed when no final state has been reached on the /payments
request (for example for 3D Secure, or when getting redirected back directly from a payment method using an app switch).
The exact details, which need to be sent to this endpoint, are always specified in the response of the associated /payments
request.
In addition, the endpoint can be used to verify a payload
, which is returned after coming back from the Checkout SDK or any of the redirect based methods on the Checkout API.
adyen_checkoutservice.payments.details.post({}, context)
Input
- input
object
- body DetailsRequest
Output
- output PaymentResponse
payments.result.post
Verifies the payment result using the payload returned from the Checkout SDK.
For more information, refer to How it works.
adyen_checkoutservice.payments.result.post({}, context)
Input
- input
object
Output
- output PaymentVerificationResponse
Definitions
AccountInfo
- AccountInfo
object
- accountAgeIndicator
string
(values: notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days): Indicator for the length of time since this shopper account was created in the merchant's environment. - accountChangeDate
string
: Date when the shopper's account was last changed. - accountChangeIndicator
string
(values: thisTransaction, lessThan30Days, from30To60Days, moreThan60Days): Indicator for the length of time since the shopper's account was last updated. - accountCreationDate
string
: Date when the shopper's account was created. - accountType
string
(values: notApplicable, credit, debit): Indicates the type of account. For example, for a multi-account card product. - addCardAttemptsDay
integer
: Number of attempts the shopper tried to add a card to their account in the last day. - deliveryAddressUsageDate
string
: Date the selected delivery address was first used. - deliveryAddressUsageIndicator
string
(values: thisTransaction, lessThan30Days, from30To60Days, moreThan60Days): Indicator for the length of time since this delivery address was first used. - homePhone
string
: Shopper's home phone number (including the country code). - mobilePhone
string
: Shopper's mobile phone number (including the country code). - passwordChangeDate
string
: Date when the shopper last changed their password. - passwordChangeIndicator
string
(values: notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days): Indicator when the shopper has changed their password. - pastTransactionsDay
integer
: Number of all transactions (successful and abandoned) from this shopper in the past 24 hours. - pastTransactionsYear
integer
: Number of all transactions (successful and abandoned) from this shopper in the past year. - paymentAccountAge
string
: Date this payment method was added to the shopper's account. - paymentAccountIndicator
string
(values: notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days): Indicator for the length of time since this payment method was added to this shopper's account. - purchasesLast6Months
integer
: Number of successful purchases in the last six months. - suspiciousActivity
boolean
: Whether suspicious activity was recorded on this account. - workPhone
string
: Shopper's work phone number (including the country code).
- accountAgeIndicator
AchDetails
- AchDetails
object
- bankAccountNumber required
string
: The bank account number (without separators). - bankLocationId
string
: The bank routing number of the account. The field value isnil
in most cases. - encryptedBankAccountNumber
string
: Encrypted bank account number. The bank account number (without separators). - encryptedBankLocationId
string
: Encrypted location id. The bank routing number of the account. The field value isnil
in most cases. - ownerName
string
: The name of the bank account holder. - storedPaymentMethodId
string
: This is therecurringDetailReference
returned in the response when you created the token. - type required
string
: ach
- bankAccountNumber required
AdditionalData3DSecure
- AdditionalData3DSecure
object
- allow3DS2
string
: This parameter indicates that you are able to process 3D Secure 2 transactions natively on your payment page. Send this field when you are using/payments
endpoint with any of our native 3D Secure 2 solutions, such as Components or Drop-in. Possible values: - executeThreeD
string
: This parameter indicates if you want to perform 3D Secure authentication on a transaction or not. Allowed values: - mpiImplementationType
string
: In case of Secure+, this field must be set to CUPSecurePlus. - scaExemption
string
: Indicates the exemption type that you want to request for the transaction. Possible values:
- allow3DS2
AdditionalDataAirline
- AdditionalDataAirline
object
- airline.agency_invoice_number
string
: Reference number for the invoice, issued by the agency. - airline.agency_plan_name
string
: 2-letter agency plan identifier; alphabetical. - airline.airline_code
string
: IATA 3-digit accounting code (PAX); numeric. It identifies the carrier. - airline.airline_designator_code
string
: IATA 2-letter accounting code (PAX); alphabetical. It identifies the carrier. - airline.boarding_fee
string
: Chargeable amount for boarding the plane. - airline.computerized_reservation_system
string
: The CRS used to make the reservation and purchase the ticket. - airline.customer_reference_number
string
: Reference number; alphanumeric. - airline.document_type
string
: Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements. - airline.flight_date
string
: Flight departure date. Local time(HH:mm)
is optional. - airline.leg.carrier_code
string
: IATA 2-letter accounting code (PAX); alphabetical. It identifies the carrier. - airline.leg.class_of_travel
string
: 1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently: - airline.leg.date_of_travel
string
: - airline.leg.depart_airport
string
: Alphabetical identifier of the departure airport. - airline.leg.depart_tax
string
: Departure tax. Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the following table. - airline.leg.destination_code
string
: Alphabetical identifier of the destination/arrival airport. - airline.leg.fare_base_code
string
: Fare basis code; alphanumeric. - airline.leg.flight_number
string
: The flight identifier. - airline.leg.stop_over_code
string
: 1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed: - airline.passenger.date_of_birth
string
: Date of birth of the passenger. - airline.passenger.first_name
string
: Passenger first name/given name. - airline.passenger.last_name
string
: Passenger last name/family name. - airline.passenger.telephone_number
string
: Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs. - airline.passenger.traveller_type
string
: Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS. - airline.passenger_name required
string
: Passenger name, initials, and a title. - airline.ticket_issue_address
string
: Address of the place/agency that issued the ticket. - airline.ticket_number
string
: The ticket's unique identifier. - airline.travel_agency_code
string
: IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies. - airline.travel_agency_name
string
: The name of the travel agency.
- airline.agency_invoice_number
AdditionalDataCarRental
- AdditionalDataCarRental
object
- carRental.checkOutDate
string
: Pick-up date. - carRental.customerServiceTollFreeNumber
string
: The customer service phone number of the car rental company. - carRental.daysRented
string
: Number of days for which the car is being rented. - carRental.fuelCharges
string
: Any fuel charges associated with the rental. - carRental.insuranceCharges
string
: Any insurance charges associated with the rental. - carRental.locationCity
string
: The city from which the car is rented. - carRental.locationCountry
string
: The country from which the car is rented. - carRental.locationStateProvince
string
: The state or province from where the car is rented. - carRental.noShowIndicator
string
: Indicates if the customer was a "no-show" (neither keeps nor cancels their booking). - carRental.oneWayDropOffCharges
string
: Charge associated with not returning a vehicle to the original rental location. - carRental.rate
string
: Daily rental rate. - carRental.rateIndicator
string
: Specifies whether the given rate is applied daily or weekly. - carRental.rentalAgreementNumber
string
: The rental agreement number associated with this car rental. - carRental.rentalClassId
string
: Daily rental rate. - carRental.renterName
string
: The name of the person renting the car. - carRental.returnCity
string
: The city where the car must be returned. - carRental.returnCountry
string
: The country where the car must be returned. - carRental.returnDate
string
: The last date to return the car by. - carRental.returnLocationId
string
: Agency code, phone number, or address abbreviation - carRental.returnStateProvince
string
: The state or province where the car must be returned. - carRental.taxExemptIndicator
string
: Indicates whether the goods or services were tax-exempt, or tax was not collected. - travelEntertainmentAuthData.duration
string
: Number of nights. This should be included in the auth message. - travelEntertainmentAuthData.market
string
: Indicates what market-specific dataset will be submitted or is being submitted. Value should be "A" for Car rental. This should be included in the auth message.
- carRental.checkOutDate
AdditionalDataCommon
- AdditionalDataCommon
object
- RequestedTestErrorResponseCode
string
: Triggers test scenarios that allow to replicate certain communication errors. - authorisationType
string
: Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to Authorisation types. - customRoutingFlag
string
: Allows you to determine or override the acquirer account that should be used for the transaction. - networkTxReference
string
: Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. - overwriteBrand
string
: Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use theselectedBrand
value to specify how to process the transaction. - subMerchantCity
string
: This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address. - subMerchantCountry
string
: This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address. - subMerchantID
string
: This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID. - subMerchantName
string
: This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant. - subMerchantPostalCode
string
: This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address. - subMerchantState
string
: This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address. - subMerchantStreet
string
: This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address. - subMerchantTaxId
string
: This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.
- RequestedTestErrorResponseCode
AdditionalDataLevel23
- AdditionalDataLevel23
object
- enhancedSchemeData.customerReference
string
: Customer code, if supplied by a customer. - enhancedSchemeData.destinationCountryCode
string
: Destination country code. - enhancedSchemeData.destinationPostalCode
string
: The postal code of a destination address. - enhancedSchemeData.destinationStateProvinceCode
string
: Destination state or province code. - enhancedSchemeData.dutyAmount
string
: Duty amount, in minor units. - enhancedSchemeData.freightAmount
string
: Shipping amount, in minor units. - enhancedSchemeData.itemDetailLine[itemNr].commodityCode
string
: Item commodity code. - enhancedSchemeData.itemDetailLine[itemNr].description
string
: Item description. - enhancedSchemeData.itemDetailLine[itemNr].discountAmount
string
: Discount amount, in minor units. - enhancedSchemeData.itemDetailLine[itemNr].productCode
string
: Product code. - enhancedSchemeData.itemDetailLine[itemNr].quantity
string
: Quantity, specified as an integer value. - enhancedSchemeData.itemDetailLine[itemNr].totalAmount
string
: Total amount, in minor units. - enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure
string
: Item unit of measurement. - enhancedSchemeData.itemDetailLine[itemNr].unitPrice
string
: Unit price, specified in minor units. - enhancedSchemeData.orderDate
string
: Order date. - enhancedSchemeData.shipFromPostalCode
string
: The postal code of a "ship-from" address. - enhancedSchemeData.totalTaxAmount
string
: Total tax amount, in minor units.
- enhancedSchemeData.customerReference
AdditionalDataLodging
- AdditionalDataLodging
object
- lodging.checkInDate
string
: The arrival date. - lodging.checkOutDate
string
: The departure date. - lodging.customerServiceTollFreeNumber
string
: The toll free phone number for the hotel/lodgings. - lodging.fireSafetyActIndicator
string
: Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'. - lodging.folioCashAdvances
string
: The folio cash advances. - lodging.folioNumber
string
: Card acceptor’s internal invoice or billing ID reference number. - lodging.foodBeverageCharges
string
: Any charges for food and beverages associated with the booking. - lodging.noShowIndicator
string
: Indicates if the customer was a "no-show" (neither keeps nor cancels their booking). - lodging.prepaidExpenses
string
: Prepaid expenses for the booking. - lodging.propertyPhoneNumber
string
: Identifies specific lodging property location by its local phone number. - lodging.room1.numberOfNights
string
: Total number of nights the room will be rented. - lodging.room1.rate
string
: The rate of the room. - lodging.room1.tax
string
: The total amount of tax to be paid. - lodging.totalRoomTax
string
: Total room tax amount. - lodging.totalTax
string
: Total tax amount. - travelEntertainmentAuthData.duration
string
: Number of nights. This should be included in the auth message. - travelEntertainmentAuthData.market
string
: Indicates what market-specific dataset will be submitted or is being submitted. Value should be "H" for Hotel. This should be included in the auth message.
- lodging.checkInDate
AdditionalDataOpenInvoice
- AdditionalDataOpenInvoice
object
- openinvoicedata.merchantData
string
: Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string. - openinvoicedata.numberOfLines
string
: The number of invoice lines included inopeninvoicedata
. - openinvoicedataLine[itemNr].currencyCode
string
: The three-character ISO currency code. - openinvoicedataLine[itemNr].description
string
: A text description of the product the invoice line refers to. - openinvoicedataLine[itemNr].itemAmount
string
: The price for one item in the invoice line, represented in minor units. - openinvoicedataLine[itemNr].itemId
string
: A unique id for this item. Required for RatePay if the description of each item is not unique. - openinvoicedataLine[itemNr].itemVatAmount
string
: The VAT due for one item in the invoice line, represented in minor units. - openinvoicedataLine[itemNr].itemVatPercentage
string
: The VAT percentage for one item in the invoice line, represented in minor units. - openinvoicedataLine[itemNr].numberOfItems
string
: The number of units purchased of a specific product. - openinvoicedataLine[itemNr].vatCategory
string
: Required for AfterPay. The country-specific VAT category a product falls under.
- openinvoicedata.merchantData
AdditionalDataOpi
- AdditionalDataOpi
object
- opi.includeTransToken
string
: Optional boolean indicator. Set to true if you want an ecommerce transaction to return anopi.transToken
as additional data in the response.
- opi.includeTransToken
AdditionalDataRatepay
- AdditionalDataRatepay
object
- ratepay.installmentAmount
string
: Amount the customer has to pay each month. - ratepay.interestRate
string
: Interest rate of this installment. - ratepay.lastInstallmentAmount
string
: Amount of the last installment. - ratepay.paymentFirstday
string
: Calendar day of the first payment. - ratepaydata.deliveryDate
string
: Date the merchant delivered the goods to the customer. - ratepaydata.dueDate
string
: Date by which the customer must settle the payment. - ratepaydata.invoiceDate
string
: Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date. - ratepaydata.invoiceId
string
: Identification name or number for the invoice, defined by the merchant.
- ratepay.installmentAmount
AdditionalDataRetry
- AdditionalDataRetry
object
- retry.chainAttemptNumber
string
: The number of times the transaction (not order) has been retried between different payment service providers. For instance, thechainAttemptNumber
set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen. - retry.orderAttemptNumber
string
: The index of the attempt to bill a particular order, which is identified by themerchantOrderReference
field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively. - retry.skipRetry
string
: The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.
- retry.chainAttemptNumber
AdditionalDataRisk
- AdditionalDataRisk
object
- riskdata.[customFieldName]
string
: The data for your custom risk field. For more information, refer to Create custom risk fields. - riskdata.basket.item[itemNr].amountPerItem
string
: The price of item in the basket, represented in minor units. - riskdata.basket.item[itemNr].brand
string
: Brand of the item. - riskdata.basket.item[itemNr].category
string
: Category of the item. - riskdata.basket.item[itemNr].color
string
: Color of the item. - riskdata.basket.item[itemNr].currency
string
: The three-character ISO currency code. - riskdata.basket.item[itemNr].itemID
string
: ID of the item. - riskdata.basket.item[itemNr].manufacturer
string
: Manufacturer of the item. - riskdata.basket.item[itemNr].productTitle
string
: A text description of the product the invoice line refers to. - riskdata.basket.item[itemNr].quantity
string
: Quantity of the item purchased. - riskdata.basket.item[itemNr].receiverEmail
string
: Email associated with the given product in the basket (usually in electronic gift cards). - riskdata.basket.item[itemNr].size
string
: Size of the item. - riskdata.basket.item[itemNr].sku
string
: Stock keeping unit. - riskdata.basket.item[itemNr].upc
string
: Universal Product Code. - riskdata.promotions.promotion[itemNr].promotionCode
string
: Code of the promotion. - riskdata.promotions.promotion[itemNr].promotionDiscountAmount
string
: The discount amount of the promotion, represented in minor units. - riskdata.promotions.promotion[itemNr].promotionDiscountCurrency
string
: The three-character ISO currency code. - riskdata.promotions.promotion[itemNr].promotionDiscountPercentage
string
: Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign. - riskdata.promotions.promotion[itemNr].promotionName
string
: Name of the promotion.
- riskdata.[customFieldName]
AdditionalDataRiskStandalone
- AdditionalDataRiskStandalone
object
- PayPal.CountryCode
string
: Shopper's country of residence in the form of ISO standard 3166 2-character country codes. - PayPal.EmailId
string
: Shopper's email. - PayPal.FirstName
string
: Shopper's first name. - PayPal.LastName
string
: Shopper's last name. - PayPal.PayerId
string
: Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters. - PayPal.Phone
string
: Shopper's phone number. - PayPal.ProtectionEligibility
string
: Allowed values: - PayPal.TransactionId
string
: Unique transaction ID of the payment. - avsResultRaw
string
: Raw AVS result received from the acquirer, where available. Example: D - bin
string
: The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for tokenized card request. - cvcResultRaw
string
: Raw CVC result received from the acquirer, where available. Example: 1 - riskToken
string
: Unique identifier or token for the shopper's card details. - threeDAuthenticated
string
: A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true - threeDOffered
string
: A Boolean value indicating whether 3DS was offered for this payment. Example: true - tokenDataType
string
: Required for PayPal payments only. The only supported value is: paypal.
- PayPal.CountryCode
AdditionalDataTemporaryServices
- AdditionalDataTemporaryServices
object
- enhancedSchemeData.customerReference
string
: Customer code, if supplied by a customer. - enhancedSchemeData.employeeName
string
: Name or ID associated with the individual working in a temporary capacity. - enhancedSchemeData.jobDescription
string
: Description of the job or task of the individual working in a temporary capacity. - enhancedSchemeData.regularHoursRate
string
: Amount paid per regular hours worked, minor units. - enhancedSchemeData.regularHoursWorked
string
: Amount of time worked during a normal operation for the task or job. - enhancedSchemeData.requestName
string
: Name of the individual requesting temporary services. - enhancedSchemeData.tempStartDate
string
: Date for the beginning of the pay period. - enhancedSchemeData.tempWeekEnding
string
: Date of the end of the billing cycle. - enhancedSchemeData.totalTaxAmount
string
: Total tax amount, in minor units. For example, 2000 means USD 20.00
- enhancedSchemeData.customerReference
AdditionalDataWallets
- AdditionalDataWallets
object
- androidpay.token
string
: The Android Pay token retrieved from the SDK. - masterpass.transactionId
string
: The Mastercard Masterpass Transaction ID retrieved from the SDK. - payment.token
string
: The Apple Pay token retrieved from the SDK. - paywithgoogle.token
string
: The Google Pay token retrieved from the SDK. - samsungpay.token
string
: The Samsung Pay token retrieved from the SDK. - visacheckout.callId
string
: The Visa Checkout Call ID retrieved from the SDK.
- androidpay.token
Address
- Address
object
- city required
string
: The name of the city. - country required
string
: The two-character country code as defined in ISO-3166-1 alpha-2. For example, US. - houseNumberOrName required
string
: The number or name of the house. - postalCode required
string
: A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. - stateOrProvince
string
: State or province codes as defined in ISO 3166-2. For example, CA in the US or ON in Canada. - street required
string
: The name of the street.
- city required
AmazonPayDetails
- AmazonPayDetails
object
- amazonPayToken
string
- checkoutSessionId
string
- type required
string
: amazonpay
- amazonPayToken
Amount
- Amount
object
- currency required
string
: The three-character ISO currency code. - value required
integer
: The amount of the transaction, in minor units.
- currency required
AndroidPayDetails
- AndroidPayDetails
object
- androidPayToken required
string
- type required
string
: androidpay
- androidPayToken required
ApplePayDetails
- ApplePayDetails
object
- applePayToken required
string
- fundingSource
string
(values: credit, debit) - storedPaymentMethodId
string
: This is therecurringDetailReference
returned in the response when you created the token. - type required
string
: applepay
- applePayToken required
ApplicationInfo
- ApplicationInfo
object
- adyenLibrary CommonField
- adyenPaymentSource CommonField
- externalPlatform ExternalPlatform
- merchantApplication CommonField
- merchantDevice MerchantDevice
- shopperInteractionDevice ShopperInteractionDevice
Avs
- Avs
object
- addressEditable
boolean
: Indicates whether the shopper is allowed to modify the billing address for the current payment request. - enabled
string
(values: yes, no, automatic): Specifies whether the shopper should enter their billing address during checkout.
- addressEditable
BankAccount
- BankAccount
object
- bankAccountNumber
string
: The bank account number (without separators). - bankCity
string
: The bank city. - bankLocationId
string
: The location id of the bank. The field value isnil
in most cases. - bankName
string
: The name of the bank. - bic
string
: The Business Identifier Code (BIC) is the SWIFT address assigned to a bank. The field value isnil
in most cases. - countryCode
string
: Country code where the bank is located. - iban
string
: The International Bank Account Number (IBAN). - ownerName
string
: The name of the bank account holder. - taxId
string
: The bank account holder's tax ID.
- bankAccountNumber
BillDeskOnlineDetails
- BillDeskOnlineDetails
object
- issuer required
string
: The issuer id of the shopper's selected bank. - type required
string
: billdesk_online
- issuer required
BillDeskWalletDetails
- BillDeskWalletDetails
object
- issuer required
string
: The issuer id of the shopper's selected bank. - type required
string
: billdesk_wallet
- issuer required
BlikDetails
- BlikDetails
object
- blikCode
string
: BLIK code consisting of 6 digits. - type required
string
: blik
- blikCode
BrowserInfo
- BrowserInfo
object
- acceptHeader required
string
: The accept header value of the shopper's browser. - colorDepth required
integer
: The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser'sscreen.colorDepth
property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth. - javaEnabled required
boolean
: Boolean value indicating if the shopper's browser is able to execute Java. - javaScriptEnabled
boolean
: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. - language required
string
: Thenavigator.language
value of the shopper's browser (as defined in IETF BCP 47). - screenHeight required
integer
: The total height of the shopper's device screen in pixels. - screenWidth required
integer
: The total width of the shopper's device screen in pixels. - timeZoneOffset required
integer
: Time difference between UTC time and the shopper's browser local time, in minutes. - userAgent required
string
: The user agent value of the shopper's browser.
- acceptHeader required
Card
- Card
object
- cvc
string
: The card verification code (1-20 characters). Depending on the card brand, it is known also as: - expiryMonth required
string
: The card expiry month. - expiryYear required
string
: The card expiry year. - holderName required
string
: The name of the cardholder, as printed on the card. - issueNumber
string
: The issue number of the card (for some UK debit cards only). - number required
string
: The card number (4-19 characters). Do not use any separators. - startMonth
string
: The month component of the start date (for some UK debit cards only). - startYear
string
: The year component of the start date (for some UK debit cards only).
- cvc
CardDetails
- CardDetails
object
- cupsecureplus.smscode
string
- cvc
string
- encryptedCardNumber required
string
- encryptedExpiryMonth required
string
- encryptedExpiryYear required
string
- expiryMonth
string
- expiryYear
string
- fundingSource
string
(values: credit, debit) - holderName
string
- number
string
- storedPaymentMethodId
string
: This is therecurringDetailReference
returned in the response when you created the token. - type required
string
: scheme
- cupsecureplus.smscode
CheckoutAwaitAction
- CheckoutAwaitAction
object
- paymentData
string
: When non-empty, contains a value that you must submit to the/payments/details
endpoint. In some cases, required for polling. - paymentMethodType
string
: Specifies the payment method. - url
string
: Specifies the URL to redirect to.
- paymentData
CheckoutBalanceCheckRequest
- CheckoutBalanceCheckRequest
object
- accountInfo AccountInfo
- additionalAmount Amount
- amount required Amount
- applicationInfo ApplicationInfo
- billingAddress Address
- browserInfo BrowserInfo
- captureDelayHours
integer
: The delay between the authorisation and scheduled auto-capture, specified in hours. - dateOfBirth
string
: The shopper's date of birth. - dccQuote ForexQuote
- deliveryAddress Address
- deliveryDate
string
: The date and time the purchased goods should be delivered. - deviceFingerprint
string
: A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting. - enableRealTimeUpdate
boolean
: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. - fraudOffset
integer
: An integer value that is added to the normal fraud score. The value can be either positive or negative. - installments Installments
- mcc
string
: The merchant category code (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. - merchantAccount required
string
: The merchant account identifier, with which you want to process the transaction. - merchantOrderReference
string
: This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. - merchantRiskIndicator MerchantRiskIndicator
- metadata
object
: Metadata consists of entries, each of which includes a key and a value. - orderReference
string
: When you are doing multiple partial (gift card) payments, this is thepspReference
of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use themerchantOrderReference
instead. - paymentMethod required
object
: The collection that contains the type of the payment method and its specific information. - recurring Recurring
- recurringProcessingModel
string
(values: CardOnFile, Subscription, UnscheduledCardOnFile): Defines a recurring payment type. - reference required
string
: The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. - selectedBrand
string
: Some payment methods require defining a value for this field to specify how to process the transaction. - selectedRecurringDetailReference
string
: TherecurringDetailReference
you want to use for this payment. The valueLATEST
can be used to select the most recently stored recurring detail. - sessionId
string
: A session ID used to identify a payment session. - shopperEmail
string
: The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. - shopperIP
string
: The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). - shopperInteraction
string
(values: Ecommerce, ContAuth, Moto, POS): Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. - shopperLocale
string
: The combination of a language code and a country code to specify the language to be used in the payment. - shopperName Name
- shopperReference
string
: The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). - shopperStatement
string
: The text to be shown on the shopper's bank statement. To enable this field, contact our Support Team. - socialSecurityNumber
string
: The shopper's social security number. - splits
array
: Information on how the payment should be split between accounts when using Adyen for Platforms.- items Split
- store
string
: The physical store, for which this payment is processed. - telephoneNumber
string
: The shopper's telephone number. - threeDS2RequestData ThreeDS2RequestData
- threeDSAuthenticationOnly
boolean
: If set to true, you will only perform the 3D Secure 2 authentication, and not the payment authorisation. - totalsGroup
string
: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). - trustedShopper
boolean
: Set to true if the payment should be routed to a trusted MID.
CheckoutBalanceCheckResponse
- CheckoutBalanceCheckResponse
object
- balance required Amount
- fraudResult FraudResult
- pspReference
string
: Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. - refusalReason
string
: If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includesresultCode
andrefusalReason
values. - resultCode
string
(values: AuthenticationFinished, Authorised, Cancelled, ChallengeShopper, Error, IdentifyShopper, Pending, PresentToShopper, Received, RedirectShopper, Refused): The result of the payment. For more information, see Result codes.
CheckoutCancelOrderRequest
- CheckoutCancelOrderRequest
object
- merchantAccount required
string
: The merchant account identifier that orderData belongs to. - order required CheckoutOrder
- merchantAccount required
CheckoutCancelOrderResponse
- CheckoutCancelOrderResponse
object
- pspReference required
string
: A unique reference of the cancellation request. - resultCode required
string
: The result of the cancellation request.
- pspReference required
CheckoutCreateOrderRequest
- CheckoutCreateOrderRequest
object
- amount required Amount
- expiresAt
string
: The date that order expires; e.g. 2019-03-23T12:25:28Z. If not provided, the default expiry duration is 1 day. - merchantAccount required
string
: The merchant account identifier, with which you want to process the order. - reference
string
: A custom reference identifying the order.
CheckoutCreateOrderResponse
- CheckoutCreateOrderResponse
object
- expiresAt required
string
: The date that the order will expire. - fraudResult FraudResult
- orderData required
string
: The encrypted data that will be used by merchant for adding payments to the order. - pspReference
string
: Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. - refusalReason
string
: If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includesresultCode
andrefusalReason
values. - remainingAmount required Amount
- resultCode
string
(values: AuthenticationFinished, Authorised, Cancelled, ChallengeShopper, Error, IdentifyShopper, Pending, PresentToShopper, Received, RedirectShopper, Refused): The result of the payment. For more information, see Result codes.
- expiresAt required
CheckoutDonationAction
- CheckoutDonationAction
object
- paymentData
string
: When non-empty, contains a value that you must submit to the/payments/details
endpoint. In some cases, required for polling. - paymentMethodType
string
: Specifies the payment method. - url
string
: Specifies the URL to redirect to.
- paymentData
CheckoutOneTimePasscodeAction
- CheckoutOneTimePasscodeAction
object
- paymentData
string
: When non-empty, contains a value that you must submit to the/payments/details
endpoint. In some cases, required for polling. - paymentMethodType
string
: Specifies the payment method. - redirect Redirect
- resendInterval
integer
: The interval in second between OTP resend. - resendMaxAttempts
integer
: The maximum number of OTP resend attempts. - resendUrl
string
: The URL, to which you make POST request to trigger OTP resend. - url
string
: Specifies the URL to redirect to.
- paymentData
CheckoutOrder
- CheckoutOrder
object
- orderData required
string
: The encrypted order data. - pspReference required
string
: ThepspReference
that belongs to the order.
- orderData required
CheckoutOrderResponse
- CheckoutOrderResponse
object
- expiresAt
string
: The expiry date for the order. - orderData
string
: The encrypted order data. - pspReference required
string
: ThepspReference
that belongs to the order. - reference
string
: The merchant reference for the order. - remainingAmount Amount
- expiresAt
CheckoutQrCodeAction
- CheckoutQrCodeAction
object
- paymentData
string
: When non-empty, contains a value that you must submit to the/payments/details
endpoint. In some cases, required for polling. - paymentMethodType
string
: Specifies the payment method. - qrCodeData
string
: The contents of the QR code as a UTF8 string. - url
string
: Specifies the URL to redirect to.
- paymentData
CheckoutRedirectAction
- CheckoutRedirectAction
object
- data
object
: When the redirect URL must be accessed via POST, use this data to post to the redirect URL. - method
string
: Specifies the HTTP method, for example GET or POST. - paymentData
string
: When non-empty, contains a value that you must submit to the/payments/details
endpoint. In some cases, required for polling. - paymentMethodType
string
: Specifies the payment method. - url
string
: Specifies the URL to redirect to.
- data
CheckoutSDKAction
- CheckoutSDKAction
object
- paymentData
string
: When non-empty, contains a value that you must submit to the/payments/details
endpoint. In some cases, required for polling. - paymentMethodType
string
: Specifies the payment method. - sdkData
object
: The data to pass to the SDK. - url
string
: Specifies the URL to redirect to.
- paymentData
CheckoutThreeDS2ChallengeAction
- CheckoutThreeDS2ChallengeAction
object
- paymentData
string
: When non-empty, contains a value that you must submit to the/payments/details
endpoint. In some cases, required for polling. - paymentMethodType
string
: Specifies the payment method. - token
string
: A token to pass to the 3DS2 Component to get the challenge. - url
string
: Specifies the URL to redirect to.
- paymentData
CheckoutThreeDS2FingerPrintAction
- CheckoutThreeDS2FingerPrintAction
object
- paymentData
string
: When non-empty, contains a value that you must submit to the/payments/details
endpoint. In some cases, required for polling. - paymentMethodType
string
: Specifies the payment method. - token
string
: A token to pass to the 3DS2 Component to get the fingerprint. - url
string
: Specifies the URL to redirect to.
- paymentData
CheckoutUtilityRequest
- CheckoutUtilityRequest
object
- originDomains required
array
: The list of origin domains, for which origin keys are requested.- items
string
- items
- originDomains required
CheckoutUtilityResponse
- CheckoutUtilityResponse
object
- originKeys
object
: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.
- originKeys
CheckoutVoucherAction
- CheckoutVoucherAction
object
- alternativeReference
string
: The voucher alternative reference code. - collectionInstitutionNumber
string
: A collection institution number (store number) for Econtext Pay-Easy ATM. - downloadUrl
string
: The URL to download the voucher. - entity
string
: An entity number of Multibanco. - expiresAt
string
: The date time of the voucher expiry. - initialAmount Amount
- instructionsUrl
string
: The URL to the detailed instructions to make payment using the voucher. - issuer
string
: The issuer of the voucher. - maskedTelephoneNumber
string
: The shopper telephone number (partially masked). - merchantName
string
: The merchant name. - merchantReference
string
: The merchant reference. - paymentData
string
: When non-empty, contains a value that you must submit to the/payments/details
endpoint. In some cases, required for polling. - paymentMethodType
string
: Specifies the payment method. - reference
string
: The voucher reference code. - shopperEmail
string
: The shopper email. - shopperName
string
: The shopper name. - surcharge Amount
- totalAmount Amount
- url
string
: Specifies the URL to redirect to.
- alternativeReference
CommonField
- CommonField
object
- name
string
: Name of the field. For example, Name of External Platform. - version
string
: Version of the field. For example, Version of External Platform.
- name
Company
- Company
object
- homepage
string
: The company website's home page. - name
string
: The company name. - registrationNumber
string
: Registration number of the company. - registryLocation
string
: Registry location of the company. - taxId
string
: Tax ID of the company. - type
string
: The company type.
- homepage
Configuration
- Configuration
object
- avs Avs
- cardHolderName
string
(values: NONE, OPTIONAL, REQUIRED): Determines whether the cardholder name should be provided or not. - installments Installments
- shopperInput ShopperInput
CreatePaymentLinkRequest
- CreatePaymentLinkRequest
object
- allowedPaymentMethods
array
: List of payments methods to be presented to the shopper. To refer to payment methods, use theirpaymentMethod.type
from Payment methods overview.- items
string
- items
- amount required Amount
- applicationInfo ApplicationInfo
- billingAddress Address
- blockedPaymentMethods
array
: List of payments methods to be hidden from the shopper. To refer to payment methods, use theirpaymentMethod.type
from Payment methods overview.- items
string
- items
- countryCode
string
: The shopper's two-letter country code. - deliverAt
string
: The date and time the purchased goods should be delivered. - deliveryAddress Address
- description
string
: A short description visible on the payment page. - expiresAt
string
: The date that the payment link expires, in ISO 8601 format. For example2019-11-23T12:25:28Z
, or2020-05-27T20:25:28+08:00
. Maximum expiry date should be 30 days from when the payment link is created. If not provided, the default expiry is set to 24 hours after the payment link is created. - lineItems
array
: Price and product information about the purchased items, to be included on the invoice sent to the shopper.- items LineItem
- merchantAccount required
string
: The merchant account identifier for which the payment link is created. - merchantOrderReference
string
: This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle. - metadata
object
: Metadata consists of entries, each of which includes a key and a value. - recurringProcessingModel
string
(values: CardOnFile, Subscription, UnscheduledCardOnFile): Defines a recurring payment type. - reference required
string
: A reference that is used to uniquely identify the payment in future communications about the payment status. - returnUrl
string
: Website URL used for redirection after payment is completed. - reusable
boolean
: Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to false which means the link can be used for one successful payment only. - shopperEmail
string
: The shopper's email address. - shopperLocale
string
: The language to be used in the payment page, specified by a combination of a language and country code. For example,en-US
. - shopperName Name
- shopperReference
string
: A unique identifier for the shopper (for example, user ID or account ID). - splits
array
: Information on how the payment should be split between accounts when using Adyen for Platforms.- items Split
- store
string
: The physical store, for which this payment is processed. - storePaymentMethod
boolean
: When this is set to true and theshopperReference
is provided, the payment details will be stored.
- allowedPaymentMethods
DetailsRequest
- DetailsRequest
object
- details required PaymentCompletionDetails
- paymentData
string
: ThepaymentData
value that you received in the response to the/payments
call. - threeDSAuthenticationOnly
boolean
: Change theauthenticationOnly
indicator originally set in the/payments
request. Only needs to be set if you want to modify the value set previously.
DeviceRenderOptions
- DeviceRenderOptions
object
- sdkInterface
string
(values: native, html, both): Supported SDK interface types. - sdkUiType
array
: UI types supported for displaying specific challenges.- items
string
(values: multiSelect, otherHtml, outOfBand, singleSelect, text)
- items
- sdkInterface
DokuDetails
- DokuDetails
object
- firstName required
string
: The shopper's first name. - infix
string
- lastName required
string
: The shopper's last name. - ovoId
string
- shopperEmail required
string
: The shopper's email. - type required
string
(values: doku_mandiri_va, doku_cimb_va, doku_danamon_va, doku_bni_va, doku_permata_lite_atm, doku_bri_va, doku_bca_va, doku_alfamart, doku_indomaret): doku
- firstName required
DotpayDetails
- DotpayDetails
object
- issuer required
string
: The Dotpay issuer value of the shopper's selected bank. Set this to an id of a Dotpay issuer to preselect it. - type required
string
: dotpay
- issuer required
DragonpayDetails
- DragonpayDetails
object
- issuer required
string
: The Dragonpay issuer value of the shopper's selected bank. Set this to an id of a Dragonpay issuer to preselect it. - shopperEmail
string
: The shopper’s email address. - type required
string
(values: dragonpay_ebanking, dragonpay_otc_banking, dragonpay_otc_non_banking, dragonpay_otc_philippines): dragonpay
- issuer required
EcontextVoucherDetails
- EcontextVoucherDetails
object
- firstName required
string
: The shopper's first name. - lastName required
string
: The shopper's last name. - shopperEmail required
string
: The shopper's email. - telephoneNumber required
string
: The shopper's contact number. - type required
string
(values: econtext_seveneleven, econtext_stores): econtextvoucher
- firstName required
EntercashDetails
- EntercashDetails
object
- issuer required
string
: The issuer id of the shopper's selected bank. - type required
string
: entercash
- issuer required
ExternalPlatform
- ExternalPlatform
object
- integrator
string
: External platform integrator. - name
string
: Name of the field. For example, Name of External Platform. - version
string
: Version of the field. For example, Version of External Platform.
- integrator
ForexQuote
- ForexQuote
object
- account
string
: The account name. - accountType
string
: The account type. - baseAmount Amount
- basePoints required
integer
: The base points. - buy Amount
- interbank Amount
- reference
string
: The reference assigned to the forex quote request. - sell Amount
- signature
string
: The signature to validate the integrity. - source
string
: The source of the forex quote. - type
string
: The type of forex. - validTill required
string
: The date until which the forex quote is valid.
- account
FraudCheckResult
- FraudCheckResult
object
- accountScore required
integer
: The fraud score generated by the risk check. - checkId required
integer
: The ID of the risk check. - name required
string
: The name of the risk check.
- accountScore required
FraudResult
- FraudResult
object
- accountScore required
integer
: The total fraud score generated by the risk checks. - results
array
: The result of the individual risk checks.- items FraudCheckResult
- accountScore required
GiropayDetails
- GiropayDetails
object
- storedPaymentMethodId
string
: This is therecurringDetailReference
returned in the response when you created the token. - type required
string
: giropay
- storedPaymentMethodId
GooglePayDetails
- GooglePayDetails
object
- fundingSource
string
(values: credit, debit) - googlePayCardNetwork required
string
- googlePayToken required
string
- storedPaymentMethodId
string
: This is therecurringDetailReference
returned in the response when you created the token. - type required
string
: paywithgoogle
- fundingSource
IdealDetails
- IdealDetails
object
- issuer required
string
: The iDEAL issuer value of the shopper's selected bank. Set this to an id of an iDEAL issuer to preselect it. - storedPaymentMethodId
string
: This is therecurringDetailReference
returned in the response when you created the token. - type required
string
: ideal
- issuer required
InputDetail
- InputDetail
object
- configuration
object
: Configuration parameters for the required input. - details
array
: Input details can also be provided recursively.- items SubInputDetail
- inputDetails
array
: Input details can also be provided recursively (deprecated).- items SubInputDetail
- itemSearchUrl
string
: In case of a select, the URL from which to query the items. - items
array
: In case of a select, the items to choose from.- items Item
- key
string
: The value to provide in the result. - optional
boolean
: True if this input value is optional. - type
string
: The type of the required input. - value
string
: The value can be pre-filled, if available.
- configuration
Installments
- Installments
object
- plan
string
(values: regular, revolving): Defines the type of installment plan. If not set, defaults to regular. - value required
integer
: Defines the number of installments. Its value needs to be greater than zero.
- plan
Item
- Item
object
- id
string
: The value to provide in the result. - name
string
: The display name.
- id
KlarnaDetails
- KlarnaDetails
object
- bankAccount
string
- billingAddress
string
- deliveryAddress
string
- installmentConfigurationKey
string
- personalDetails
string
- separateDeliveryAddress
string
- storedPaymentMethodId
string
: This is therecurringDetailReference
returned in the response when you created the token. - token
string
- type required
string
(values: klarna, klarnapayments, klarnapayments_account, klarnapayments_b2b, klarna_paynow, klarna_account, klarna_b2b): klarna
- bankAccount
LianLianPayDetails
- LianLianPayDetails
object
- telephoneNumber required
string
- type required
string
(values: lianlianpay_ebanking_enterprise, lianlianpay_ebanking_credit, lianlianpay_ebanking_debit): lianlianpay
- telephoneNumber required
LineItem
- LineItem
object
- amountExcludingTax
integer
: Item amount excluding the tax, in minor units. - amountIncludingTax
integer
: Item amount including the tax, in minor units. - description
string
: Description of the line item. - id
string
: ID of the line item. - quantity
integer
: Number of items. - taxAmount
integer
: Tax amount, in minor units. - taxCategory
string
(values: High, Low, None, Zero): Required for AfterPay. Tax category: High, Low, None, Zero - taxPercentage
integer
: Tax percentage, in minor units.
- amountExcludingTax
MasterpassDetails
- MasterpassDetails
object
- fundingSource
string
(values: credit, debit) - masterpassTransactionId required
string
: The Masterpass transaction ID. - type required
string
: masterpass
- fundingSource
MbwayDetails
- MbwayDetails
object
- shopperEmail required
string
- telephoneNumber required
string
- type required
string
: mbway
- shopperEmail required
MerchantDevice
- MerchantDevice
object
- os
string
: Operating system running on the merchant device. - osVersion
string
: Version of the operating system on the merchant device. - reference
string
: Merchant device reference.
- os
MerchantRiskIndicator
- MerchantRiskIndicator
object
- addressMatch
boolean
: Whether the chosen delivery address is identical to the billing address. - deliveryAddressIndicator
string
(values: shipToBillingAddress, shipToVerifiedAddress, shipToNewAddress, shipToStore, digitalGoods, goodsNotShipped, other): Indicator regarding the delivery address. - deliveryEmail
string
: The delivery email address (for digital goods). - deliveryTimeframe
string
(values: electronicD
- addressMatch