GW API

API for processing payments

bankPaymentQrCode

POST /api/bank-payment/qr-code

checkoutBankPayment

POST /api/bank-payment/checkout

describeBankPaymentForm

POST /api/bank-payment/describe-form

changeEmail

POST /api/base/change-email

checkEmail

POST /api/base/check-email

checkPayment

POST /api/base/check-payment

describeLeavingForm

POST /api/base/describe-leaving-form

describePage

POST /api/base/describe-page

describePayment

POST /api/base/describe-payment

finishCheckout

POST /api/base/finish-checkut

getEshopRedirect

POST /api/base/get-eshop-redirect

getFinishCheckoutConfig

POST /api/base/finish-checkout-config

getPaymentDetail

POST /api/base/payment-detail

methods

POST /api/base/methods

paymentStatus

POST /api/base/payment-status

redirectToDesktop

POST /api/base/redirect-to-desktop

setUserRemember

POST /api/base/user-remember

voidRecurrence

POST /api/base/void-recurrence

checkoutBitcoin

POST /api/bitcoin/checkout

describeBitcoinForm

POST /api/bitcoin/describe-form

checkoutSkippay

POST /api/bnpl/checkout-skippay

checkoutTwisto

POST /api/bnpl/checkout-twisto

describeSkippayForm

POST /api/bnpl/describe-skippay-form

describeTwistoForm

POST /api/bnpl/describe-twisto-form

checkoutGoPayWallet

POST /api/go-pay-wallet/checkout

describeGoPayWalletCheckoutForm

POST /api/go-pay-wallet/describe-checkout-form

describeGoPayWalletForm

POST /api/go-pay-wallet/describe-form

captureInstallment

POST /api/installments/capture-installment

describeInstallments

POST /api/installments/describe

login

POST /api/login/login

loginViaSca

POST /api/login/login-via-sca

logout

POST /api/login/logout

requestLoginSmsCode

POST /api/login/request-login-sms-code

checkoutMplatba

POST /api/mplatba/checkout

describeMplatbaForm

POST /api/mplatba/describe-form

checkoutBankPaymentPSD2

POST /api/psd2/checkout

getPSD2AccountList

POST /api/psd2/account-list

checkoutPayPal

POST /api/pay-pal/checkout

describePayPalForm

POST /api/pay-pal/describe-form

checkoutPaysafecard

POST /api/paysafecard/checkout

describePaysafecardForm

POST /api/paysafecard/describe-form

checkoutPremiumSMS

POST /api/premium-sms/checkout

describePremiumSmsForm

POST /api/premium-sms/describe-form

isPaymentRestartable

POST /api/restart-payment/is-restartable

restartPayment

POST /api/restart-payment/restart

loadShoppingReview

POST /api/shopping-review/load

storeShoppingReview

POST /api/shopping-review/store

changePaymentSessionLanguage

POST /api/ui-utils/session-language

frontendLogMessage

POST /api/ui-utils/log-message

getPaymentCardBrandPrefixes

POST /api/ui-utils/dcard-brand-prefixes

getTheme

POST /api/ui-utils/theme

paymentCardCustomColours

POST /api/ui-utils/card-custom-colors

paymentSessionLanguages

POST /api/ui-utils/session-languages

resolveIssuerLogoFromBin

POST /api/ui-utils/resolve-issuer-logo

setBrowserData

POST /api/ui-utils/browser-data

setPaymentCardCustomMetadata

POST /api/ui-utils/card-custom-metadata

checkoutApplePay

POST /api/xpay/checkout-apple-pay

checkoutGooglePay

POST /api/xpay/checkout-google-pay

checkoutMastercardSRC

POST /api/xpay/checkout-mastercard-src

checkoutPaymentCard

POST /api/xpay/checkout-payment-card

checkoutPaymentCardAnonym

POST /api/xpay/checkout-payment-card-anonym

checkoutVisaSRC

POST /api/xpay/checkout-visa-src

deletePaymentCard

POST /api/xpay/delete-payment-card

describePaymentCardForm

POST /api/xpay/describe-payment-card-form

describeXPayForm

POST /api/xpay/describe-xpay-form

storeOrRememberCard

POST /api/xpay/store-or-remember-card

validateApplePayMerchant

POST /api/xpay/validate-apple-pay-merchant

Initialize context

POST /api/initialize

POST /api/bank-payment/qr-code

Request body

application/json

BankPaymentQrCodeForm

Responses

400 default

default response

Body

application/json

GwApiResponseBankPaymentQrCodeImage

POST /api/bank-payment/checkout

Request body

application/json

BankPaymentCheckoutForm

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/bank-payment/describe-form

Responses

400 default

default response

Body

application/json

GwApiResponseBankCheckoutFormDescription

POST /api/base/change-email

Request body

application/json

EmailChange

Responses

400 default

default response

Body

application/json

GwApiResponseEmailChangeResult

POST /api/base/check-email

Request body

application/json

CheckEmailData

Responses

400 default

default response

Body

application/json

GwApiResponseCheckEmailResponse

POST /api/base/check-payment

Responses

400 default

default response

Body

application/json

GwApiResponsePaymentCheckResult

POST /api/base/describe-leaving-form

Responses

400 default

default response

Body

application/json

GwApiResponseLeavingFormDescription

POST /api/base/describe-page

Request body

application/json

PageDescriptionRequest

Responses

400 default

default response

Body

application/json

GwApiResponsePageDescription

POST /api/base/describe-payment

Responses

400 default

default response

Body

application/json

GwApiResponsePaymentDescription

POST /api/base/finish-checkut

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/base/get-eshop-redirect

Request body

application/json

EshopRedirectForm

Responses

400 default

default response

Body

application/json

GwApiResponseRedirectingResult

POST /api/base/finish-checkout-config

Responses

400 default

default response

Body

application/json

GwApiResponseFinishCheckoutConfig

POST /api/base/payment-detail

Responses

400 default

default response

Body

application/json

GwApiResponsePaymentDetail

POST /api/base/methods

Responses

400 default

default response

Body

application/json

GwApiResponsePaymentMethods

POST /api/base/payment-status

Responses

400 default

default response

Body

application/json

GwApiResponsePaymentStatus

POST /api/base/redirect-to-desktop

Request body

application/json

RedirectToDesktopData

Responses

400 default

default response

Body

application/json

GwApiResponseRedirectToDesktopResult

POST /api/base/user-remember

Request body

application/json

RememberUserForm

Responses

400 default

default response

application/json

POST /api/base/void-recurrence

Responses

400 default

default response

Body

application/json

GwApiResponseHashMapStringBoolean

POST /api/bitcoin/checkout

Request body

application/json

BitcointCheckoutForm

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/bitcoin/describe-form

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutFormDescription

POST /api/bnpl/checkout-skippay

Request body

application/json

SkipPayCheckoutForm

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/bnpl/checkout-twisto

Request body

application/json

TwistoCheckoutForm

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/bnpl/describe-skippay-form

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutFormDescription

POST /api/bnpl/describe-twisto-form

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutFormDescription

POST /api/go-pay-wallet/checkout

Request body

application/json

GoPayWalletCheckoutForm

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/go-pay-wallet/describe-checkout-form

Responses

400 default

default response

Body

application/json

GwApiResponseGoPayWalletCheckoutFormDescription

POST /api/go-pay-wallet/describe-form

Responses

400 default

default response

Body

application/json

GwApiResponseGoPayWalletFormDescription

POST /api/installments/capture-installment

Request body

application/json

CaptureInstallmentForm

Responses

400 default

default response

Body

application/json

GwApiResponseObject

POST /api/installments/describe

Responses

400 default

default response

Body

application/json

GwApiResponseInstallmentDescription

POST /api/login/login

Request body

application/json

Login

Responses

400 default

default response

Body

application/json

GwApiResponseLoginResult

POST /api/login/login-via-sca

Responses

400 default

default response

Body

application/json

GwApiResponseMapStringBoolean

POST /api/login/logout

Responses

400 default

default response

Body

application/json

GwApiResponseLogoutResult

POST /api/login/request-login-sms-code

Responses

400 default

default response

Body

application/json

GwApiResponseLoginResult

POST /api/mplatba/checkout

Request body

application/json

MplatbaCheckoutForm

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/mplatba/describe-form

Responses

400 default

default response

Body

application/json

GwApiResponseMplatbaFormDescription

POST /api/psd2/checkout

Request body

application/json

PSD2AccountId

Responses

400 default

default response

Body

application/json

GwApiResponseRedirectingResult

POST /api/psd2/account-list

Responses

400 default

default response

Body

application/json

GwApiResponseListPSD2GWAccount

POST /api/pay-pal/checkout

Request body

application/json

PayPalCheckoutForm

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/pay-pal/describe-form

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutFormDescription

POST /api/paysafecard/checkout

Request body

application/json

PaysafecardCheckoutForm

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/paysafecard/describe-form

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutFormDescription

POST /api/premium-sms/checkout

Request body

application/json

PremiumSmsForm

Responses

400 default

default response

Body

application/json

GwApiResponsePremiumSmsCheckoutResult

POST /api/premium-sms/describe-form

Responses

400 default

default response

Body

application/json

GwApiResponsePremiumSmsFormDescription

POST /api/restart-payment/is-restartable

Responses

400 default

default response

Body

application/json

GwApiResponseRestartablePaymentResult

POST /api/restart-payment/restart

Responses

400 default

default response

Body

application/json

GwApiResponseRestartPaymentResult

POST /api/shopping-review/load

Responses

400 default

default response

Body

application/json

GwApiResponseShoppingReviewForm

POST /api/shopping-review/store

Request body

application/json

ShoppingReviewForm

Responses

400 default

default response

Body

application/json

GwApiResponseMapStringBoolean

POST /api/ui-utils/session-language

Request body

application/json

PaymentSessionLanguageChange

Responses

400 default

default response

Body

application/json

GwApiResponseLanguageChangeResult

POST /api/ui-utils/log-message

Request body

application/json

FrontendLogMessage

Responses

400 default

default response

application/json

POST /api/ui-utils/dcard-brand-prefixes

Responses

400 default

default response

Body

application/json

GwApiResponseMapStringLinkedListHashMapStringObject

POST /api/ui-utils/theme

Responses

400 default

default response

Body

application/json

GwApiResponseThemeDescription

POST /api/ui-utils/card-custom-colors

Responses

400 default

default response

Body

application/json

GwApiResponseMapStringListPaymentCardColour

POST /api/ui-utils/session-languages

Responses

400 default

default response

Body

application/json

GwApiResponsePaymentSessionLanguages

POST /api/ui-utils/resolve-issuer-logo

Request body

application/json

ResolveIssuerLogoForm

Responses

400 default

default response

Body

application/json

GwApiResponseIssuerLogoResult

POST /api/ui-utils/browser-data

Request body

application/json

BrowserDataForm

Responses

400 default

default response

application/json

POST /api/ui-utils/card-custom-metadata

Request body

application/json

SetPaymentCardCustomMetadataForm

Responses

400 default

default response

Body

application/json

GwApiResponseUpdateStoredCardMetadataResult

POST /api/xpay/checkout-apple-pay

Request body

application/json

ApplePayForm

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/xpay/checkout-google-pay

Request body

application/json

GooglePayCheckoutForm

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/xpay/checkout-mastercard-src

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/xpay/checkout-payment-card

Request body

application/json

PaymentCardForm

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/xpay/checkout-payment-card-anonym

Request body

application/json

PaymentCardAnonymForm

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/xpay/checkout-visa-src

Responses

400 default

default response

Body

application/json

GwApiResponseCheckoutResult

POST /api/xpay/delete-payment-card

Request body

application/json

DeletePaymentCardForm

Responses

400 default

default response

Body

application/json

GwApiResponseMapStringString

POST /api/xpay/describe-payment-card-form

Responses

400 default

default response

Body

application/json

GwApiResponsePaymentCardFormDescription

POST /api/xpay/describe-xpay-form

Responses

400 default

default response

Body

application/json

GwApiResponseXPayFormDescription

POST /api/xpay/store-or-remember-card

Request body

application/json

RememberCardForm

Responses

400 default

default response

application/json

POST /api/xpay/validate-apple-pay-merchant

Request body

application/json

ApplePayMerchantValidationForm

Responses

400 default

default response

Body

application/json

GwApiResponseMapStringString

POST /api/initialize

Authentication

paymentsessionid

Initializes the context using the provided paymentsessionid header. Sets a session cookie for subsequent requests.

Request headers

paymentsessionid

string optional

Responses

200 200

Context successfully initialized, cookie set

400 400

Missing or invalid paymentsessionid

500 500

Internal Server Error

Object

imageType

string

base64Data

string

Types: GwApiResponseBankPaymentQrCodeImage

Object

errorType

string

message

string

code

string

field

string

Types: GwApiResponseBankCheckoutFormDescription GwApiResponseBankPaymentQrCodeImage GwApiResponseCheckEmailResponse GwApiResponseCheckoutFormDescription GwApiResponseCheckoutResult GwApiResponseEmailChangeResult GwApiResponseFinishCheckoutConfig GwApiResponseGoPayWalletCheckoutFormDescription GwApiResponseGoPayWalletFormDescription GwApiResponseHashMapStringBoolean GwApiResponseInstallmentDescription GwApiResponseIssuerLogoResult GwApiResponseLanguageChangeResult GwApiResponseLeavingFormDescription GwApiResponseListPSD2GWAccount GwApiResponseLoginResult GwApiResponseLogoutResult GwApiResponseMapStringBoolean GwApiResponseMapStringLinkedListHashMapStringObject GwApiResponseMapStringListPaymentCardColour GwApiResponseMapStringString GwApiResponseMplatbaFormDescription GwApiResponseObject GwApiResponsePageDescription GwApiResponsePaymentCardFormDescription GwApiResponsePaymentCheckResult GwApiResponsePaymentDescription GwApiResponsePaymentDetail GwApiResponsePaymentMethods GwApiResponsePaymentSessionLanguages GwApiResponsePaymentStatus GwApiResponsePremiumSmsCheckoutResult GwApiResponsePremiumSmsFormDescription GwApiResponseRedirectingResult GwApiResponseRedirectToDesktopResult GwApiResponseRestartablePaymentResult GwApiResponseRestartPaymentResult GwApiResponseShoppingReviewForm GwApiResponseThemeDescription GwApiResponseUpdateStoredCardMetadataResult GwApiResponseXPayFormDescription

Object

data

BankPaymentQrCodeImage

errors

Array of GwApiError

Methods: bankPaymentQrCode

Object

width

integer int32

height

integer int32

Methods: bankPaymentQrCode

Object

amount

integer int64

accountNumberReceiverPrefix

string

accountNumberReceiver

string

bankCode

string

bankingUrl

string

bankSwift

BankSwift

variableSymbol

string

iban

string

bic

string

Types: CheckoutResult PremiumSmsCheckoutResult

Object

swift

string

empty

boolean

Types: BankPaymentDescription

Object

state

CheckoutState

errorCode

string

redirectUrl

string

redirectParams

Object

string

redirectMethod

string

createdOfflinePayment

BankPaymentDescription

errorMessage

string

checkoutSubState

string

Enumeration:

PSD2_LATE_PROCESSING

PSD2_NORM_PRIORITY

targetOrigin

string

paymentId

integer int64

paymentSessionState

string

chooseInstallment

boolean

inline

boolean

offlinePayment

BankPaymentDescription

Types: GwApiResponseCheckoutResult

string

Enumeration:

SUCCESS

ERROR

FATAL

WAITING

WAITING_WITH_INFO

REDIRECTING

NOT_INITIALIZED

Types: CheckoutResult PremiumSmsCheckoutResult RedirectToDesktopResult

Object

data

CheckoutResult

errors

Array of GwApiError

Methods: checkoutApplePay checkoutBankPayment checkoutBitcoin checkoutGooglePay checkoutGoPayWallet checkoutMastercardSRC checkoutMplatba checkoutPaymentCard checkoutPaymentCardAnonym checkoutPayPal checkoutPaysafecard checkoutSkippay checkoutTwisto checkoutVisaSRC finishCheckout

Object

address

CustomerAddress

mobilePhone

string

bankSwift

string

Methods: checkoutBankPayment

Object

firstName

string

lastName

string

street

string

city

string

postCode

string

country

string

Types: ApplePayForm BankPaymentCheckoutForm BitcointCheckoutForm GooglePayCheckoutForm GoPayWalletCheckoutForm MplatbaCheckoutForm PaymentCardAnonymForm PaymentCardForm PayPalCheckoutForm PaysafecardCheckoutForm PremiumSmsForm SkipPayCheckoutForm TwistoCheckoutForm

Object

enabled

boolean

enabledBnplTypes

Array of string

defaultBnplType

string

bankDescriptions

Array of BankDescription

bankSwift

string

defaultBankSwift

string

Types: GwApiResponseBankCheckoutFormDescription

Object

type

string

Enumeration:

ONLINE

OFFLINE

PSD2

PSD2_REMEMBERED

name

string

swift

string

bankSwiftCode

string

Types: BankCheckoutFormDescription

Object

data

BankCheckoutFormDescription

errors

Array of GwApiError

Methods: describeBankPaymentForm

Object

email

string

changed

boolean

forwardTo

string

customerRemembered

boolean

loggable

boolean

canLoginToWallet

boolean

logged

boolean

Types: GwApiResponseEmailChangeResult

Object

data

EmailChangeResult

errors

Array of GwApiError

Methods: changeEmail

Object

email

string

emptyEmailAllowed

boolean

Methods: changeEmail

Object

logged

boolean

loggable

boolean

smsSent

boolean

Types: GwApiResponseCheckEmailResponse

Object

data

CheckEmailResponse

errors

Array of GwApiError

Methods: checkEmail

Object

email

string

Methods: checkEmail

Object

data

PaymentCheckResult

errors

Array of GwApiError

Methods: checkPayment

Object

paymentActive

boolean

paymentTimeoutAlert

boolean

Types: GwApiResponsePaymentCheckResult

Object

data

LeavingFormDescription

errors

Array of GwApiError

Methods: describeLeavingForm

Object

canStoreCard

boolean

mustInputMobilePhoneToStoreCard

boolean

Types: GwApiResponseLeavingFormDescription

Object

data

PageDescription

errors

Array of GwApiError

Methods: describePage

Object

path

string

accessible

boolean

forwardTo

string

Types: GwApiResponsePageDescription

Object

path

string

Methods: describePage

Object

color1

string

color2

string

colorText

string

Types: PaymentDescription ThemeDescription

Object

data

PaymentDescription

errors

Array of GwApiError

Methods: describePayment

Object

id

integer int64

maskedPan

string

brand

PaymentCardBrand

expiration

PaymentCardExpiration

cvv2Required

boolean

expired

boolean

customColour

string

Enumeration:

GRADIENT_1

GRADIENT_2

GRADIENT_3

GRADIENT_4

GRADIENT_5

GRADIENT_6

GRADIENT_7

GRADIENT_8

GRADIENT_9

customName

string

enabled

boolean

issuerLogo

string

Types: PaymentCardAnonymFormDescription PaymentCardFormDescription PaymentDescription

string

Enumeration:

VISA_ELECTRON

VISA

MASTERCARD

MAESTRO

UNKNOWN

Types: PaymentCard

Object

month

integer int32

year

integer int32

yearString

string

monthString

string

Types: PaymentCard

Object

paymentSessionState

string

preferredPaymentMethod

PaymentMethodKey

amount

integer int64

currency

string

currencySymbol

string

customerEmail

string

customerMobilePhone

string

disabledLogin

boolean

currencySymbolAfterAmount

boolean

customerRemembered

boolean

logged

boolean

loggable

boolean

paymentCard

PaymentCard

browserDataFetched

boolean

targetName

string

smsSent

boolean

theme

EshopTheme

psd2Remembered

boolean

enabled

boolean

paymentIsAfterCallback

boolean

language

string

eshopName

string

isBrowserDataFetched

boolean

Types: GwApiResponsePaymentDescription

string

Enumeration:

PAYMENT_CARD

BANK_ACCOUNT

PRSMS

MPAYMENT

COUPON

PAYSAFECARD

SUPERCASH

GOPAY

PAYPAL

SKRILL

BITCOIN

MASTERPASS

GPAY

ACCOUNT

APPLE_PAY

TWISTO

SKIPPAY

CLICK_TO_PAY

PSD2

QRPAYMENT

Types: PaymentDescription PaymentMethodInfo

Object

data

RedirectingResult

errors

Array of GwApiError

Methods: checkoutBankPaymentPSD2 getEshopRedirect

Object

state

string

redirectUrl

string

redirectMethod

string

targetOrigin

string

paymentId

integer int64

paymentSessionState

string

inline

boolean

Types: GwApiResponseRedirectingResult

Object

redirectType

string

logParam

string

upperCaseRedirectType

string

Methods: getEshopRedirect

Object

firstWaitingTime

integer int64

maxCount

integer int64

secondWaitingTime

integer int64

startSecondWaitingAt

integer int64

Types: GwApiResponseFinishCheckoutConfig

Object

data

FinishCheckoutConfig

errors

Array of GwApiError

Methods: getFinishCheckoutConfig

Object

data

PaymentDetail

errors

Array of GwApiError

Methods: getPaymentDetail

Object

orderNumber

string

paymentId

integer int64

purchaseOrderItems

PurchaseOrderItems

sellerName

string

Types: GwApiResponsePaymentDetail

Object

symbolicId

string

name

string

amount

integer int64

fee

integer int64

count

integer int64

totalAmountWithCurrency

string

totalAmount

integer int64

Types: PurchaseOrderItems

Object

list

Array of PurchaseOrderItem

Types: PaymentDetail

Object

data

PaymentMethods

errors

Array of GwApiError

Methods: methods

Object

paymentMethod

PaymentMethodKey

enabled

boolean

main

boolean

Types: PaymentMethods

Object

list

Array of PaymentMethodInfo

merchantIdentifier

string

Types: GwApiResponsePaymentMethods

Object

provozovnaId

integer int32

pokladnaId

string

bkp

string

dic

string

fik

string

pkp

string

Types: PaymentStatus

Object

data

PaymentStatus

errors

Array of GwApiError

Methods: paymentStatus

Object

errorType

string

message

string

code

string

Types: PaymentStatus

Object

eetPaymentDescription

EETPaymentDescription

dateAuthorized

string date-time

refreshPaymentUrl

string

recurrentPayment

boolean

recurrenceStopped

boolean

canBeRecurrenceVoided

boolean

paymentError

PaymentError

recurrenceCycle

string

recurrencePeriod

integer int32

Types: GwApiResponsePaymentStatus

Object

data

RedirectToDesktopResult

errors

Array of GwApiError

Methods: redirectToDesktop

Object

state

CheckoutState

redirectUrl

string

redirectMethod

string

targetOrigin

string

paymentId

integer int64

paymentSessionState

string

inline

boolean

Types: GwApiResponseRedirectToDesktopResult

Object

preferredPaymentMethod

string

Methods: redirectToDesktop

Object

rememberUser

boolean

Methods: setUserRemember

Object

data

Object

boolean

errors

Array of GwApiError

Methods: voidRecurrence

Object

address

CustomerAddress

mobilePhone

string

Methods: checkoutBitcoin

Object

enabled

boolean

enabledBnplTypes

Array of string

defaultBnplType

string

Types: GwApiResponseCheckoutFormDescription

Object

data

CheckoutFormDescription

errors

Array of GwApiError

Methods: describeBitcoinForm describePayPalForm describePaysafecardForm describeSkippayForm describeTwistoForm

Object

address

CustomerAddress

mobilePhone

string

type

string

Methods: checkoutSkippay

Object

address

CustomerAddress

mobilePhone

string

type

string

Methods: checkoutTwisto

Object

address

CustomerAddress

mobilePhone

string

Methods: checkoutGoPayWallet

Object

amountValid

boolean

balance

integer int64

Types: GwApiResponseGoPayWalletCheckoutFormDescription

Object

data

GoPayWalletCheckoutFormDescription

errors

Array of GwApiError

Methods: describeGoPayWalletCheckoutForm

Object

enabled

boolean

enabledBnplTypes

Array of string

defaultBnplType

string

canLoginToWallet

boolean

fallbackUrl

string

Types: GwApiResponseGoPayWalletFormDescription

Object

data

GoPayWalletFormDescription

errors

Array of GwApiError

Methods: describeGoPayWalletForm

Object

data

Object

errors

Array of GwApiError

Methods: captureInstallment

Object

proposalId

integer int64

numberOfInstallment

integer int64

Methods: captureInstallment

Object

data

InstallmentDescription

errors

Array of GwApiError

Methods: describeInstallments

Object

selectedProposalId

integer int64

paymentOption

string

installmentType

string

interestRate

integer int64

installmentFeeAmount

integer int64

annualPercentageRate

integer int64

maxNumberInstallment

integer int64

minNumberInstallment

integer int64

totalAmountDue

integer int64

proposalList

Array of InstallmentProposal

Types: GwApiResponseInstallmentDescription

Object

id

integer int64

annualPercentageRate

integer int64

firstInstallmentAmount

integer int64

installmentFeeAmount

integer int64

interestRate

integer int64

numberOfInstallment

integer int64

installmentProposalId

integer int64

subsequentInstallmentAmount

integer int64

totalAmountDue

integer int64

Types: InstallmentDescription

Object

data

LoginResult

errors

Array of GwApiError

Methods: login requestLoginSmsCode

Object

logged

boolean

smsSent

boolean

Types: GwApiResponseLoginResult

Object

code

string

Methods: login

Object

data

Object

boolean

errors

Array of GwApiError

Methods: loginViaSca storeShoppingReview

Object

data

LogoutResult

errors

Array of GwApiError

Methods: logout

Object

state

string

redirectUrl

string

redirectMethod

string

inline

boolean

Types: GwApiResponseLogoutResult

Object

address

CustomerAddress

mobilePhone

string

mplatbaMobilePhone

string

Methods: checkoutMplatba

Object

data

MplatbaFormDescription

errors

Array of GwApiError

Methods: describeMplatbaForm

Object

enabled

boolean

enabledBnplTypes

Array of string

defaultBnplType

string

inputedMobilePhone

string

editable

boolean

Types: GwApiResponseMplatbaFormDescription

Object

id

string

Methods: checkoutBankPaymentPSD2

Object

data

Array of PSD2GWAccount

errors

Array of GwApiError

Methods: getPSD2AccountList

Object

accountName

string

accountNumberIBAN

string

accountNumber

string

hasFunds

boolean

availableFunds

integer int64

id

string

bic

string

Types: GwApiResponseListPSD2GWAccount

Object

address

CustomerAddress

mobilePhone

string

Methods: checkoutPayPal

Object

address

CustomerAddress

mobilePhone

string

Methods: checkoutPaysafecard

Object

data

PremiumSmsCheckoutResult

errors

Array of GwApiError

Methods: checkoutPremiumSMS

Object

state

CheckoutState

errorCode

string

redirectUrl

string

redirectParams

Object

string

redirectMethod

string

createdOfflinePayment

BankPaymentDescription

errorMessage

string

checkoutSubState

string

Enumeration:

PSD2_LATE_PROCESSING

PSD2_NORM_PRIORITY

targetOrigin

string

paymentId

integer int64

paymentSessionState

string

chooseInstallment

boolean

premiumSmsTargetNumber

string

message

string

inline

boolean

offlinePayment

BankPaymentDescription

Types: GwApiResponsePremiumSmsCheckoutResult

Object

address

CustomerAddress

mobilePhone

string

premiumSmsMobilePhone

string

coupon

string

Methods: checkoutPremiumSMS

Object

data

PremiumSmsFormDescription

errors

Array of GwApiError

Methods: describePremiumSmsForm

Object

enabled

boolean

enabledBnplTypes

Array of string

defaultBnplType

string

amountValid

boolean

canInputCoupon

boolean

inputedMobilePhone

string

editable

boolean

Types: GwApiResponsePremiumSmsFormDescription

Object

data

RestartablePaymentResult

errors

Array of GwApiError

Methods: isPaymentRestartable

Object

timeoutForRestart

string date-time

userTimeoutSeconds

integer int64

paymentRestartable

boolean

Types: GwApiResponseRestartablePaymentResult

Object

data

RestartPaymentResult

errors

Array of GwApiError

Methods: restartPayment

Object

createdRestartedPayment

boolean

Types: GwApiResponseRestartPaymentResult

Object

data

ShoppingReviewForm

errors

Array of GwApiError

Methods: loadShoppingReview

Object

userComment

string

shopCredibilityRating

integer int32

satisfactionRating

integer int32

reviewerEmail

string

returnToShopQA

boolean

paymentSessionId

integer int64

deliveryRating

integer int32

Methods: storeShoppingReview

Types: GwApiResponseShoppingReviewForm

Object

data

LanguageChangeResult

errors

Array of GwApiError

Methods: changePaymentSessionLanguage

Object

changed

boolean

currentPaymentSessionLanguage

PaymentSessionLanguage

redirectUrl

string

inline

boolean

Types: GwApiResponseLanguageChangeResult

string

Enumeration:

CZ

SK

EN

DE

RU

FR

HU

PL

RO

BG

HR

IT

ES

UK

EE

LT

LV

SI

PT

Types: LanguageChangeResult

Object

paymentSessionLanguage

string

Methods: changePaymentSessionLanguage

Object

type

string

data

string

url

string

Methods: frontendLogMessage

Object

data

Object

Array

Object

errors

Array of GwApiError

Methods: getPaymentCardBrandPrefixes

Object

data

ThemeDescription

errors

Array of GwApiError

Methods: getTheme

Object

theme

EshopTheme

logo

string

christmas

boolean

Types: GwApiResponseThemeDescription

Object

data

Object

Array

string

Enumeration:

GRADIENT_1

GRADIENT_2

GRADIENT_3

GRADIENT_4

GRADIENT_5

GRADIENT_6

GRADIENT_7

GRADIENT_8

GRADIENT_9

errors

Array of GwApiError

Methods: paymentCardCustomColours

Object

data

PaymentSessionLanguages

errors

Array of GwApiError

Methods: paymentSessionLanguages

Object

list

Array of string

Types: GwApiResponsePaymentSessionLanguages

Object

data

IssuerLogoResult

errors

Array of GwApiError

Methods: resolveIssuerLogoFromBin

Object

issuerLogo

string

Types: GwApiResponseIssuerLogoResult

Object

bin

string

Methods: resolveIssuerLogoFromBin

Object

width

integer int32

colorDepth

integer int32

height

integer int32

javaEnabled

boolean

language

string

timezone

string

userAgent

string

Methods: setBrowserData

Object

data

UpdateStoredCardMetadataResult

errors

Array of GwApiError

Methods: setPaymentCardCustomMetadata

Object

sucessfullyStored

boolean

Types: GwApiResponseUpdateStoredCardMetadataResult

Object

paymentCardId

integer int64

customColour

string

customName

string

Methods: setPaymentCardCustomMetadata

Object

address

CustomerAddress

mobilePhone

string

Methods: checkoutApplePay

Object

address

CustomerAddress

mobilePhone

string

Methods: checkoutGooglePay

Object

address

CustomerAddress

mobilePhone

string

selectedCardId

integer int64

inputCvc

string

remember

boolean

requestSecureCard

boolean

Methods: checkoutPaymentCard

Object

address

CustomerAddress

mobilePhone

string

remember

boolean

secureCardToken

boolean

secureCardTokenNotNull

boolean

Methods: checkoutPaymentCardAnonym

Object

data

Object

string

errors

Array of GwApiError

Methods: deletePaymentCard validateApplePayMerchant

Object

paymentCardId

integer int64

Methods: deletePaymentCard

Object

data

PaymentCardFormDescription

errors

Array of GwApiError

Methods: describePaymentCardForm

Object

enabled

boolean

enabledBnplTypes

Array of string

defaultBnplType

string

cardInputFormUrl

string

cards

Array of PaymentCard

Types: GwApiResponsePaymentCardFormDescription

Object

enabled

boolean

enabledBnplTypes

Array of string

defaultBnplType

string

applePayPaymentRequest

ApplePayPaymentRequest

merchantDisplayName

string

merchantIdentifier

string

wicketJsCallbackUrl

string

initiativeContext

string

currency

string

checkoutFormUrl

string

applepayVersion

integer int32

curency

string

Types: XPayFormDescription

Object

merchantCapabilities

Array of string

supportedNetworks

Array of string

countryCode

string

currencyCode

string

requiredBillingContactFields

Array of string

requiredShippingContactFields

Array of string

shippingType

string

applicationData

string

total

ApplePayPaymentRequestTotal

Types: ApplePayFormDescription

Object

label

string

amount

string

type

string

Types: ApplePayPaymentRequest

Object

authenticationMethodType

string

Enumeration:

SMS_OTP

EMAIL_OTP

3DS

APP_AUTHENTICATION

authenticationSubject

string

Enumeration:

CARDHOLDER

CONSUMER

CARD

uriData

string

authenticationCredentialReference

string

methodAttributes

MethodAttributes

Types: AuthenticationPreferences CheckoutData

Object

authenticationMethods

Array of AuthenticationMethod

payloadRequested

string

Enumeration:

AUTHENTICATED

NOT_AUTHENTICATED

Types: DpaTransactionOptions

Object

dpaTransactionOptions

DpaTransactionOptions

authenticationMethod

AuthenticationMethod

complianceSettings

ComplianceSettings

Types: SRCFormDescription

Object

complianceType

string

Enumeration:

TERMS_AND_CONDITIONS

PRIVACY_POLICY

REMEMBER_ME

uri

string

Types: ComplianceSettings

Object

complianceResources

Array of ComplianceResource

Types: CheckoutData

Object

checkoutOrchestrator

string

customFlowType

string

Types: DpaTransactionOptions

Object

srciDpaId

string

dpaPresentationName

string

dpaUri

string

Types: InitData

Object

dpaLocale

string

dpaAcceptedBillingCountries

Array of string

dpaAcceptedShipping

Array of string

dpaBillingPreference

string

Enumeration:

ALL

POSTAL_COUNTRY

NONE

dpaShippingPreference

string

Enumeration:

ALL

POSTAL_COUNTRY

NONE

authenticationPreferences

AuthenticationPreferences

acquirerMerchantId

string

acquirerBIN

string

merchantName

string

consumerNameRequested

boolean

consumerEmailAddressRequested

boolean

consumerPhoneNumberRequested

boolean

paymentOptions

PaymentOptions

reviewAction

string

checkoutDescription

string

transactionType

string

orderType

string

payloadTypeIndicator

string

Enumeration:

FULL

SUMMARY

PAYMENT

NON_PAYMENT

NONE

transactionAmount

TransactionAmount

merchantOrderId

string

merchantCategoryCode

string

merchantCountryCode

string

threeDSInputData

ThreeDSInputData

customInputData

CustomInputData

Types: CheckoutData InitData

Object

enabled

boolean

enabledBnplTypes

Array of string

defaultBnplType

string

allowedCardMethods

string

amount

string

currency

string

environment

string

gateway

string

gatewayMerchantId

string

merchantId

string

merchantName

string

merchantOrigin

string

checkoutFormUrl

string

allowedCardNetworks

Array of string

merchangName

string

Types: XPayFormDescription

Object

data

XPayFormDescription

errors

Array of GwApiError

Methods: describeXPayForm

Object

srciTransactionId

string

srcInitiatorId

string

srciDpaId

string

dpaTransactionOptions

DpaTransactionOptions

dpaData

DpaData

Types: SRCFormDescription

Object

payloadRequested

string

Enumeration:

AUTHENTICATED

NON_AUTHENTICATED

Types: MCDpaTransactionOptions

Object

complianceSettings

MCComplianceSettings

Types: SRCFormDescription

Object

complianceType

string

Enumeration:

TERMS_AND_CONDITIONS

PRIVACY_POLICY

REMEMBER_ME

uri

string

version

string

datePublished

string

Types: MCComplianceSettings

Object

complianceResources

Array of MCComplianceResource

Types: MCCheckoutData

Object

com.mastercard.dcfExperience

string

Enumeration:

WITHIN_CHECKOUT

PAYMENT_SETTINGS

Types: MCDpaTransactionOptions

Object

dpaLocale

string

dpaAcceptedBillingCountries

Array of string

dpaAcceptedShippingCountries

Array of string

dpaBillingPreference

string

Enumeration:

FULL

NONE

dpaShippingPreference

string

Enumeration:

FULL

NONE

consumerNameRequested

boolean

consumerEmailAddressRequested

boolean

consumerPhoneNumberRequested

boolean

paymentOptions

MCPaymentOptions

transactionType

string

transactionAmount

MCTransactionAmount

confirmPayment

boolean

customInputData

MCCustomInputData

authenticationPreferences

MCAuthenticationPreferences

guestCheckout

boolean

Types: MCInitData

Object

srciTransactionId

string

srcInitiatorId

string

srciDpaId

string

dpaTransactionOptions

MCDpaTransactionOptions

Types: SRCFormDescription

Object

dpaDynamicDataTtlMinutes

integer int32

dynamicDataType

string

Types: MCDpaTransactionOptions

Object

transactionAmount

string

transactionCurrencyCode

string

Enumeration:

CZK

EUR

BEF

KPW

SAR

TRL

XBB

ZAR

VEF

NZD

RUB

JPY

DZD

BOB

TPE

HUF

NAD

JOD

UYU

XPD

YUM

ZMK

DOP

PTE

BZD

KRW

RON

MMK

LKR

CLF

NGN

NOK

SRD

LRD

TWD

BWP

LTL

ESP

PAB

PHP

XPF

AUD

HRK

BHD

DEM

XBC

LUF

XAF

XDR

MXN

XXX

BOV

ARS

BDT

XBD

AWG

SVC

SLL

GNF

ZWR

SIT

KYD

TND

LBP

XUA

PKR

SYP

CUC

ROL

ITL

UGX

SKK

XTS

MNT

NPR

ATS

GWP

ZWD

ILS

AZM

SDD

XCD

CUP

KES

TTD

CDF

DKK

HKD

ERN

MAD

MXV

MGA

RWF

PYG

DJF

EGP

VND

ZMW

GBP

BYR

SBD

IRR

MTL

CYP

KGS

ADP

XOF

SSP

AED

MZN

VUV

GRD

XAU

XFU

TJS

GHS

IDR

UAH

USS

GIP

AZN

BGN

XBA

LSL

CLP

NIO

CHF

KHR

AFA

BND

SEK

YER

ETB

TZS

BYB

FRF

MDL

AFN

HTG

SZL

KWD

HNL

GYD

MRO

ALL

MUR

SRG

QAR

LYD

TMT

XSU

BBD

PLN

AOA

KZT

STD

PGK

CRC

MGF

ZWL

CSD

BSD

LVL

XFO

VEB

RUR

EEK

CNY

XPT

SOS

FIM

AYM

BGL

USD

BRL

COP

CVE

ANG

PEN

GMD

BAM

ZWN

MWK

MYR

TOP

RSD

TRY

SDG

JMD

SHP

BIF

BTN

WST

IQD

SGD

MVR

MKD

UZS

INR

MZM

XAG

IEP

GEL

USN

BMD

TMM

CAD

NLG

AMD

FJD

GHC

LAK

MOP

GTQ

THB

OMR

ISK

SCR

KMF

FKP

Types: MCDpaTransactionOptions

Object

challengeIndicator

string

Enumeration:

01

02

03

04

05

06

07

08

09

otpValue

string

stepUpIdentifier

string

Types: AuthenticationMethod

Object

enabled

boolean

enabledBnplTypes

Array of string

defaultBnplType

string

cardInputFormUrl

string

paymentCard

PaymentCard

isxPayShortcut

boolean

canStoreCard

boolean

Types: XPayFormDescription

Object

dpaDynamicDataTTLMinutes

integer int32

dynamicDataType

string

dpaPanRequested

boolean

Types: DpaTransactionOptions

Object

enabled

boolean

enabledBnplTypes

Array of string

defaultBnplType

string

visaJsSdkUrl

string

visaInitData

InitData

visaCheckoutData

CheckoutData

checkoutFormUrl

string

cardInputFormUrl

string

mcJsSdkUrl

string

mcInitData

MCInitData

mcCheckoutData

MCCheckoutData

timeout

integer int64

Types: XPayFormDescription

Object

requestorId

string

acquirerId

string

acquirerMid

string

Types: DpaTransactionOptions

Object

transactionAmount

string

transactionCurrencyCode

string

Enumeration:

CZK

EUR

BEF

KPW

SAR

TRL

XBB

ZAR

VEF

NZD

RUB

JPY

DZD

BOB

TPE

HUF

NAD

JOD

UYU

XPD

YUM

ZMK

DOP

PTE

BZD

KRW

RON

MMK

LKR

CLF

NGN

NOK

SRD

LRD

TWD

BWP

LTL

ESP

PAB

PHP

XPF

AUD

HRK

BHD

DEM

XBC

LUF

XAF

XDR

MXN

XXX

BOV

ARS

BDT

XBD

AWG

SVC

SLL

GNF

ZWR

SIT

KYD

TND

LBP

XUA

PKR

SYP

CUC

ROL

ITL

UGX

SKK

XTS

MNT

NPR

ATS

GWP

ZWD

ILS

AZM

SDD

XCD

CUP

KES

TTD

CDF

DKK

HKD

ERN

MAD

MXV

MGA

RWF

PYG

DJF

EGP

VND

ZMW

GBP

BYR

SBD

IRR

MTL

CYP

KGS

ADP

XOF

SSP

AED

MZN

VUV

GRD

XAU

XFU

TJS

GHS

IDR

UAH

USS

GIP

AZN

BGN

XBA

LSL

CLP

NIO

CHF

KHR

AFA

BND

SEK

YER

ETB

TZS

BYB

FRF

MDL

AFN

HTG

SZL

KWD

HNL

GYD

MRO

ALL

MUR

SRG

QAR

LYD

TMT

XSU

BBD

PLN

AOA

KZT

STD

PGK

CRC

MGF

ZWL

CSD

BSD

LVL

XFO

VEB

RUR

EEK

CNY

XPT

SOS

FIM

AYM

BGL

USD

BRL

COP

CVE

ANG

PEN

GMD

BAM

ZWN

MWK

MYR

TOP

RSD

TRY

SDG

JMD

SHP

BIF

BTN

WST

IQD

SGD

MVR

MKD

UZS

INR

MZM

XAG

IEP

GEL

USN

BMD

TMM

CAD

NLG

AMD

FJD

GHC

LAK

MOP

GTQ

THB

OMR

ISK

SCR

KMF

FKP

Types: DpaTransactionOptions

Object

applePay

ApplePayFormDescription

googlePay

GooglePayFormDescription

paymentCard

PaymentCardAnonymFormDescription

src

SRCFormDescription

cardInputFormUrl

string

checkoutFormUrl

string

Types: GwApiResponseXPayFormDescription

Object

inputMobilePhone

string

inputEmail

string

Methods: storeOrRememberCard

Object

validationUrl

string

Methods: validateApplePayMerchant