Home > API > Checkout > Available payment methods

Available payment methods

Returns the available payment methods for a specified basket value and offers available for client. Returns monthly installment amount, interest and fees. Sending in customer data and contents of the basket to enhance the result is optional. If the online-shop customer enters the incorrect address data, the system delivers suggestion for a corrected address. Main use-case is Two-Step Authorize.

PATH:

/api/v3/checkout/payment-methods

REQUEST BODY SCHEMA:

parentTransactionReference

string <= 128 characters

A unique reference provided to AfterPay by a third party (merchant or Payment Service Provider). Identifies an entire order.

additionalData

additionalData object

Additional Information - to be provided by PSP, plugin or marketplace integrations

pluginProvider

string <= 50 characters

Plugin Provider Name

pluginVersion

string <= 50 characters

Plugin Version

shopUrl

string <= 2048 characters

URL of the Webshop

shopPlatform

string <= 50 characters

Name of the platform used for the Webshop

shopPlatformVersion

string <= 50 characters

Version of the webshop platform

marketplace

array of marketplace

Additional information for marketplace set-ups

Array () [
id

string <= 32 characters

ID of the marketplace seller

name

string <= 50 characters

Name of the marketplace seller

registeredSince

string

Registration date of the marketplace seller

rating

string <= 20 characters

Rating of the marketplace seller

transactions

integer

Number of transaction processed by the marketplace seller


]
subscription

subscription object

Additional information for subscription businesses

name

string <= 50 characters

Name / Description of the subscription

start

string

Startdate of the subscription

end

string

Enddate of the subscription

type

string

Enum: FixedPeriod AutoRenewal

Information if subscription will be autorenewed if not canceled or if subscription is for a fixed period (e.g. 6 months)

partnerData

partnerData object

Additional data to be provided by PSP or platform provider

pspName

string <= 50 characters

Name of the PSP

pspType

string

Enum: Collecting Distributing SuperMerchant MLevel

Type of the PSP

trackingProvider

string <= 50 characters

If device fingerprinting is applied, please specify the name of the provider

trackingSessionId

string <= 50 characters

Session id of tracking script

trackingScore

string <= 20 characters

Score provided by tracking provider

challengedScore

string <= 20 characters

Score provided by partner if transaction is challenged

additionalPaymentInfo

string <= 250 characters

Additional payment information

customer
required

customer object

Customer

customerNumber

string <= 100 characters

Customer unique number

identificationNumber

string <= 20 characters

National ID number (if the customer is a physical person). Registration number (if the customer is a company).

salutation

string

Enum: Mr Mrs Miss

Salutation.

firstName
required

string <= 50 characters

First name. Everything over 50 characters will be truncated

lastName
required

string <= 50 characters

Last name. Everything over 50 characters will be truncated

companyName

string <= 50 characters

Purchasing company name. Required if customerCategory is 'Company'. Everything over 50 characters will be truncated.

email
required

string <= 255 characters

Email

phone

string <= 20 characters

Phone

mobilePhone

string <= 20 characters

Mobile phone

birthDate
required

string

Date of birth. Format is 'YYYY-MM-DD'. Not required if customerCategory is 'Company'.

customerCategory
required

string

Enum: Company Person

Customer category.

address
required

address object

Address

street
required

string <= 100 characters

Name of street or packstation

streetNumber

string <= 10 characters

Street or packstation number

streetNumberAdditional

string <= 10 characters

Additional street number

postalCode
required

string <= 10 characters

Postal code

postalPlace
required

string <= 100 characters

Postal place

countryCode
required

string

Enum: NO SE FI DK DE AT CH NL BE

Country code

careOf

string <= 50 characters

Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.

riskData
required

riskData object

Risk related data. Merchants can do external risk checks and provide that information to AfterPay.

existingCustomer

boolean

Is customer an existing customer for merchant

verifiedCustomerIdentification

boolean

Is identification verified

marketingOptIn

boolean

Shows if merchant is allowed to send marketing information to customer

customerSince

string

Since when customer has been merchant's client

customerClassification

string <= 255 characters

Customer reputation (e.g. VIP client)

acquisitionChannel

string

Enum: NotSet Advertisment SocialNetwork Direct SearchEngine Other

Specify the channel which consumer has used for accessing merchant page

hasCustomerCard

boolean

Shows if customer has loyalty card

customerCardSince

string

The date when the loyalty card was issued to the customer

customerCardClassification

string

Specifies the level of the loyalty card (e.g Gold member).For DE, AT, CH, this must be an integer from 1 to 5, where 5 is the highest VIP level.

profileTrackingId

string <= 50 characters

Unique Id of the device for profile tracking

ipAddress
required

string <= 39 characters

Customer’s IP address

numberOfTransactions

integer

Total number of successful purchases that have been made by the specific consumer

customerIndividualScore

string

The customer's individual risk score provided by the merchant.Accepts a number from -10000 to 10000 (can be encased in quotation marks or not), or a single case-insensitive letter from 'a' to 'z'.

userAgent

string <= 4096 characters

UserAgent of this specific consumer

conversationLanguage

string

Enum: NO SV SE FI DA DK EN DE NL FR

Conversation language. 'SE' and 'DK' are obsolete values, and will be removed in the future. Use 'SV' instead of 'SE', and 'DA' instead of 'DK'.

distributionType

string

Enum: Paper Email Sms

Specifies how information (invoices, notices, etc.) will be distributed to customer.

vatId

string <= 50 characters

VAT registration number, the unique number that identifies a business. VatId is a mandatory field for processing B2B transactions for Germany.

deliveryCustomer

deliveryCustomer object

Delivery customer

customerNumber

string <= 100 characters

Customer unique number

identificationNumber

string <= 20 characters

National ID number (if the customer is a physical person). Registration number (if the customer is a company).

salutation

string

Enum: Mr Mrs Miss

Salutation.

firstName

string <= 50 characters

First name. Everything over 50 characters will be truncated

lastName

string <= 50 characters

Last name. Everything over 50 characters will be truncated

companyName

string <= 50 characters

Purchasing company name. Everything over 50 characters will be truncated

email

string <= 255 characters

Email

phone

string <= 20 characters

Phone

mobilePhone

string <= 20 characters

Mobile phone

customerCategory
required

string

Enum: Company Person

Customer category.

address

address object

Address

street
required

string <= 100 characters

Name of street or packstation

streetNumber

string <= 10 characters

Street or packstation number

streetNumberAdditional

string <= 10 characters

Additional street number

postalCode
required

string <= 10 characters

Postal code

postalPlace
required

string <= 100 characters

Postal place

countryCode
required

string

Enum: NO SE FI DK DE AT CH NL BE

Country code

careOf

string <= 50 characters

Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.

distributionType

string

Enum: Paper Email Sms

Specifies how information (invoices, notices, etc.) will be distributed to customer.

vatId

string <= 50 characters

VAT registration number, the unique number that identifies a business. VatId is a mandatory field for processing B2B transactions for Germany.

order
required

order object

Order number and details

totalNetAmount
required

number

Total net amount of order.

totalGrossAmount
required

number

Total gross amount of order. Must match the grossUnitPrice * quantity of order items

currency
required

string

Enum: EUR NOK SEK DKK CHF

Currency of the order

risk

risk object

Order related risk data. If you were not provided these credentials by your Integration Manager, leave empty.

channelType

string

Enum: Internet Catalog CallCenter Stationary Other

Order channel type

deliveryType

string

Enum: Normal Express

Order delivery type

ticketDeliveryMethod

string

Enum: NotSet PickUp Email Post Phone

Name of the tickets' method

airline

airline object

Airline information when airline tickets or services are ordered

passengers

array of passengers

Passengers

Array () [
id

integer

Continuous numbering

firstName

string <= 4096 characters

First name

lastName

string <= 4096 characters

Last name

salutation

string

Enum: Mr Mrs Miss

Salutation

dateOfBirth

string

Date birth of passenger


]
itineraries

array of itineraries

Itineraries

Array () [
operator

string <= 4096 characters

Name or Airport code (2-letter IATA) of the carrier

departure

string <= 4096 characters

Departure city or Airport Code (3-letter IATA)

arrival

string <= 4096 characters

Arrival city or Airport Code (3-letter IATA)

routeNumber

string <= 4096 characters

Number of this itinerary. Assumes String ordering.

dateOfTravel

string

Departure date and time

price

number

Price

currency

string

Enum: EUR NOK SEK DKK CHF

Currency


]
insurance

insurance object

Insurance

company

string <= 4096 characters

Name of insurance company

type

string

Enum: NotSet Cancellation Travel CancellationTravel Bankruptcy

Insurance type

price

number

Price of insurance

currency

string

Enum: EUR NOK SEK DKK CHF

Currency

bookingReference

string <= 4096 characters

Booking reference

bus

bus object

Bus information when bus tickets or services are ordered

passengers

array of passengers

Passengers

Array () [
id

integer

Continuous numbering

firstName

string <= 4096 characters

First name

lastName

string <= 4096 characters

Last name

salutation

string

Enum: Mr Mrs Miss

Salutation

dateOfBirth

string

Date birth of passenger


]
itineraries

array of itineraries

Itineraries

Array () [
operator

string <= 4096 characters

Name or Airport code (2-letter IATA) of the carrier

departure

string <= 4096 characters

Departure city or Airport Code (3-letter IATA)

arrival

string <= 4096 characters

Arrival city or Airport Code (3-letter IATA)

routeNumber

string <= 4096 characters

Number of this itinerary. Assumes String ordering.

dateOfTravel

string

Departure date and time

price

number

Price

currency

string

Enum: EUR NOK SEK DKK CHF

Currency


]
insurance

insurance object

Insurance

company

string <= 4096 characters

Name of insurance company

type

string

Enum: NotSet Cancellation Travel CancellationTravel Bankruptcy

Insurance type

price

number

Price of insurance

currency

string

Enum: EUR NOK SEK DKK CHF

Currency

bookingReference

string <= 4096 characters

Booking reference

train

train object

Train information when train tickets or services are ordered

passengers

array of passengers

Passengers

Array () [
id

integer

Continuous numbering

firstName

string <= 4096 characters

First name

lastName

string <= 4096 characters

Last name

salutation

string

Enum: Mr Mrs Miss

Salutation

dateOfBirth

string

Date birth of passenger


]
itineraries

array of itineraries

Itineraries

Array () [
operator

string <= 4096 characters

Name or Airport code (2-letter IATA) of the carrier

departure

string <= 4096 characters

Departure city or Airport Code (3-letter IATA)

arrival

string <= 4096 characters

Arrival city or Airport Code (3-letter IATA)

routeNumber

string <= 4096 characters

Number of this itinerary. Assumes String ordering.

dateOfTravel

string

Departure date and time

price

number

Price

currency

string

Enum: EUR NOK SEK DKK CHF

Currency


]
insurance

insurance object

Insurance

company

string <= 4096 characters

Name of insurance company

type

string

Enum: NotSet Cancellation Travel CancellationTravel Bankruptcy

Insurance type

price

number

Price of insurance

currency

string

Enum: EUR NOK SEK DKK CHF

Currency

bookingReference

string <= 4096 characters

Booking reference

ferry

ferry object

Ferry information when ferry tickets or services are ordered

passengers

array of passengers

Passengers

Array () [
id

integer

Continuous numbering

firstName

string <= 4096 characters

First name

lastName

string <= 4096 characters

Last name

salutation

string

Enum: Mr Mrs Miss

Salutation

dateOfBirth

string

Date birth of passenger


]
itineraries

array of itineraries

Itineraries

Array () [
operator

string <= 4096 characters

Name or Airport code (2-letter IATA) of the carrier

departure

string <= 4096 characters

Departure city or Airport Code (3-letter IATA)

arrival

string <= 4096 characters

Arrival city or Airport Code (3-letter IATA)

routeNumber

string <= 4096 characters

Number of this itinerary. Assumes String ordering.

dateOfTravel

string

Departure date and time

price

number

Price

currency

string

Enum: EUR NOK SEK DKK CHF

Currency


]
insurance

insurance object

Insurance

company

string <= 4096 characters

Name of insurance company

type

string

Enum: NotSet Cancellation Travel CancellationTravel Bankruptcy

Insurance type

price

number

Price of insurance

currency

string

Enum: EUR NOK SEK DKK CHF

Currency

bookingReference

string <= 4096 characters

Booking reference

rental

rental object

Rental car information

company

string <= 4096 characters

Name of rental company

pickupLocation

pickupLocation object

Pickup location

street
required

string <= 100 characters

Name of street or packstation

streetNumber

string <= 10 characters

Street or packstation number

streetNumberAdditional

string <= 10 characters

Additional street number

postalCode
required

string <= 10 characters

Postal code

postalPlace
required

string <= 100 characters

Postal place

countryCode
required

string

Enum: NO SE FI DK DE AT CH NL BE

Country code

careOf

string <= 50 characters

Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.

dropoffLocation

dropoffLocation object

Drop off location

street
required

string <= 100 characters

Name of street or packstation

streetNumber

string <= 10 characters

Street or packstation number

streetNumberAdditional

string <= 10 characters

Additional street number

postalCode
required

string <= 10 characters

Postal code

postalPlace
required

string <= 100 characters

Postal place

countryCode
required

string

Enum: NO SE FI DK DE AT CH NL BE

Country code

careOf

string <= 50 characters

Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.

startDate

string

Pick up date and time

endDate

string

End date and time

drivers

array of drivers

Information about drivers who have rented a car

Array () [
customerNumber

string <= 100 characters

Customer unique number

identificationNumber

string <= 20 characters

National ID number (if the customer is a physical person). Registration number (if the customer is a company).

salutation

string

Enum: Mr Mrs Miss

Salutation.

firstName
required

string <= 50 characters

First name. Everything over 50 characters will be truncated

lastName
required

string <= 50 characters

Last name. Everything over 50 characters will be truncated

companyName

string <= 50 characters

Purchasing company name. Required if customerCategory is 'Company'. Everything over 50 characters will be truncated.

email
required

string <= 255 characters

Email

phone

string <= 20 characters

Phone

mobilePhone

string <= 20 characters

Mobile phone

birthDate
required

string

Date of birth. Format is 'YYYY-MM-DD'. Not required if customerCategory is 'Company'.

customerCategory
required

string

Enum: Company Person

Customer category.

address
required

address object

Address

street
required

string <= 100 characters

Name of street or packstation

streetNumber

string <= 10 characters

Street or packstation number

streetNumberAdditional

string <= 10 characters

Additional street number

postalCode
required

string <= 10 characters

Postal code

postalPlace
required

string <= 100 characters

Postal place

countryCode
required

string

Enum: NO SE FI DK DE AT CH NL BE

Country code

careOf

string <= 50 characters

Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.

riskData
required

riskData object

Risk related data. Merchants can do external risk checks and provide that information to AfterPay.

existingCustomer

boolean

Is customer an existing customer for merchant

verifiedCustomerIdentification

boolean

Is identification verified

marketingOptIn

boolean

Shows if merchant is allowed to send marketing information to customer

customerSince

string

Since when customer has been merchant's client

customerClassification

string <= 255 characters

Customer reputation (e.g. VIP client)

acquisitionChannel

string

Enum: NotSet Advertisment SocialNetwork Direct SearchEngine Other

Specify the channel which consumer has used for accessing merchant page

hasCustomerCard

boolean

Shows if customer has loyalty card

customerCardSince

string

The date when the loyalty card was issued to the customer

customerCardClassification

string

Specifies the level of the loyalty card (e.g Gold member).For DE, AT, CH, this must be an integer from 1 to 5, where 5 is the highest VIP level.

profileTrackingId

string <= 50 characters

Unique Id of the device for profile tracking

ipAddress
required

string <= 39 characters

Customer’s IP address

numberOfTransactions

integer

Total number of successful purchases that have been made by the specific consumer

customerIndividualScore

string

The customer's individual risk score provided by the merchant.Accepts a number from -10000 to 10000 (can be encased in quotation marks or not), or a single case-insensitive letter from 'a' to 'z'.

userAgent

string <= 4096 characters

UserAgent of this specific consumer

conversationLanguage

string

Enum: NO SV SE FI DA DK EN DE NL FR

Conversation language. 'SE' and 'DK' are obsolete values, and will be removed in the future. Use 'SV' instead of 'SE', and 'DA' instead of 'DK'.

distributionType

string

Enum: Paper Email Sms

Specifies how information (invoices, notices, etc.) will be distributed to customer.

vatId

string <= 50 characters

VAT registration number, the unique number that identifies a business. VatId is a mandatory field for processing B2B transactions for Germany.


]
price

number

Price of a rental car

currency

string

Enum: EUR NOK SEK DKK CHF

Currency

bookingReference

string <= 4096 characters

Booking reference

hotel

hotel object

Hotel information

company

string <= 4096 characters

undefined

address

address object

Hotel address

street
required

string <= 100 characters

Name of street or packstation

streetNumber

string <= 10 characters

Street or packstation number

streetNumberAdditional

string <= 10 characters

Additional street number

postalCode
required

string <= 10 characters

Postal code

postalPlace
required

string <= 100 characters

Postal place

countryCode
required

string

Enum: NO SE FI DK DE AT CH NL BE

Country code

careOf

string <= 50 characters

Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.

checkin

string

Check-in date and time

checkout

string

Check-out date and time

guests

array of guests

Guests information

Array () [
customerNumber

string <= 100 characters

Customer unique number

identificationNumber

string <= 20 characters

National ID number (if the customer is a physical person). Registration number (if the customer is a company).

salutation

string

Enum: Mr Mrs Miss

Salutation.

firstName
required

string <= 50 characters

First name. Everything over 50 characters will be truncated

lastName
required

string <= 50 characters

Last name. Everything over 50 characters will be truncated

companyName

string <= 50 characters

Purchasing company name. Required if customerCategory is 'Company'. Everything over 50 characters will be truncated.

email
required

string <= 255 characters

Email

phone

string <= 20 characters

Phone

mobilePhone

string <= 20 characters

Mobile phone

birthDate
required

string

Date of birth. Format is 'YYYY-MM-DD'. Not required if customerCategory is 'Company'.

customerCategory
required

string

Enum: Company Person

Customer category.

address
required

address object

Address

street
required

string <= 100 characters

Name of street or packstation

streetNumber

string <= 10 characters

Street or packstation number

streetNumberAdditional

string <= 10 characters

Additional street number

postalCode
required

string <= 10 characters

Postal code

postalPlace
required

string <= 100 characters

Postal place

countryCode
required

string

Enum: NO SE FI DK DE AT CH NL BE

Country code

careOf

string <= 50 characters

Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.

riskData
required

riskData object

Risk related data. Merchants can do external risk checks and provide that information to AfterPay.

existingCustomer

boolean

Is customer an existing customer for merchant

verifiedCustomerIdentification

boolean

Is identification verified

marketingOptIn

boolean

Shows if merchant is allowed to send marketing information to customer

customerSince

string

Since when customer has been merchant's client

customerClassification

string <= 255 characters

Customer reputation (e.g. VIP client)

acquisitionChannel

string

Enum: NotSet Advertisment SocialNetwork Direct SearchEngine Other

Specify the channel which consumer has used for accessing merchant page

hasCustomerCard

boolean

Shows if customer has loyalty card

customerCardSince

string

The date when the loyalty card was issued to the customer

customerCardClassification

string

Specifies the level of the loyalty card (e.g Gold member).For DE, AT, CH, this must be an integer from 1 to 5, where 5 is the highest VIP level.

profileTrackingId

string <= 50 characters

Unique Id of the device for profile tracking

ipAddress
required

string <= 39 characters

Customer’s IP address

numberOfTransactions

integer

Total number of successful purchases that have been made by the specific consumer

customerIndividualScore

string

The customer's individual risk score provided by the merchant.Accepts a number from -10000 to 10000 (can be encased in quotation marks or not), or a single case-insensitive letter from 'a' to 'z'.

userAgent

string <= 4096 characters

UserAgent of this specific consumer

conversationLanguage

string

Enum: NO SV SE FI DA DK EN DE NL FR

Conversation language. 'SE' and 'DK' are obsolete values, and will be removed in the future. Use 'SV' instead of 'SE', and 'DA' instead of 'DK'.

distributionType

string

Enum: Paper Email Sms

Specifies how information (invoices, notices, etc.) will be distributed to customer.

vatId

string <= 50 characters

VAT registration number, the unique number that identifies a business. VatId is a mandatory field for processing B2B transactions for Germany.


]
numberOfRooms

integer

Number of rooms

price

number

Price of the hotel accommodation

currency

string

Enum: EUR NOK SEK DKK CHF

Currency

bookingReference

string <= 4096 characters

Booking reference

merchantImageUrl

string <= 2048 characters

Image URL for the merchants brand. This image is shown at the top of the order page in MyAfterPay

items
required

array of items

Array of order items. Maximum allowed 200 items.

Array () [
productId
required

string <= 100 characters

Merchant Product identification number

groupId

string <= 50 characters

Item group ID. The group this item belongs to. Provided by the merchant

description
required

string

Product name. For example "Black music player 64GB". Everything over 255 characters will be truncated

type

string

Enum: PhysicalArticle DigitalArticle GiftCard Discount ShippingFee Surcharge Info

Order item type

netUnitPrice
required

number

Net unit price

grossUnitPrice
required

number

Gross price per item

quantity
required

number

Quantity. Use of integer is strongly proposed. If you want to use decimal, please contact your integration manager.

vatCategory

string

Enum: HighCategory LowCategory NullCategory NoCategory MiddleCategory OtherCategory

VAT category

vatPercent
required

number

Tax percent

vatAmount
required

number

Tax amount per item

imageUrl

string <= 2048 characters

URL for the image of this product. It will be turned into a thumbnail and displayed in MyAfterPay, on the invoice line next to the order item. The linked image must be a rectangle or square, width between 100 pixels and 1280 pixels.

productUrl

string <= 2048 characters

URL to the product

marketPlaceSellerId

string <= 32 characters

ID of an individual seller on a marketplace

additionalInformation

string <= 4096 characters

Extended description of the order item.


]

RESPONSES:

200 OK

RESPONSE SCHEMA:

riskCheckMessages

array of riskCheckMessages

Risk check messages

Array () [
type

string

Enum: BusinessError TechnicalError NotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum: Unavailable AskConsumerToConfirm AskConsumerToReEnterData OfferSecurePaymentMethods RequiresSsn AskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error


]
deliveryCustomer

deliveryCustomer object

Delivery customer

customerNumber

string <= 100 characters

Customer number

customerAccountId

string <= 50 characters

Customer account id

firstName

string <= 50 characters

First name

lastName

string <= 50 characters

Last name

addressList

array of addressList

Address list

Array () [
street
required

string <= 100 characters

Name of street or packstation

streetNumber

string <= 10 characters

Street or packstation number

streetNumberAdditional

string <= 10 characters

Additional street number

postalCode
required

string <= 10 characters

Postal code

postalPlace
required

string <= 100 characters

Postal place

countryCode
required

string

Enum: NO SE FI DK DE AT CH NL BE

Country code

careOf

string <= 50 characters

Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.


]
checkoutId

string

Unique identifier of checkout process in UUID format.

outcome

string

Enum: Accepted Pending Rejected NotEvaluated

Outcome

customer

customer object

Customer

customerNumber

string <= 100 characters

Customer number

customerAccountId

string <= 50 characters

Customer account id

firstName

string <= 50 characters

First name

lastName

string <= 50 characters

Last name

addressList

array of addressList

Address list

Array () [
street
required

string <= 100 characters

Name of street or packstation

streetNumber

string <= 10 characters

Street or packstation number

streetNumberAdditional

string <= 10 characters

Additional street number

postalCode
required

string <= 10 characters

Postal code

postalPlace
required

string <= 100 characters

Postal place

countryCode
required

string

Enum: NO SE FI DK DE AT CH NL BE

Country code

careOf

string <= 50 characters

Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.


]
paymentMethods

array of paymentMethods

Allowed payment methods

Array () [
type

string

Enum: Invoice Account Installment Consolidatedinvoice DirectDebitInvoice

Available payment type

title
required

string

Available payment title

tag
required

string

Available payment tag line

consumerFeeAmount

number

Available payment consumer invoice fee

logo
required

string

Available payment logo path

account

account object

Account product information

profileNo
required

integer

Account Profile number

installmentAmount

number

undefined

startupFee

number

undefined

monthlyFee

number

undefined

interestRate

number

undefined

readMore

string

undefined

directDebit

directDebit object

Direct debit availability for this payment type

available

boolean

Shows if direct debit as a payment method is available

campaigns

campaigns object

Available campaigns for this payment type

campaignNumber

integer

Campaign number

campaignType

string

Enum: FixedDueDate FloatingDueDate

undefined

activeFrom

string

undefined

activeTo

string

undefined

dueDate

string

undefined

consumerFeeAmount

number

undefined

paymentTerm

integer

undefined

installment

installment object

Installment information when payment type is Installment

basketAmount

number

Basket amount

numberOfInstallments

integer

Number of installments

installmentAmount

number

Monthly installment amount

firstInstallmentAmount

number

Amount of the first installment payment

lastInstallmentAmount

number

Amount of the last installment payment

interestRate

number

Interest rate

effectiveInterestRate

number

Effective interest rate

effectiveAnnualPercentageRate

number

Effective annual percentage rate

totalInterestAmount

number

Total interest amount

startupFee

number

Fee for opening up an installment plan

monthlyFee

number

Monthly fee for the installment amount

totalAmount

number

Total amount

installmentProfileNumber

integer

Installment profile number

readMore

string <= 2048 characters

More information on installment process


]
400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum: BusinessError TechnicalError NotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum: Unavailable AskConsumerToConfirm AskConsumerToReEnterData OfferSecurePaymentMethods RequiresSsn AskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error

]
401 Authorization has been denied for this request.
500 Internal server error.

Path

post

/api/v3/checkout/payment-methods

Request samples

  • {
    • "parentTransactionReference": "string",
    • "additionalData": { ...
      • "pluginProvider": "string",
      • "pluginVersion": "string",
      • "shopUrl": "string",
      • "shopPlatform": "string",
      • "shopPlatformVersion": "string",
      • "marketplace": [ ...
        • {
          • "id": "string",
          • "name": "string",
          • "registeredSince": "string",
          • "rating": "string",
          • "transactions": 1
          }
        ],
      • "subscription": { ...
        • "name": "string",
        • "start": "string",
        • "end": "string",
        • "type": "string"
        },
      • "partnerData": { ...
        • "pspName": "string",
        • "pspType": "string",
        • "trackingProvider": "string",
        • "trackingSessionId": "string",
        • "trackingScore": "string",
        • "challengedScore": "string"
        },
      • "additionalPaymentInfo": "string"
      },
    • "customer": { ...
      • "customerNumber": "string",
      • "identificationNumber": "string",
      • "salutation": "string",
      • "firstName": "string",
      • "lastName": "string",
      • "companyName": "string",
      • "email": "string",
      • "phone": "string",
      • "mobilePhone": "string",
      • "birthDate": "string",
      • "customerCategory": "string",
      • "address": { ...
        • "street": "string",
        • "streetNumber": "string",
        • "streetNumberAdditional": "string",
        • "postalCode": "string",
        • "postalPlace": "string",
        • "countryCode": "string",
        • "careOf": "string"
        },
      • "riskData": { ...
        • "existingCustomer": true,
        • "verifiedCustomerIdentification": true,
        • "marketingOptIn": true,
        • "customerSince": "string",
        • "customerClassification": "string",
        • "acquisitionChannel": "string",
        • "hasCustomerCard": true,
        • "customerCardSince": "string",
        • "customerCardClassification": "string",
        • "profileTrackingId": "string",
        • "ipAddress": "string",
        • "numberOfTransactions": 1,
        • "customerIndividualScore": "string",
        • "userAgent": "string"
        },
      • "conversationLanguage": "string",
      • "distributionType": "string",
      • "vatId": "string"
      },
    • "deliveryCustomer": { ...
      • "customerNumber": "string",
      • "identificationNumber": "string",
      • "salutation": "string",
      • "firstName": "string",
      • "lastName": "string",
      • "companyName": "string",
      • "email": "string",
      • "phone": "string",
      • "mobilePhone": "string",
      • "customerCategory": "string",
      • "address": { ...
        • "street": "string",
        • "streetNumber": "string",
        • "streetNumberAdditional": "string",
        • "postalCode": "string",
        • "postalPlace": "string",
        • "countryCode": "string",
        • "careOf": "string"
        },
      • "distributionType": "string",
      • "vatId": "string"
      },
    • "order": { ...
      • "totalNetAmount": 1.00,
      • "totalGrossAmount": 1.00,
      • "currency": "string",
      • "risk": { ...
        • "channelType": "string",
        • "deliveryType": "string",
        • "ticketDeliveryMethod": "string",
        • "airline": { ...
          • "passengers": [ ...
            • {
              • "id": 1,
              • "firstName": "string",
              • "lastName": "string",
              • "salutation": "string",
              • "dateOfBirth": "string"
              }
            ],
          • "itineraries": [ ...
            • {
              • "operator": "string",
              • "departure": "string",
              • "arrival": "string",
              • "routeNumber": "string",
              • "dateOfTravel": "string",
              • "price": 1.00,
              • "currency": "string"
              }
            ],
          • "insurance": { ...
            • "company": "string",
            • "type": "string",
            • "price": 1.00,
            • "currency": "string"
            },
          • "bookingReference": "string"
          },
        • "bus": { ...
          • "passengers": [ ...
            • {
              • "id": 1,
              • "firstName": "string",
              • "lastName": "string",
              • "salutation": "string",
              • "dateOfBirth": "string"
              }
            ],
          • "itineraries": [ ...
            • {
              • "operator": "string",
              • "departure": "string",
              • "arrival": "string",
              • "routeNumber": "string",
              • "dateOfTravel": "string",
              • "price": 1.00,
              • "currency": "string"
              }
            ],
          • "insurance": { ...
            • "company": "string",
            • "type": "string",
            • "price": 1.00,
            • "currency": "string"
            },
          • "bookingReference": "string"
          },
        • "train": { ...
          • "passengers": [ ...
            • {
              • "id": 1,
              • "firstName": "string",
              • "lastName": "string",
              • "salutation": "string",
              • "dateOfBirth": "string"
              }
            ],
          • "itineraries": [ ...
            • {
              • "operator": "string",
              • "departure": "string",
              • "arrival": "string",
              • "routeNumber": "string",
              • "dateOfTravel": "string",
              • "price": 1.00,
              • "currency": "string"
              }
            ],
          • "insurance": { ...
            • "company": "string",
            • "type": "string",
            • "price": 1.00,
            • "currency": "string"
            },
          • "bookingReference": "string"
          },
        • "ferry": { ...
          • "passengers": [ ...
            • {
              • "id": 1,
              • "firstName": "string",
              • "lastName": "string",
              • "salutation": "string",
              • "dateOfBirth": "string"
              }
            ],
          • "itineraries": [ ...
            • {
              • "operator": "string",
              • "departure": "string",
              • "arrival": "string",
              • "routeNumber": "string",
              • "dateOfTravel": "string",
              • "price": 1.00,
              • "currency": "string"
              }
            ],
          • "insurance": { ...
            • "company": "string",
            • "type": "string",
            • "price": 1.00,
            • "currency": "string"
            },
          • "bookingReference": "string"
          },
        • "rental": { ...
          • "company": "string",
          • "pickupLocation": { ...
            • "street": "string",
            • "streetNumber": "string",
            • "streetNumberAdditional": "string",
            • "postalCode": "string",
            • "postalPlace": "string",
            • "countryCode": "string",
            • "careOf": "string"
            },
          • "dropoffLocation": { ...
            • "street": "string",
            • "streetNumber": "string",
            • "streetNumberAdditional": "string",
            • "postalCode": "string",
            • "postalPlace": "string",
            • "countryCode": "string",
            • "careOf": "string"
            },
          • "startDate": "string",
          • "endDate": "string",
          • "drivers": [ ...
            • {
              • "customerNumber": "string",
              • "identificationNumber": "string",
              • "salutation": "string",
              • "firstName": "string",
              • "lastName": "string",
              • "companyName": "string",
              • "email": "string",
              • "phone": "string",
              • "mobilePhone": "string",
              • "birthDate": "string",
              • "customerCategory": "string",
              • "address": { ...
                • "street": "string",
                • "streetNumber": "string",
                • "streetNumberAdditional": "string",
                • "postalCode": "string",
                • "postalPlace": "string",
                • "countryCode": "string",
                • "careOf": "string"
                },
              • "riskData": { ...
                • "existingCustomer": true,
                • "verifiedCustomerIdentification": true,
                • "marketingOptIn": true,
                • "customerSince": "string",
                • "customerClassification": "string",
                • "acquisitionChannel": "string",
                • "hasCustomerCard": true,
                • "customerCardSince": "string",
                • "customerCardClassification": "string",
                • "profileTrackingId": "string",
                • "ipAddress": "string",
                • "numberOfTransactions": 1,
                • "customerIndividualScore": "string",
                • "userAgent": "string"
                },
              • "conversationLanguage": "string",
              • "distributionType": "string",
              • "vatId": "string"
              }
            ],
          • "price": 1.00,
          • "currency": "string",
          • "bookingReference": "string"
          },
        • "hotel": { ...
          • "company": "string",
          • "address": { ...
            • "street": "string",
            • "streetNumber": "string",
            • "streetNumberAdditional": "string",
            • "postalCode": "string",
            • "postalPlace": "string",
            • "countryCode": "string",
            • "careOf": "string"
            },
          • "checkin": "string",
          • "checkout": "string",
          • "guests": [ ...
            • {
              • "customerNumber": "string",
              • "identificationNumber": "string",
              • "salutation": "string",
              • "firstName": "string",
              • "lastName": "string",
              • "companyName": "string",
              • "email": "string",
              • "phone": "string",
              • "mobilePhone": "string",
              • "birthDate": "string",
              • "customerCategory": "string",
              • "address": { ...
                • "street": "string",
                • "streetNumber": "string",
                • "streetNumberAdditional": "string",
                • "postalCode": "string",
                • "postalPlace": "string",
                • "countryCode": "string",
                • "careOf": "string"
                },
              • "riskData": { ...
                • "existingCustomer": true,
                • "verifiedCustomerIdentification": true,
                • "marketingOptIn": true,
                • "customerSince": "string",
                • "customerClassification": "string",
                • "acquisitionChannel": "string",
                • "hasCustomerCard": true,
                • "customerCardSince": "string",
                • "customerCardClassification": "string",
                • "profileTrackingId": "string",
                • "ipAddress": "string",
                • "numberOfTransactions": 1,
                • "customerIndividualScore": "string",
                • "userAgent": "string"
                },
              • "conversationLanguage": "string",
              • "distributionType": "string",
              • "vatId": "string"
              }
            ],
          • "numberOfRooms": 1,
          • "price": 1.00,
          • "currency": "string",
          • "bookingReference": "string"
          }
        },
      • "merchantImageUrl": "string",
      • "items": [ ...
        • {
          • "productId": "string",
          • "groupId": "string",
          • "description": "string",
          • "type": "string",
          • "netUnitPrice": 1.00,
          • "grossUnitPrice": 1.00,
          • "quantity": 1.00,
          • "vatPercent": 1.00,
          • "vatAmount": 1.00,
          • "imageUrl": "string",
          • "productUrl": "string",
          • "marketPlaceSellerId": "string",
          • "additionalInformation": "string"
          }
        ]
      }
  • }

Response samples

200400
  • {
    • "riskCheckMessages": [ ...
      • {
        • "type": "string",
        • "code": "string",
        • "message": "string",
        • "customerFacingMessage": "string",
        • "actionCode": "string",
        • "fieldReference": "string"
        }
      ],
    • "deliveryCustomer": { ...
      • "customerNumber": "string",
      • "customerAccountId": "string",
      • "firstName": "string",
      • "lastName": "string",
      • "addressList": [ ...
        • {
          • "street": "string",
          • "streetNumber": "string",
          • "streetNumberAdditional": "string",
          • "postalCode": "string",
          • "postalPlace": "string",
          • "countryCode": "string",
          • "careOf": "string"
          }
        ]
      },
    • "checkoutId": "string",
    • "outcome": "string",
    • "customer": { ...
      • "customerNumber": "string",
      • "customerAccountId": "string",
      • "firstName": "string",
      • "lastName": "string",
      • "addressList": [ ...
        • {
          • "street": "string",
          • "streetNumber": "string",
          • "streetNumberAdditional": "string",
          • "postalCode": "string",
          • "postalPlace": "string",
          • "countryCode": "string",
          • "careOf": "string"
          }
        ]
      },
    • "paymentMethods": [ ...
      • {
        • "type": "string",
        • "title": "string",
        • "tag": "string",
        • "consumerFeeAmount": 1.00,
        • "logo": "string",
        • "account": { ...
          • "profileNo": 1,
          • "installmentAmount": 1.00,
          • "startupFee": 1.00,
          • "monthlyFee": 1.00,
          • "interestRate": 1.00,
          • "readMore": "string"
          },
        • "directDebit": { ...
          • "available": true
          },
        • "campaigns": { ...
          • "campaignNumber": 1,
          • "campaignType": "string",
          • "activeFrom": "string",
          • "activeTo": "string",
          • "dueDate": "string",
          • "consumerFeeAmount": 1.00,
          • "paymentTerm": 1
          },
        • "installment": { ...
          • "basketAmount": 1.00,
          • "numberOfInstallments": 1,
          • "installmentAmount": 1.00,
          • "firstInstallmentAmount": 1.00,
          • "lastInstallmentAmount": 1.00,
          • "interestRate": 1.00,
          • "effectiveInterestRate": 1.00,
          • "effectiveAnnualPercentageRate": 1.00,
          • "totalInterestAmount": 1.00,
          • "startupFee": 1.00,
          • "monthlyFee": 1.00,
          • "totalAmount": 1.00,
          • "installmentProfileNumber": 1,
          • "readMore": "string"
          }
        }
      ]
    }
  • [
      ...
      • {
        • "type": "string",
        • "code": "string",
        • "message": "string",
        • "customerFacingMessage": "string",
        • "actionCode": "string",
        • "fieldReference": "string"
        }
    ]