From 019c4d38ca00eff55000ee7a3e51b01781c0ffe4 Mon Sep 17 00:00:00 2001 From: aleksei Date: Sat, 24 Apr 2021 11:54:43 +0200 Subject: [PATCH] Updated YAML specs --- yaml/AccountService-v4.yaml | 65 - yaml/AccountService-v5.yaml | 78 - yaml/AccountService-v6.yaml | 78 - yaml/BalancePlatformService-v1.yaml | 219 +- yaml/BinLookupService-v40.yaml | 50 + yaml/BinLookupService-v50.yaml | 50 + yaml/CheckoutService-v37.yaml | 2612 ++++++++++++++-- yaml/CheckoutService-v40.yaml | 2732 +++++++++++++--- yaml/CheckoutService-v41.yaml | 2750 +++++++++++++--- yaml/CheckoutService-v46.yaml | 2746 +++++++++++++--- yaml/CheckoutService-v49.yaml | 2753 +++++++++++++--- yaml/CheckoutService-v50.yaml | 2781 ++++++++++++++--- yaml/CheckoutService-v51.yaml | 2781 ++++++++++++++--- yaml/CheckoutService-v52.yaml | 2781 ++++++++++++++--- yaml/CheckoutService-v53.yaml | 2781 ++++++++++++++--- yaml/CheckoutService-v64.yaml | 2781 ++++++++++++++--- yaml/CheckoutService-v65.yaml | 2781 ++++++++++++++--- yaml/CheckoutService-v66.yaml | 2781 ++++++++++++++--- yaml/CheckoutService-v67.yaml | 2775 +++++++++++++--- yaml/FundService-v3.yaml | 27 +- yaml/FundService-v5.yaml | 25 +- yaml/FundService-v6.yaml | 25 +- yaml/HopService-v1.yaml | 28 + yaml/HopService-v5.yaml | 28 + yaml/HopService-v6.yaml | 28 + yaml/MarketPayNotificationService-v3.yaml | 76 +- yaml/MarketPayNotificationService-v4.yaml | 82 +- yaml/MarketPayNotificationService-v5.yaml | 93 +- yaml/MarketPayNotificationService-v6.yaml | 93 +- yaml/NotificationConfigurationService-v1.yaml | 46 + yaml/NotificationConfigurationService-v2.yaml | 46 + yaml/NotificationConfigurationService-v3.yaml | 46 + yaml/NotificationConfigurationService-v4.yaml | 46 + yaml/NotificationConfigurationService-v5.yaml | 37 + yaml/NotificationConfigurationService-v6.yaml | 37 + yaml/PaymentService-v25.yaml | 158 +- yaml/PaymentService-v30.yaml | 201 +- yaml/PaymentService-v40.yaml | 273 +- yaml/PaymentService-v46.yaml | 273 +- yaml/PaymentService-v49.yaml | 273 +- yaml/PaymentService-v50.yaml | 273 +- yaml/PaymentService-v51.yaml | 285 +- yaml/PaymentService-v52.yaml | 285 +- yaml/PaymentService-v64.yaml | 285 +- yaml/PayoutService-v30.yaml | 187 +- yaml/PayoutService-v40.yaml | 197 +- yaml/PayoutService-v50.yaml | 197 +- yaml/PayoutService-v51.yaml | 197 +- yaml/PayoutService-v52.yaml | 197 +- yaml/PayoutService-v64.yaml | 197 +- 50 files changed, 32189 insertions(+), 8427 deletions(-) diff --git a/yaml/AccountService-v4.yaml b/yaml/AccountService-v4.yaml index 31d3639..91e32aa 100644 --- a/yaml/AccountService-v4.yaml +++ b/yaml/AccountService-v4.yaml @@ -279,8 +279,6 @@ paths: examples: business: $ref: '#/components/examples/post-createAccountHolder-business' - individual: - $ref: '#/components/examples/post-createAccountHolder-individual' schema: $ref: '#/components/schemas/CreateAccountHolderRequest' responses: @@ -293,9 +291,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -872,10 +867,6 @@ paths: examples: general: $ref: '#/components/examples/post-updateAccountHolder-general' - bankAccountDetails: - $ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails' - addShareholders: - $ref: '#/components/examples/post-updateAccountHolder-addShareholders' businessDetails: $ref: '#/components/examples/post-updateAccountHolder-businessDetails' schema: @@ -897,9 +888,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -3101,21 +3089,6 @@ components: email: test@adyen.com webAddress: https://www.your-website.com legalEntity: Business - post-createAccountHolder-individual: - summary: Create an individual account holder - value: - accountHolderCode: GENERATE_CODE - accountHolderDetails: - email: tim@green.com - individualDetails: - name: - firstName: Tim - gender: MALE - lastName: Green - address: - country: US - webAddress: https://www.your-website.com - legalEntity: Individual post-deleteBankAccounts-basic: summary: Delete bank accounts value: @@ -3162,44 +3135,6 @@ components: payoutSchedule: schedule: WEEKLY action: CLOSE - post-updateAccountHolder-addShareholders: - summary: Add shareholders - value: - accountHolderCode: CODE_OF_ACCOUNT_HOLDER - accountHolderDetails: - bankAccountDetails: [] - businessDetails: - legalBusinessName: legalBusinessName - shareholders: - - ShareholderContact: - email: testEmail@gmail.com - personalData: - idNumber: '12345' - taxId: taxid - post-updateAccountHolder-bankAccountDetails: - summary: Update bank account details - value: - accountHolderCode: CODE_OF_ACCOUNT_HOLDER - accountHolderDetails: - email: tim@green.com - individualDetails: - name: - firstName: Tim - gender: MALE - lastName: Green - bankAccountDetails: - - BankAccountDetail: - accountNumber: '1678116852' - branchCode: '053101273' - countryCode: US - currencyCode: USD - ownerName: Tim Green - ownerHouseNumberOrName: '100' - ownerStreet: Main Street - ownerPostalCode: 02894 - ownerCity: Springfield - ownerState: AZ - ownerCountryCode: US post-updateAccountHolder-businessDetails: summary: Update business details value: diff --git a/yaml/AccountService-v5.yaml b/yaml/AccountService-v5.yaml index ecd85cf..cea4bfa 100644 --- a/yaml/AccountService-v5.yaml +++ b/yaml/AccountService-v5.yaml @@ -346,8 +346,6 @@ paths: examples: business: $ref: '#/components/examples/post-createAccountHolder-business' - individual: - $ref: '#/components/examples/post-createAccountHolder-individual' schema: $ref: '#/components/schemas/CreateAccountHolderRequest' responses: @@ -360,9 +358,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1005,10 +1000,6 @@ paths: examples: general: $ref: '#/components/examples/post-updateAccountHolder-general' - bankAccountDetails: - $ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails' - addShareholders: - $ref: '#/components/examples/post-updateAccountHolder-addShareholders' businessDetails: $ref: '#/components/examples/post-updateAccountHolder-businessDetails' schema: @@ -1030,9 +1021,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -3543,21 +3531,6 @@ components: email: test@email.com webAddress: https://www.your-website.com legalEntity: Business - post-createAccountHolder-individual: - summary: Create an individual account holder - value: - accountHolderCode: GENERATE_CODE - accountHolderDetails: - email: tim@green.com - individualDetails: - name: - firstName: Tim - gender: MALE - lastName: Green - address: - country: US - webAddress: https://www.your-website.com - legalEntity: Individual post-deleteBankAccounts-basic: summary: Delete bank accounts value: @@ -3610,57 +3583,6 @@ components: payoutSchedule: schedule: WEEKLY action: CLOSE - post-updateAccountHolder-addShareholders: - summary: Add shareholders - value: - accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE - accountHolderDetails: - businessDetails: - shareholders: - - name: - firstName: Alice - gender: FEMALE - lastName: Fields - address: - city: San Francisco - country: US - houseNumberOrName: '274' - postalCode: '94107' - stateOrProvince: CA - street: Brannan - email: testshareholder2@email.com - personalData: - dateOfBirth: '1970-01-01' - documentData: - - number: '1234567890' - type: ID - taxId: '123456789' - email: test@email.com - fullPhoneNumber: '+14154890281' - webAddress: http://www.accountholderwebsite.com - post-updateAccountHolder-bankAccountDetails: - summary: Update bank account details - value: - accountHolderCode: CODE_OF_ACCOUNT_HOLDER - accountHolderDetails: - email: tim@green.com - individualDetails: - name: - firstName: Tim - gender: MALE - lastName: Green - bankAccountDetails: - - accountNumber: '1678116852' - branchCode: '053101273' - countryCode: US - currencyCode: USD - ownerName: Tim Green - ownerHouseNumberOrName: '100' - ownerStreet: Main Street - ownerPostalCode: 02894 - ownerCity: Springfield - ownerState: AZ - ownerCountryCode: US post-updateAccountHolder-businessDetails: summary: Update business details value: diff --git a/yaml/AccountService-v6.yaml b/yaml/AccountService-v6.yaml index 957a690..b625842 100644 --- a/yaml/AccountService-v6.yaml +++ b/yaml/AccountService-v6.yaml @@ -346,8 +346,6 @@ paths: examples: business: $ref: '#/components/examples/post-createAccountHolder-business' - individual: - $ref: '#/components/examples/post-createAccountHolder-individual' schema: $ref: '#/components/schemas/CreateAccountHolderRequest' responses: @@ -360,9 +358,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1005,10 +1000,6 @@ paths: examples: general: $ref: '#/components/examples/post-updateAccountHolder-general' - bankAccountDetails: - $ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails' - addShareholders: - $ref: '#/components/examples/post-updateAccountHolder-addShareholders' businessDetails: $ref: '#/components/examples/post-updateAccountHolder-businessDetails' schema: @@ -1030,9 +1021,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -3564,21 +3552,6 @@ components: email: test@email.com webAddress: https://www.your-website.com legalEntity: Business - post-createAccountHolder-individual: - summary: Create an individual account holder - value: - accountHolderCode: GENERATE_CODE - accountHolderDetails: - email: tim@green.com - individualDetails: - name: - firstName: Tim - gender: MALE - lastName: Green - address: - country: US - webAddress: https://www.your-website.com - legalEntity: Individual post-deleteBankAccounts-basic: summary: Delete bank accounts value: @@ -3631,57 +3604,6 @@ components: payoutSchedule: schedule: WEEKLY action: CLOSE - post-updateAccountHolder-addShareholders: - summary: Add shareholders - value: - accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE - accountHolderDetails: - businessDetails: - shareholders: - - name: - firstName: Alice - gender: FEMALE - lastName: Fields - address: - city: San Francisco - country: US - houseNumberOrName: '274' - postalCode: '94107' - stateOrProvince: CA - street: Brannan - email: testshareholder2@email.com - personalData: - dateOfBirth: '1970-01-01' - documentData: - - number: '1234567890' - type: ID - taxId: '123456789' - email: test@email.com - fullPhoneNumber: '+14154890281' - webAddress: http://www.accountholderwebsite.com - post-updateAccountHolder-bankAccountDetails: - summary: Update bank account details - value: - accountHolderCode: CODE_OF_ACCOUNT_HOLDER - accountHolderDetails: - email: tim@green.com - individualDetails: - name: - firstName: Tim - gender: MALE - lastName: Green - bankAccountDetails: - - accountNumber: '1678116852' - branchCode: '053101273' - countryCode: US - currencyCode: USD - ownerName: Tim Green - ownerHouseNumberOrName: '100' - ownerStreet: Main Street - ownerPostalCode: 02894 - ownerCity: Springfield - ownerState: AZ - ownerCountryCode: US post-updateAccountHolder-businessDetails: summary: Update business details value: diff --git a/yaml/BalancePlatformService-v1.yaml b/yaml/BalancePlatformService-v1.yaml index e375eb2..879ea4a 100644 --- a/yaml/BalancePlatformService-v1.yaml +++ b/yaml/BalancePlatformService-v1.yaml @@ -98,9 +98,6 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -253,9 +250,6 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -414,9 +408,6 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -765,7 +756,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DocumentInfo' + $ref: '#/components/schemas/Document' responses: '200': content: @@ -1461,11 +1452,6 @@ paths: requestBody: content: application/json: - examples: - createVirtualCard: - $ref: '#/components/examples/post-paymentInstruments-createVirtualCard' - createPhysicalCard: - $ref: '#/components/examples/post-paymentInstruments-createPhysicalCard' schema: $ref: '#/components/schemas/PaymentInstrumentInfo' responses: @@ -1481,9 +1467,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1499,27 +1482,18 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. @@ -1606,11 +1580,6 @@ paths: requestBody: content: application/json: - examples: - updatePaymentInstrumentStatus: - $ref: '#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentStatus' - updatePaymentInstrumentBalanceAccount: - $ref: '#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount' schema: $ref: '#/components/schemas/PaymentInstrumentUpdateRequest' parameters: @@ -1624,18 +1593,12 @@ paths: '200': content: application/json: - examples: - success-200: - $ref: '#/components/examples/patch-paymentInstruments-id-success-200' schema: $ref: '#/components/schemas/PaymentInstrument' description: OK - the request has succeeded. '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1651,29 +1614,18 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - invalidData-422: - $ref: '#/components/examples/patch-paymentInstruments-id-invalidData-422' - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. @@ -1766,9 +1718,6 @@ paths: requestBody: content: application/json: - examples: - createTransactionRule: - $ref: '#/components/examples/post-transactionRules-createTransactionRule' schema: $ref: '#/components/schemas/TransactionRuleInfo' responses: @@ -1784,9 +1733,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. @@ -1811,9 +1757,6 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -2032,9 +1975,6 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. @@ -2926,58 +2866,13 @@ components: description: "The type of document. The possible values depend on the legal\ \ entity `type`.\n\n* For `type` **organization**, the values can be **proofOfAddress**,\ \ **registrationDocument**, **taxDocument**. \n\n* For `type` **individual**,\ - \ the values can be **drivingLicence**, **identityCard**, **passport**,\ + \ the values can be **driversLicense**, **identityCard**, **passport**,\ \ **proofOfNationalIdNumber**, **proofOfResidency**, **ssn**.\n\nWhen\ \ uploading a document owned by a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner),\ \ use **bankStatement**." enum: - bankStatement - - drivingLicense - - identityCard - - passport - - proofOfAddress - - proofOfNationalIdNumber - - proofOfResidency - - registrationDocument - - ssn - - taxDocument - type: string - DocumentInfo: - properties: - attachment: - description: Contains the document. - $ref: '#/components/schemas/Attachment' - description: - description: Your description of the document. - type: string - expiryDate: - description: The expiry date of the document, in YYYY-MM-DD format. - type: string - issuerCountry: - description: The country where the document was issued, in the two-character - [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - format. For example, **US**. - type: string - issuerState: - description: The state or province where the document was issued. - type: string - number: - description: The number in the document. - type: string - owner: - description: Contains information about the resource that owns the document. - $ref: '#/components/schemas/Entity' - type: - description: "The type of document. The possible values depend on the legal\ - \ entity `type`.\n\n* For `type` **organization**, the values can be **proofOfAddress**,\ - \ **registrationDocument**, **taxDocument**. \n\n* For `type` **individual**,\ - \ the values can be **drivingLicence**, **identityCard**, **passport**,\ - \ **proofOfNationalIdNumber**, **proofOfResidency**, **ssn**.\n\nWhen\ - \ uploading a document owned by a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner),\ - \ use **bankStatement**." - enum: - - bankStatement - - drivingLicense + - driversLicense - identityCard - passport - proofOfAddress @@ -3047,13 +2942,13 @@ components: description: "The type of document. The possible values depend on the legal\ \ entity `type`.\n\n* For `type` **organization**, the values can be **proofOfAddress**,\ \ **registrationDocument**, **taxDocument**. \n\n* For `type` **individual**,\ - \ the values can be **drivingLicence**, **identityCard**, **passport**,\ + \ the values can be **driversLicense**, **identityCard**, **passport**,\ \ **proofOfNationalIdNumber**, **proofOfResidency**, **ssn**.\n\nWhen\ \ uploading a document owned by a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner),\ \ use **bankStatement**." enum: - bankStatement - - drivingLicense + - driversLicense - identityCard - passport - proofOfAddress @@ -3722,7 +3617,7 @@ components: merchantAccount: description: The merchant account that will be the source of funds. You can only use this if you are processing payments with Adyen. This can - only be used for sweeps of `type` **pull** and `schedule.type` **instant**. + only be used for sweeps of `type` **pull** and `schedule.type` **balance**. type: string schedule: description: The schedule when the `triggerAmount` is evaluated. If the @@ -3787,12 +3682,12 @@ components: * **monthly**: Push out funds every 1st of the month at 07:00 AM CET. - * **instant**: Only for sweeps of `type` **pull** and with a `merchantAccount` + * **balance**: Only for sweeps of `type` **pull** and with a `merchantAccount` source. Pull in funds instantly if the balance is less than or equal to the `triggerAmount`.' enum: + - balance - daily - - instant - monthly - weekly type: string @@ -4464,49 +4359,6 @@ components: description: Example request for updating the status of an account holder value: status: Suspended - patch-paymentInstruments-id-invalidData-422: - summary: Response code - 422 Unprocessable Entity - description: Example response for a failed request to update the balance account - ID - value: - type: https://docs.adyen.com/errors/general/invalid-field-value - title: Invalid Payment Instrument information provided - status: 422 - detail: The balanceAccountId can only be changed when the status is Inactive - or Requested - requestId: 1W1UI15PLVGC9V8O - errorCode: '30_031' - patch-paymentInstruments-id-success-200: - summary: Response code - 200 OK - description: Example respones for successfully updating the status of a payment - instrument - value: - balanceAccountId: BA32272223222B59CZ3T52DKZ - description: S. Hopper - Main card - issuingCountryCode: GB - status: Suspended - type: card - card: - brand: mc - brandVariant: mcdebit - cardholderName: Simon Hopper - formFactor: virtual - bin: '555544' - expiration: - month: '01' - year: '2024' - lastFour: '5785' - number: '************5785' - id: PI3227C223222B5CMD278FKGS - patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount: - summary: Update the balance account linked to a payment instrument. - description: Example request for updating the balance account of a payment instrument - value: - balanceAccountId: BA32272223222B5CM82WL892M - patch-paymentInstruments-id-updatePaymentInstrumentStatus: - summary: Update the status of a payment instrument. - value: - status: Suspended patch-transactionRules-transactionRuleId-success-200: summary: Response code - 200 OK description: Example response for successfully updating the status of a transaction @@ -4597,49 +4449,6 @@ components: balancePlatform: YOUR_BALANCE_PLATFORM txVariant: mc id: PG3227C223222B5CMD3FJFKGZ - post-paymentInstruments-createPhysicalCard: - summary: Create a physical card - description: Example request for creating a physical card - value: - type: card - issuingCountryCode: NL - balanceAccountId: BALANCE_ACCOUNT_ID - status: Inactive - card: - formFactor: physical - brand: mc - brandVariant: mcdebit - cardholderName: Sam Hopper - deliveryContact: - address: - city: Amsterdam - country: NL - stateOrProvince: NH - street: Simon Carmiggeltstraat - houseNumberOrName: 6-50 - postalCode: 1011DJ - name: - firstName: Sam - lastName: Hopper - configuration: - configurationProfileId: YOUR_CONFIGURATION_PROFILE_ID - expiry: - month: 8 - year: 2024 - description: S.Hopper - Main card - post-paymentInstruments-createVirtualCard: - summary: Create a virtual card. - description: Example request for creating a virtual card - value: - type: card - description: S. Hopper - Main card - balanceAccountId: BA32272223222B59CZ3T52DKZ - issuingCountryCode: GB - card: - cardholderName: Simon Hopper - brand: mc - brandVariant: mcdebit - formFactor: virtual post-paymentInstruments-success-200: summary: Response code - 200 OK description: Example response for successfully creating a virtual card @@ -4661,18 +4470,6 @@ components: year: '2024' lastFour: '3548' id: PI32272223222B5CMD3MQ3HXX - post-transactionRules-createTransactionRule: - summary: Create a transaction rule. - value: - description: Allow 5 transactions per month - interval: - type: monthly - maxTransactions: 5 - paymentInstrumentId: PI3227C223222B59KGTXP884R - reference: myRule12345 - startDate: '2021-01-21T12:46:35.476629Z' - status: inactive - type: velocity post-transactionRules-success-200: summary: Response code - 200 OK description: Example response for successfully creating a transaction rule diff --git a/yaml/BinLookupService-v40.yaml b/yaml/BinLookupService-v40.yaml index 40a4331..4ee524f 100644 --- a/yaml/BinLookupService-v40.yaml +++ b/yaml/BinLookupService-v40.yaml @@ -40,6 +40,9 @@ paths: '200': content: application/json: + examples: + get3dsAvailability-200: + $ref: '#/components/examples/post-get3dsAvailability-get3dsAvailability-200' schema: $ref: '#/components/schemas/ThreeDSAvailabilityResponse' description: OK - the request has succeeded. @@ -117,6 +120,15 @@ paths: '200': content: application/json: + examples: + getCostEstimateEncryptedCard-200: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateEncryptedCard-200' + getCostEstimateMinimal-200: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal-200' + getCostEstimateMinimal3DS-200: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal3DS-200' + getCostEstimate-200: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimate-200' schema: $ref: '#/components/schemas/CostEstimateResponse' description: OK - the request has succeeded. @@ -561,6 +573,12 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT cardNumber: '4111111111111111' + post-get3dsAvailability-get3dsAvailability-200: + summary: Example response for request 'get3dsAvailability' + value: + threeDS1Supported: 'true' + threeDS2CardRangeDetails: [] + threeDS2supported: 'false' post-getCostEstimate-getCostEstimate: summary: Estimate the transaction cost description: Example request to get the estimated cost of a transaction @@ -578,6 +596,14 @@ components: mcc: '7411' enrolledIn3DSecure: true shopperInteraction: Ecommerce + post-getCostEstimate-getCostEstimate-200: + summary: Example response for request 'getCostEstimate' + value: + costEstimateAmount: + currency: EUR + value: 12 + resultCode: Success + surchargeType: PASSTHROUGH post-getCostEstimate-getCostEstimateEncryptedCard: summary: Estimate the transaction cost using an encrypted card number description: Example request to get the estimated cost of a transaction @@ -595,6 +621,14 @@ components: mcc: '7411' enrolledIn3DSecure: true shopperInteraction: Ecommerce + post-getCostEstimate-getCostEstimateEncryptedCard-200: + summary: Example response for request 'getCostEstimateEncryptedCard' + value: + costEstimateAmount: + currency: EUR + value: 12 + resultCode: Success + surchargeType: PASSTHROUGH post-getCostEstimate-getCostEstimateMinimal: summary: Estimate the transaction cost (minimal) description: Example request to get the estimated cost of a transaction with @@ -605,6 +639,14 @@ components: currency: EUR cardNumber: '5101180000000007' merchantAccount: YOUR_MERCHANT_ACCOUNT + post-getCostEstimate-getCostEstimateMinimal-200: + summary: Example response for request 'getCostEstimateMinimal' + value: + costEstimateAmount: + currency: EUR + value: 12 + resultCode: Success + surchargeType: PASSTHROUGH post-getCostEstimate-getCostEstimateMinimal3DS: summary: Estimate the transaction cost (minimal with 3DSecure) description: Example request to get the estimated cost of a 3D Secure transaction @@ -618,6 +660,14 @@ components: assume3DSecureAuthenticated: true cardNumber: '5101180000000007' merchantAccount: YOUR_MERCHANT_ACCOUNT + post-getCostEstimate-getCostEstimateMinimal3DS-200: + summary: Example response for request 'getCostEstimateMinimal3DS' + value: + costEstimateAmount: + currency: EUR + value: 12 + resultCode: Success + surchargeType: PASSTHROUGH post-getCostEstimate-getCostEstimateRecurringContract: summary: Estimate the transaction cost (recurring contract) description: Example request to get the estimated cost of a recurring transaction diff --git a/yaml/BinLookupService-v50.yaml b/yaml/BinLookupService-v50.yaml index 0514024..752e325 100644 --- a/yaml/BinLookupService-v50.yaml +++ b/yaml/BinLookupService-v50.yaml @@ -40,6 +40,9 @@ paths: '200': content: application/json: + examples: + get3dsAvailability-200: + $ref: '#/components/examples/post-get3dsAvailability-get3dsAvailability-200' schema: $ref: '#/components/schemas/ThreeDSAvailabilityResponse' description: OK - the request has succeeded. @@ -117,6 +120,15 @@ paths: '200': content: application/json: + examples: + getCostEstimateEncryptedCard-200: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateEncryptedCard-200' + getCostEstimateMinimal-200: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal-200' + getCostEstimateMinimal3DS-200: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimateMinimal3DS-200' + getCostEstimate-200: + $ref: '#/components/examples/post-getCostEstimate-getCostEstimate-200' schema: $ref: '#/components/schemas/CostEstimateResponse' description: OK - the request has succeeded. @@ -578,6 +590,12 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT cardNumber: '4111111111111111' + post-get3dsAvailability-get3dsAvailability-200: + summary: Example response for request 'get3dsAvailability' + value: + threeDS1Supported: 'true' + threeDS2CardRangeDetails: [] + threeDS2supported: 'false' post-getCostEstimate-getCostEstimate: summary: Estimate the transaction cost description: Example request to get the estimated cost of a transaction @@ -595,6 +613,14 @@ components: mcc: '7411' enrolledIn3DSecure: true shopperInteraction: Ecommerce + post-getCostEstimate-getCostEstimate-200: + summary: Example response for request 'getCostEstimate' + value: + costEstimateAmount: + currency: EUR + value: 12 + resultCode: Success + surchargeType: PASSTHROUGH post-getCostEstimate-getCostEstimateEncryptedCard: summary: Estimate the transaction cost using an encrypted card number description: Example request to get the estimated cost of a transaction @@ -612,6 +638,14 @@ components: mcc: '7411' enrolledIn3DSecure: true shopperInteraction: Ecommerce + post-getCostEstimate-getCostEstimateEncryptedCard-200: + summary: Example response for request 'getCostEstimateEncryptedCard' + value: + costEstimateAmount: + currency: EUR + value: 12 + resultCode: Success + surchargeType: PASSTHROUGH post-getCostEstimate-getCostEstimateMinimal: summary: Estimate the transaction cost (minimal) description: Example request to get the estimated cost of a transaction with @@ -622,6 +656,14 @@ components: currency: EUR cardNumber: '5101180000000007' merchantAccount: YOUR_MERCHANT_ACCOUNT + post-getCostEstimate-getCostEstimateMinimal-200: + summary: Example response for request 'getCostEstimateMinimal' + value: + costEstimateAmount: + currency: EUR + value: 12 + resultCode: Success + surchargeType: PASSTHROUGH post-getCostEstimate-getCostEstimateMinimal3DS: summary: Estimate the transaction cost (minimal with 3DSecure) description: Example request to get the estimated cost of a 3D Secure transaction @@ -635,6 +677,14 @@ components: assume3DSecureAuthenticated: true cardNumber: '5101180000000007' merchantAccount: YOUR_MERCHANT_ACCOUNT + post-getCostEstimate-getCostEstimateMinimal3DS-200: + summary: Example response for request 'getCostEstimateMinimal3DS' + value: + costEstimateAmount: + currency: EUR + value: 12 + resultCode: Success + surchargeType: PASSTHROUGH post-getCostEstimate-getCostEstimateRecurringContract: summary: Estimate the transaction cost (recurring contract) description: Example request to get the estimated cost of a recurring transaction diff --git a/yaml/CheckoutService-v37.yaml b/yaml/CheckoutService-v37.yaml index e51f731..a41a7b0 100644 --- a/yaml/CheckoutService-v37.yaml +++ b/yaml/CheckoutService-v37.yaml @@ -81,13 +81,21 @@ paths: $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-basic-200' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -124,6 +132,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -150,13 +161,21 @@ paths: $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-cancel-basic-200' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -193,6 +212,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -223,13 +245,21 @@ paths: $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-originKeys-basic-200' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -266,6 +296,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -295,19 +328,30 @@ paths: $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/CreatePaymentLinkRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentLinks-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '201': content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResource' description: Created - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -344,6 +388,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -367,13 +414,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -410,6 +464,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -441,13 +498,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -484,6 +548,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -521,13 +588,25 @@ paths: $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentMethods-basic-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + filtered-200: + $ref: '#/components/examples/post-paymentMethods-filtered-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -564,6 +643,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -592,13 +674,21 @@ paths: $ref: '#/components/examples/post-paymentMethods-balance-basic' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + plastix-200: + $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -629,12 +719,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -661,29 +751,30 @@ paths: content: application/json: examples: - split: - $ref: '#/components/examples/post-paymentSession-split' - web: - $ref: '#/components/examples/post-paymentSession-web' android: $ref: '#/components/examples/post-paymentSession-android' ios: $ref: '#/components/examples/post-paymentSession-ios' schema: $ref: '#/components/schemas/PaymentSetupRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -699,9 +790,6 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -714,12 +802,12 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -745,33 +833,32 @@ paths: $ref: '#/components/examples/post-payments-card-3d-secure-direct' card-3d-secure-securedfields: $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' - applepay: - $ref: '#/components/examples/post-payments-applepay' - split: - $ref: '#/components/examples/post-payments-split' - oneclick-securedfields: - $ref: '#/components/examples/post-payments-oneclick-securedfields' oneclick-direct: $ref: '#/components/examples/post-payments-oneclick-direct' card-direct: $ref: '#/components/examples/post-payments-card-direct' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' schema: $ref: '#/components/schemas/PaymentRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + card-3d-secure-direct-200: + $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' + card-securedfields-200: + $ref: '#/components/examples/post-payments-card-securedfields-200' schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -787,27 +874,21 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -829,6 +910,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DetailsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -836,6 +919,9 @@ paths: schema: $ref: '#/components/schemas/PaymentDetailsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -863,6 +949,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -888,6 +977,8 @@ paths: $ref: '#/components/examples/post-payments-result-basic' schema: $ref: '#/components/schemas/PaymentVerificationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -895,6 +986,9 @@ paths: schema: $ref: '#/components/schemas/PaymentVerificationResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -925,12 +1019,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -2788,19 +2882,19 @@ components: type: string encryptedCardNumber: description: The encrypted card number. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryMonth: description: The encrypted card expiry month. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryYear: description: The encrypted card expiry year. - maxLength: 7000 + maxLength: 10000 type: string encryptedSecurityCode: description: The encrypted card verification code. - maxLength: 7000 + maxLength: 10000 type: string expiryMonth: description: The card expiry month. Only collect raw card data if you are @@ -3007,8 +3101,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -3220,53 +3320,20 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Success** \u2013 Indicates that the balance check was successful.\n\ + * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\ + \ have enough balance to pay the amount in the request, or that the currency\ + \ of the balance on the card did not match the currency of the requested\ + \ amount.\n* **Failed** \u2013 Indicates that the balance check failed." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success + - NotEnoughBalance + - Failed type: string required: - balance + - resultCode CheckoutCancelOrderRequest: properties: merchantAccount: @@ -3285,7 +3352,11 @@ components: description: A unique reference of the cancellation request. type: string resultCode: - description: The result of the cancellation request. + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Received** \u2013 Indicates the cancellation has successfully been\ + \ received by Adyen, and will be processed." + enum: + - Received type: string required: - pspReference @@ -3361,55 +3432,16 @@ components: description: The remaining amount in the order. $ref: '#/components/schemas/Amount' resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the order creation request.\n The value is always\ + \ **Success**." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success type: string required: - remainingAmount - expiresAt - orderData + - resultCode CheckoutOrder: properties: orderData: @@ -5129,8 +5161,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -5690,8 +5728,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -6940,11 +6984,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -7218,6 +7262,21 @@ components: BasicAuth: scheme: basic type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string examples: generic-400: summary: Response code 400. Bad request. @@ -7255,10 +7314,38 @@ components: message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' + get-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A patch-paymentLinks-linkId-basic: summary: Update the status of a payment link value: status: expired + patch-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: expired + url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -7267,6 +7354,17 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178914061985' + resultCode: Success + expiresAt: '2021-04-09T14:16:46Z' + orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== + reference: shopper-reference-ekvL83 + remainingAmount: + currency: EUR + value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -7274,6 +7372,11 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8816178914079738' + resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -7281,6 +7384,13 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com + post-originKeys-basic-200: + summary: Example response for request 'basic' + value: + originKeys: + https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw + https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc + https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -7307,6 +7417,15 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP + post-paymentLinks-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 1250 + expiresAt: '2021-04-09T14:17:31Z' + reference: shopper-reference-ekvL83 + url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -7324,10 +7443,1471 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix-200: + summary: Example response for request 'plastix' + value: + additionalData: + nonScheme.transactionLimit: '5000' + nonScheme.transactionLimitCcy: EUR + pspReference: 851617891188737F + resultCode: Success + balance: + currency: EUR + value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic-200: + summary: Example response for request 'basic' + value: + paymentMethods: + - details: + - details: + - key: ownerName + type: text + - key: bankLocationId + type: text + - key: bankAccountNumber + type: text + key: bankAccount + type: bankAccount + name: ACH Direct Debit + type: ach + - name: Adyen Voucher + type: adyen_test_voucher + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: Afterpay + type: afterpaytouch + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: AliPay + type: alipay + - name: AliPay HK + type: alipay_hk + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Credit Card via AsiaPay + type: asiapay + - name: China UnionPay + type: asiapay_unionpay + - name: Baby Gift Card + type: babygiftcard + - name: Baloto + type: baloto + - name: BancNet + type: bancnet + - name: Bank Transfer (BG) + type: bankTransfer_BG + - name: Bank Transfer (CH) + type: bankTransfer_CH + - name: Bank Transfer (DE) + type: bankTransfer_DE + - name: Bank Transfer (FI) + type: bankTransfer_FI + - name: Bank Transfer (GB) + type: bankTransfer_GB + - name: Bank Transfer (HU) + type: bankTransfer_HU + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bank Transfer (IE) + type: bankTransfer_IE + - name: Electronic Bank Transfer (MX) + type: bankTransfer_MX_linked + - name: Bank Transfer (MX) + type: bankTransfer_MX_offline + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Bank Transfer (PL) + type: bankTransfer_PL + - name: Bank Transfer (SE) + type: bankTransfer_SE + - name: Bank Transfer (US) + type: bankTransfer_US + - name: Payconiq by Bancontact + type: bcmc_mobile + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: 99Bill + type: bill99 + - details: + - items: + - id: AUB_DIRECT + name: AU Small Finance Bank + - id: ALB_DIRECT + name: 'Allahabad Bank ' + - id: APG_DIRECT + name: Andhra Pragathi Grameena Bank + - id: BDN_DIRECT + name: Bandhan bank + - id: BBK_DIRECT + name: Bank of Bahrain and Kuwait + - id: BBR_DIRECT + name: Bank of Baroda - Retail Banking + - id: BCB_DIRECT + name: 'Bassien Catholic Co-Operative Bank ' + - id: CNB_DIRECT + name: Canara Bank + - id: SYD_DIRECT + name: Canara Bank (e-Syndicate) + - id: CSB_DIRECT + name: Catholic Syrian Bank + - id: CBI_DIRECT + name: Central Bank of India + - id: CUB_DIRECT + name: City Union Bank + - id: COB_DIRECT + name: Cosmos Bank + - id: DEN_DIRECT + name: Dena Bank + - id: DBK_DIRECT + name: Deutsche Bank + - id: DCB_DIRECT + name: Development Credit Bank + - id: DLB_DIRECT + name: Dhanlakshmi Bank - Retail Net Banking + - id: ESF_DIRECT + name: ESAF Small Finance Bank + - id: EQB_DIRECT + name: Equitas Small Finance Bank + - id: FBK_DIRECT + name: Federal Bank + - id: FNC_DIRECT + name: Fincare Bank + - id: HDF_DIRECT + name: HDFC Bank + - id: ICI_DIRECT + name: 'ICICI Bank ' + - id: IDB_DIRECT + name: IDBI Bank - Retail Net Banking + - id: IDN_DIRECT + name: IDFC FIRST Bank + - id: INB_DIRECT + name: Indian Bank + - id: IOB_DIRECT + name: Indian Overseas Bank + - id: IDS_DIRECT + name: IndusInd Bank + - id: JKB_DIRECT + name: Jammu & Kashmir Bank + - id: JNB_DIRECT + name: Jana Small Finance Bank + - id: JSB_DIRECT + name: Janata Sahakari Bank Ltd Pune + - id: KJB_DIRECT + name: Kalyan Janata Sahakari Bank + - id: KBL_DIRECT + name: Karnataka Bank Ltd + - id: KVB_DIRECT + name: Karur Vysya Bank + - id: 162_DIRECT + name: Kotak Bank + - id: LVR_DIRECT + name: Laxmi Vilas Bank - Retail + - id: NKB_DIRECT + name: NKGSB Co-op Bank + - id: NEB_DIRECT + name: North East Small Finance Bank + - id: OBC_DIRECT + name: PNB (Erstwhile-Oriental Bank of Commerce) + - id: UNI_DIRECT + name: PNB (Erstwhile-United Bank of India) + - id: PMC_DIRECT + name: Punjab & Maharastra Co-op Bank + - id: PSB_DIRECT + name: Punjab & Sind Bank + - id: CPN_DIRECT + name: 'Punjab National Bank - Corporate ' + - id: PNB_DIRECT + name: Punjab National Bank - Retail Banking + - id: RBL_DIRECT + name: RBL Bank Limited + - id: SWB_DIRECT + name: Saraswat Bank + - id: SHB_DIRECT + name: Shivalik Mercantile Cooperative Bank Ltd + - id: SIB_DIRECT + name: South Indian Bank + - id: SCB_DIRECT + name: Standard Chartered Bank + - id: SBI_DIRECT + name: State Bank of India + - id: SRB_DIRECT + name: Suryoday Small Finance Bank + - id: TJB_DIRECT + name: TJSB Bank + - id: TNC_DIRECT + name: Tamil Nadu State Co-operative Bank + - id: TMB_DIRECT + name: Tamilnad Mercantile Bank Ltd + - id: TBB_DIRECT + name: Thane Bharat Sahakari Bank Ltd + - id: MSB_DIRECT + name: The Mehsana Urban Co Op Bank Ltd + - id: UCO_DIRECT + name: UCO Bank + - id: UBI_DIRECT + name: Union Bank of India + - id: ADB_DIRECT + name: Union Bank of India (Erstwhile Andhra Bank) + - id: CRP_DIRECT + name: Union Bank of India (Erstwhile Corporation Bank) + - id: VRB_DIRECT + name: Varachha Co-operative Bank Limited + - id: VJB_DIRECT + name: Vijaya Bank + - id: YBK_DIRECT + name: Yes Bank + - id: ZOB_DIRECT + name: Zoroastrian Co-operative Bank Limited + - id: DBS_DIRECT + name: digibank by DBS + key: issuer + type: select + name: Online Banking India + type: billdesk_online + - name: UPI + type: billdesk_upi + - details: + - items: + - id: DCW_DIRECT + name: DCB Cippy + - id: ICC_DIRECT + name: ICC Cash Card + - id: OXY_DIRECT + name: Oxigen Wallet + - id: PCH_DIRECT + name: Pay World Money + key: issuer + type: select + name: Wallets India + type: billdesk_wallet + - name: Blik + type: blik + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Boleto + type: boleto + - name: Boleto Bancario + type: boletobancario_santander + - name: Bradesco + type: bradesco + - name: Cash-Ticket + type: cashticket + - name: CashU + type: cashu + - name: CCAvenue + type: ccavenue + - name: Mula Checkout + type: cellulant + - name: Chasin Giftcard + type: chasingiftcard + - name: Clearpay + type: clearpay + - name: ClickandBuy + type: clickandbuy + - name: Paiement en 3 fois par Cartes Bancaires + type: cofinoga_3xcb + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: DANA + type: dana + - name: DineroMail + type: dineromail + - name: Online bank transfer. + type: directEbanking + - name: Direct Debit Brazil - Banco do Brazil + type: directdebit_BR_bancodobrasil + - name: Direct Debit Brazil - Bradesco + type: directdebit_BR_bradesco + - name: Direct Debit Brazil - Caixa Economica Federal + type: directdebit_BR_caixa + - name: Direct Debit Brazil - HSBC + type: directdebit_BR_hsbc + - name: Direct Debit Brazil - Itau + type: directdebit_BR_itau + - name: Direct Debit Brazil - Santander + type: directdebit_BR_santander + - name: BACS Direct Debit + type: directdebit_GB + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Alfamart + type: doku_alfamart + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BCA Bank Transfer + type: doku_bca_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BNI VA + type: doku_bni_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BRI VA + type: doku_bri_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: CIMB VA + type: doku_cimb_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Danamon VA + type: doku_danamon_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Indomaret + type: doku_indomaret + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Mandiri VA + type: doku_mandiri_va + - details: + - key: ovoId + type: text + name: OVO + type: doku_ovo + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Bank Transfer + type: doku_permata_lite_atm + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: DOKU wallet + type: doku_wallet + - details: + - items: + - id: '66' + name: Bank Nowy BFG S.A. + - id: '92' + name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" + - id: '11' + name: Bank transfer / postal + - id: '74' + name: "Banki Sp\xF3\u0142dzielcze" + - id: '73' + name: BLIK + - id: '90' + name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" + - id: '59' + name: CinkciarzPAY + - id: '87' + name: Credit Agricole PBL + - id: '83' + name: EnveloBank + - id: '76' + name: Getin Bank PBL + - id: '81' + name: Idea Cloud + - id: '7' + name: ING Corporate customers + - id: '93' + name: Kasa Stefczyka + - id: '44' + name: "Millennium - P\u0142atno\u015Bci Internetowe" + - id: '10' + name: Millennium Corporate customers + - id: '68' + name: mRaty + - id: '1' + name: mTransfer + - id: '91' + name: Nest Bank + - id: '80' + name: Noble Pay + - id: '50' + name: Pay Way Toyota Bank + - id: '45' + name: Pay with Alior Bank + - id: '36' + name: Pekao24Przelew + - id: '70' + name: Pocztowy24 + - id: '6' + name: Przelew24 + - id: '46' + name: "P\u0142ac\u0119 z Citi Handlowy" + - id: '38' + name: "P\u0142ac\u0119 z ING" + - id: '2' + name: "P\u0142ac\u0119 z Inteligo" + - id: '4' + name: "P\u0142ac\u0119 z iPKO" + - id: '75' + name: "P\u0142ac\u0119 z Plus Bank" + - id: '51' + name: "P\u0142a\u0107 z BO\u015A" + - id: '55' + name: Raty z Alior Bankiem PLN + - id: '89' + name: Santander + - id: '52' + name: SkyCash + key: issuer + type: select + name: Local Polish Payment Methods + type: dotpay + - name: Dragonpay Prepaid Credits + type: dragonpay_credits + - name: Online Banking + type: dragonpay_ebanking + - name: GCash + type: dragonpay_gcash + - name: Over The Counter Banks + type: dragonpay_otc_banking + - name: OTC non-Bank via Dragonpay + type: dragonpay_otc_non_banking + - name: Convenience Stores + type: dragonpay_otc_philippines + - name: 7/11 + type: dragonpay_seveneleven + - name: eagleeye_voucher + type: eagleeye_voucher + - name: Finnish E-Banking + type: ebanking_FI + - name: Pay-easy ATM + type: econtext_atm + - name: Online Banking + type: econtext_online + - name: 7-Eleven + type: econtext_seven_eleven + - name: Convenience Stores + type: econtext_stores + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Lastschrift (ELV) + type: elv + - details: + - items: + - id: '231' + name: POP Pankki + - id: '551' + name: "Komer\u010Dn\xED banka" + - id: '232' + name: Aktia + - id: '552' + name: Raiffeisen + - id: '233' + name: "S\xE4\xE4st\xF6pankki" + - id: '750' + name: Swedbank + - id: '211' + name: Nordea + - id: '553' + name: "\u010CSOB" + - id: '234' + name: S-Pankki + - id: '751' + name: SEB + - id: '554' + name: Moneta + - id: '235' + name: OmaSP + - id: '752' + name: Nordea + - id: '213' + name: Op-Pohjola + - id: '555' + name: UniCredit + - id: '753' + name: LHV + - id: '556' + name: Fio + - id: '557' + name: mBank + - id: '216' + name: Handelsbanken + - id: '558' + name: Air Bank + - id: '260' + name: "L\xE4nsf\xF6rs\xE4kringar" + - id: '240' + name: BankDeposit + - id: '265' + name: Sparbanken + - id: '640' + name: BankDeposit + - id: '200' + name: "\xC5landsbanken" + - id: '940' + name: Swedbank + - id: '500' + name: "\u010Cesk\xE1 spo\u0159itelna" + - id: '720' + name: Swedbank + - id: '941' + name: SEB + - id: '204' + name: Danske Bank + - id: '721' + name: SEB + - id: '942' + name: Citadele + - id: '205' + name: Handelsbanken + - id: '722' + name: DNB + - id: '943' + name: DNB + - id: '206' + name: Nordea + - id: '723' + name: "\u0160iauli\u0173 bankas" + - id: '207' + name: SEB + - id: '724' + name: Nordea + - id: '505' + name: "Komer\u010Dn\xED banka" + - id: '208' + name: Skandiabanken + - id: '209' + name: Swedbank + key: issuer + type: select + name: Bank Payment + type: entercash + - name: Nationale Entertainment Card + type: entertainmentcard + - details: + - items: + - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 + name: Dolomitenbank + - id: ee9fc487-ebe0-486c-8101-17dce5141a67 + name: Raiffeissen Bankengruppe + - id: 6765e225-a0dc-4481-9666-e26303d4f221 + name: Hypo Tirol Bank AG + - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc + name: Sparda Bank Wien + - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f + name: Schoellerbank AG + - id: e2e97aaa-de4c-4e18-9431-d99790773433 + name: Volksbank Gruppe + - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 + name: Immo-Bank + - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 + name: Bank Austria + - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 + name: Easybank AG + - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a + name: VR-BankBraunau + - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 + name: Volkskreditbank + - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 + name: Erste Bank und Sparkassen + - id: ba7199cc-f057-42f2-9856-2378abf21638 + name: BAWAG P.S.K. Gruppe + key: issuer + type: select + name: EPS + type: eps + - name: Expert Cadeaukaart + type: expertgiftcard + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 3x Oney + type: facilypay_3x + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 4x Oney + type: facilypay_4x + - name: Fashioncheque + type: fashioncheque + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: Fawry + type: fawry + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Fonq Giftcard + type: fonqgiftcard + - name: Gall & Gall + type: gallgall + - name: GCash + type: gcash + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - details: + - key: bic + type: text + name: GiroPay + type: giropay + - name: Givex + type: givex + - name: Globe GCash + type: globegcash + - name: Goldsmiths Card + type: goldsmithscard + - name: GoPay Wallet + type: gopay_wallet + - name: OVO + type: grabpay_ID + - name: GrabPay + type: grabpay_PH + - name: GrabPay + type: grabpay_SG + - name: Hallmark Card + type: hallmarkcard + - name: HDFC + type: hdfc + - name: Hunkemoller Member Card + type: hmclub + - name: Hunkemoller Lingerie Card + type: hmlingerie + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - name: igive + type: igive + - name: Korean Account Transfer (IniPay) + type: inicisIniPay_accounttransfer + - name: Korean Credit Cards (IniPay) + type: inicisIniPay_creditcard + - name: Korean Mobile Phone (IniPay) + type: inicisIniPay_mobilephone + - name: Korean Virtual Account (IniPay) + type: inicisIniPay_virtualaccount + - name: Korean Account Transfer (Mobile) + type: inicisMobile_accounttransfer + - name: Korean Credit Cards (Mobile) + type: inicisMobile_creditcard + - name: Korean Mobile Phone (Mobile) + type: inicisMobile_mobilephone + - name: Korean Virtual Account (Mobile) + type: inicisMobile_virtualaccount + - name: Korean Credit Cards + type: inicis_creditcard + - name: "Interac\xAE Online" + type: interac + - name: Instant EFT + type: ipay + - name: iPay88 + type: ipay88 + - name: isracard + type: isracard + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: KakaoPay + type: kakaopay + - name: Karen Millen Card + type: karenmillen + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Bank Transfer + type: kcp_banktransfer + - name: "Korea\u2013issued cards" + type: kcp_creditcard + - name: PayCo + type: kcp_payco + - name: Virtual Account via KCP + type: kcp_va + - name: Pay later with Klarna. + type: klarna + - name: Pay over time with Klarna. + type: klarna_account + - name: Klarna B2B + type: klarna_b2b + - name: Pay now with Klarna. + type: klarna_paynow + - name: Leisure Card + type: leisurecard + - name: China Credit Card + type: lianlianpay_creditcard + - name: China Debit Card + type: lianlianpay_debitcard + - details: + - key: telephoneNumber + type: tel + name: China Online Banking - Credit Card + type: lianlianpay_ebanking_credit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '4031000' + name: Bank of Beijing + - id: '01040000' + name: Bank of China + - id: '03020000' + name: China Citic Bank + - id: '01050000' + name: China Construction Bank + - id: '03030000' + name: China Everbright Bank + - id: 03080000 + name: China Merchants Bank + - id: '03050000' + name: China Minsheng Banking Group + - id: '03040000' + name: Hua Xia Bank Co + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03070000' + name: PingAn Bank + - id: '1000000' + name: Postal Savings Bank of China + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Debit Card + type: lianlianpay_ebanking_debit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '01050000' + name: China Construction Bank + - id: 03080000 + name: China Merchants Bank + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03100000' + name: Shanghai Pudong Development Bank + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Enterprise + type: lianlianpay_ebanking_enterprise + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - name: Love2Shop GiftCard + type: love2shop + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: mada + type: mada + - name: Mappin & Webb Card + type: mappinwebbcard + - name: MB WAY + type: mbway + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: Mercado Pago + type: mercadopago + - name: MobilePay + type: mobilepay + - name: AliPay via Razer Merchant Services + type: molpay_alipay + - name: 7-Eleven + type: molpay_cash + - name: CIMB Virtual Account + type: molpay_cimb_va + - name: Malaysia E-Banking via Razer Merchant Services + type: molpay_ebanking_MY + - details: + - items: + - id: vtcpay-vietinbank + name: Vietinbank + - id: vtcpay-bidv + name: BIDV + - id: vtcpay-agribank + name: Agribank + - id: vtcpay-mb + name: MB Bank + - id: vtcpay-sacombank + name: Sacombank + - id: vtcpay-dongabank + name: DongABank + - id: vtcpay-maritimebank + name: MaritimeBank + - id: vtcpay-vietcombank + name: Vietcombank + - id: vtcpay-acb + name: ACB + - id: vtcpay-techcombank + name: Techcombank + key: issuer + type: select + name: Vietnam E-Banking + type: molpay_ebanking_VN + - details: + - items: + - id: fpx_bimb + name: Bank Islam + - id: fpx_uob + name: UOB Bank + - id: fpx_cimbclicks + name: CIMB Clicks + - id: fpx_kfh + name: Kuwait Finance House + - id: fpx_rhb + name: RHB Now + - id: fpx_abmb + name: Alliance Bank + - id: fpx_amb + name: Am Online + - id: fpx_hsbc + name: HSBC + - id: fpx_abb + name: Affin Bank + - id: fpx_ocbc + name: OCBC Bank + - id: fpx_pbb + name: Public Bank + - id: fpx_scb + name: Standard Chartered Bank + - id: fpx_bsn + name: Bank Simpanan Nasional + - id: fpx_mb2u + name: Maybank2u + - id: fpx_hlb + name: Hong Leong Connect + - id: fpx_bmmb + name: Bank Muamalat + - id: fpx_bkrm + name: Bank Rakyat + key: issuer + type: select + name: Malaysia E-Banking + type: molpay_ebanking_fpx_MY + - name: eNETS Debit + type: molpay_enetsd + - name: epay + type: molpay_epay + - name: Esapay + type: molpay_esapay + - name: MyClear FPX + type: molpay_fpx + - name: Maybank2u + type: molpay_maybank2u + - name: Nganluong + type: molpay_nganluong + - name: Tesco Lotus + type: molpay_paysbuy + - name: MOLPoints + type: molpay_points + - name: RHB Now + type: molpay_rhb + - name: SAM by SingPost + type: molpay_singpost + - name: MOLWallet + type: molpay_wallet + - name: MoMo ATM + type: momo_atm + - name: Momo Wallet + type: momo_wallet + - name: Moneybookers + type: moneybookers + - name: Multibanco + type: multibanco + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: BankAxess + type: netaxept_bankaxess + - name: NETELLER + type: neteller + - name: Onebip + type: onebip + - name: One Two Three + type: onetwothree + - name: Local Polish Payment Methods + type: onlineBanking_PL + - details: + - items: + - id: '1' + name: Model Bank v2 + key: issuer + type: select + name: Online banking + type: openbanking_UK + - name: Oxxo + type: oxxo + - name: Pathe Giftcard + type: pathegiftcard + - name: PayBright + type: paybright + - name: PayMaya Wallet + type: paymaya_wallet + - name: PayPal + type: paypal + - name: Paysafecard + type: paysafecard + - name: Payshop + type: payshop + - name: PayD AMT via Paythru + type: paythru_amt + - name: EFT via Paythru + type: paythru_eft + - name: PayTM + type: paytm + - details: + - key: virtualPaymentAddress + type: text + name: PayU UPI + type: payu_IN_upi + - name: EFT Pro via PayU + type: payu_ZA_eftpro + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: pix + type: pix + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Podium Card + type: podiumcard + - name: POLi + type: poli + - name: PPS + type: pps + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Illicado Gift Card + type: prosodie_illicado + - name: PSE + type: pse + - details: + - items: + - id: '+7' + name: RU + - id: '+9955' + name: GE + - id: '+507' + name: PA + - id: '+44' + name: GB + - id: '+992' + name: TJ + - id: '+370' + name: LT + - id: '+972' + name: IL + - id: '+996' + name: KG + - id: '+380' + name: UA + - id: '+84' + name: VN + - id: '+90' + name: TR + - id: '+994' + name: AZ + - id: '+374' + name: AM + - id: '+371' + name: LV + - id: '+91' + name: IN + - id: '+66' + name: TH + - id: '+373' + name: MD + - id: '+1' + name: US + - id: '+81' + name: JP + - id: '+998' + name: UZ + - id: '+77' + name: KZ + - id: '+375' + name: BY + - id: '+372' + name: EE + - id: '+40' + name: RO + - id: '+82' + name: KR + key: qiwiwallet.telephoneNumberPrefix + type: select + - key: qiwiwallet.telephoneNumber + type: text + name: Qiwi Wallet + type: qiwiwallet + - name: RatePay Invoice + type: ratepay + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: SafetyPay + type: safetypay + - name: SafetyPay Cash + type: safetypay_cash + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: SEB Direktbetalning + type: sebdirectpayment + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: 7-Eleven + type: seveneleven + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: Swish + type: swish + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: TenPay + type: tenpay + - name: The Sting Giftcard + type: thestinggiftcard + - name: Trustly + type: trustly + - name: Online Banking by Trustpay + type: trustpay + - name: TWINT + type: twint + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - details: + - key: virtualPaymentAddress + type: text + name: UPI Collect + type: upi_collect + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: telephoneNumber + optional: true + type: tel + name: Vipps + type: vipps + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: VVV Giftcard + type: vvvgiftcard + - name: Webshop Giftcard + type: webshopgiftcard + - name: WeChat Pay + type: wechatpayMiniProgram + - name: WeChat Pay + type: wechatpayQR + - name: WeChat Pay + type: wechatpayWeb + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: WOS Card + type: woscard + - name: Alfa-Click + type: yandex_alfaclick + - name: Pay using bank card + type: yandex_bank_card + - name: Cash terminals + type: yandex_cash + - name: Pay using installments + type: yandex_installments + - name: YooMoney + type: yandex_money + - name: Promsvyazbank + type: yandex_promsvyazbank + - name: Sberbank Online + type: yandex_sberbank + - name: WebMoney + type: yandex_webmoney + - name: Your Gift + type: yourgift + - name: Zip + type: zip post-paymentMethods-filtered: summary: Get payment methods based on the country and amount value: @@ -7337,6 +8917,313 @@ components: amount: currency: EUR value: 1000 + post-paymentMethods-filtered-200: + summary: Example response for request 'filtered' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentMethods-include-oneclick: summary: Get payment methods including stored card details value: @@ -7346,6 +9233,313 @@ components: currency: EUR value: 1000 shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-paymentMethods-include-oneclick-200: + summary: Example response for request 'include-oneclick' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -7376,62 +9570,10 @@ components: shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-split: - summary: Split a payment between a sub-merchant and a platform account + post-paymentSession-web-200: + summary: Example response for request 'web' value: - amount: - currency: EUR - value: 6200 - additionalData: - split.api: '1' - split.nrOfItems: '2' - split.totalAmount: '6200' - split.currencyCode: EUR - split.item1.amount: '6000' - split.item1.type: MarketPlace - split.item1.account: '151272963' - split.item1.reference: '6124145' - split.item1.description: 'Porcelain Doll: Eliza (20cm)' - split.item2.amount: '200' - split.item2.type: Commission - split.item2.reference: '6124146' - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Android - token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK - returnUrl: app:// - countryCode: NL - shopperLocale: nl_NL - sessionValidity: '2017-04-06T13:09:13Z' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.3.0 - post-payments-applepay: - summary: Make an Apple Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: applepay - applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT + paymentSession: {"checkoutshopperBaseUrl":"https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/","disableRecurringDetailUrl":"https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/services\/PaymentInitiation\/v1\/disableRecurringDetail","generationtime":"2021-04-08T14:13:09Z","initiationUrl":"https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/services\/PaymentInitiation\/v1\/initiate?token=pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91cndlYnNpdGUuY29t.pupr33DCNDCi6ZWcCbuL1_kaz57Jh_Ibkm2mkBZP5gk","origin":"https:\/\/www.yourwebsite.com","originKey":"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91cndlYnNpdGUuY29t.pupr33DCNDCi6ZWcCbuL1_kaz57Jh_Ibkm2mkBZP5gk","payment":{"amount":{"currency":"EUR","value":17408},"countryCode":"NL","reference":"shopper-reference-ekvL83","returnUrl":"https:\/\/www.yourshop.com\/checkout\/result","sessionValidity":"2021-04-08T15:13:09Z","shopperLocale":"hu-HU","shopperReference":"shopper-reference-LZfdWZ"},"paymentData":"Ab02b4c0!BQABAgCgt+NI0xLstN4SvHGzWhRqhw6PMY1WymPaPRkvmAZ1rk8qrsqC2Fp8V9r2Jy\/5kzJ1+jmP56FkJz2TqJG5MTt\/ksfRnH0ljyM5Mg1p0EbcOZ6sTy6ClUyO6zn9Ka3SPiE1fAkSe\/wUj4wfWvZHMcRM5Dy+w43IMRWH7htanbaeUOGW6YgudizbdueIHu57gApsyQuxOxOqmifBUCksVf4nEy5kvpv9\/qfb\/QeIiKefGnxNpcftaYIHDPuEA4K\/+kKf13vt1OZf1RspFc0qDXFRKkTYHrnbGJS0W6T0sPNwHiG5mG+40A1FxZWhgimUFQ7\/HcbZfHu5Mq9slUysZarI+FAekNL6O5xIhZxBGbIdW7ilSpcQosak2lKATmwSKk4fnheenwFRCf+lJErIdlqmkFAe+go1fJ0qxIdwQZO8z\/HdA\/jtOea17faE137ZoTprvnNwKOC1KRBxBSac12OVs8VVxKbPvFQKTDHPp7jzsTQlb9xF3cZ9KRWkzlJxFZ31u+c5ngezyC51JqurlH9VIweCY76vE9WZmBrj86xQ6mlEtBENFo+YSkGW7r8\/rZlLraMIt17fdIqcyQeBM\/aBiWIH0mp9ktsN5Hj1YrSf506SWjJDmp\/BZ3E1ZkuV+GgdJfpeIZAzja48UfvSxPwv01tK4dxIUOfi0l9OB3aEwhASQnCZbKJDc6rkkvxgdLp+AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiff8fordfxJF3vxiYAd061rUEWVjkGNR0OpRcV8Qgk5dMNzGewODwBGBXzYiov4ledGZi4KCYpr4x6ujQ3Lgf\/r\/DThHVVS0juFM\/BDFgc35GL8tQ82CA3JgqQZx0f7TmZqohgPPgp3k\/2g5G\/vt0TIyFUOHw51wzO\/x66Bwgm++565WS06R8l+GLLw1Gl0Zknz0zsi0GGvgd6Y4\/8wlwZzyXdGpkhtW5G0Uxjj1ZyIUiYiD4AS\/SIHBx0LsI4yXkT22a8dutkyBnKUFfuoTGvGBacbPPfL1g7BU2He3Cqqag0Ab3qfOFuOaZ441Z0u9pc0x0xdc\/T3q8R0rmQHUoleHIg+V5bwEsNi3KLg5ZWX\/bvU6F5+\/\/ufB4zfe2eJV5QKJ\/wGEDSuxg1cYBX4PPLycL4a0tl4Wdjs015E5bBnOM5HDeDmdN4eR6tTGZj+P\/nVDQMBFP1oTFjy5SHAF4urQh8hpyRA992MwWkugGbpQCQc+YivS5pxH2JTqa8OsXFUn4Fc\/ZfbF40yphHxNfV980NwCwj0ZVabX+vd+2aOUHYqXIwmh\/2f16\/\/rYY6RJVePbSev\/\/\/rsAmGNTze3Rs5jOxcamoR0OEmRtytepBaEe\/nkNcCLsFhF2Tu7uhQPTSoUfMeDApT5se1zNMDU7rCruMR+M5DOSpX+W3SaRBYCyoeivN13dR5pk+uiQgExsyII6nykFhkJcM\/HKgMhBuCV6Uv8BhghySGS\/355yQpzfgxBi0ek403FWPBAw8ulf4KWrb50wasfivTTP\/KQyFklpQ1rX+35Eq9uOqOcTKm2xuvdqMRcVGbIIP2F+1mtBYX14tTkA49QNWLt5xuHSdzCQy4LCnzWruXrXdI3ZYdcF30ZPcdbpK1XFYpakYojiOk2QzSU2R45iqcQlFuxoMHxs+iL1n3vtOzyTNU1XZepkKk31IlJ3aTKKYhTfghDWJHm7JclenYgvObmZ5s5I36N4FDsocxAV5+c014Z49tH0etUAHEqTHpUd5YFbM7PQnLQgp43zTN7NUDwP9hrYKguRX\/b2WqruviyO4NZrKWJqtwmywnqT9NcjGP0+hJ9hVv86zhZuGjZNVyZGCj1p0r+tbHqufN9RxSchcM\/zTN0RDmffwU\/Z3gk\/qtjDFevIkki6TiYboLugnc6ZEs3gpo+gClgmHZ5dLuscwLU6EjCaiZoj12KBiRxTNPzEnOaRqK+YnWCKTamaMnD6SO5t1SLIi7Nf+uHkLygXrZ\/zZWh\/alF1niwmDp4NpZAO6efOC8Q\/ixahG6zzaGqNI5eUpKND2B+Uk45kOgJCffgPL8XHRGz88z1lc+wrnV35bw2kIiY5frf1vwSzjEFS1MQFZVrBDTmPkoq0VSGdja1LmP8htOYcYCAs3i2X9GxwOOycADCZjbWUikbwknWBSAf1lFrh39x5me78zOz0fSPOX\/d3C3pysK5u+zAMiPc2vL9nWFpG\/1K3s1xwaIgaS4i+BWvlO1i9iNEzqA1bocTU0q\/KX3wE9C08j8SrWsi6yjuzjFrU5syH3Gz8lHgsv4QTnmf8L4AQDR5kOjRWqQkArGPQ0E45pDaO5sK2ISxwgNIpuKtJ6+9MFM7vYGrHB9H3JomrZ8FEEjKKP8cUI2weIB9LsEpQJskMdKwMDdIi4dPgzvRaE2YxwHxJgtWGOd5YZTocHhaBYnr25dx8lKF91C4LohOzjzd1JCDJDsOmQ7FRZNsnz0s83tTFfjHcz\/ZBuaAPj0txCL7bHLfPrmziaGuf9wQ4vxqW0iAR5Cvmid+BVFJIz64Gww0GqThnHSyWRXYZeQ1DSG98orStea9gYEzqy8KWwrh\/rhSrDsC1bN+pZfZbslEYgB0riFML22owiGijw+n7dJZCyp2abifEocR260ffMxfKJQBvc5aPqGp+kA4na+l8GxHL\/+Yxn6SiSfgD5dVQ6+3nlhcGtBZBut04KRz7CSzQ0kEyL0T7MPG","paymentMethods":[{"configuration":{"canIgnoreCookies":"true"},"details":[{"items":[{"id":"1121","name":"Test Issuer"},{"id":"1154","name":"Test Issuer 5"},{"id":"1153","name":"Test Issuer 4"},{"id":"1152","name":"Test Issuer 3"},{"id":"1151","name":"Test Issuer 2"},{"id":"1162","name":"Test Issuer Cancelled"},{"id":"1161","name":"Test Issuer Pending"},{"id":"1160","name":"Test Issuer Refused"},{"id":"1159","name":"Test Issuer 10"},{"id":"1158","name":"Test Issuer 9"},{"id":"1157","name":"Test Issuer 8"},{"id":"1156","name":"Test Issuer 7"},{"id":"1155","name":"Test Issuer 6"}],"key":"idealIssuer","type":"select"}],"name":"iDEAL","paymentMethodData":"Ab02b4c0!BQABAgAQOXfyuJdcL0vN3gOePL4QWWQDWZd0LGPXi0C3mVF6yNIVtGxiUpdzI1UakkQbYHn8YL7Tr9UfSnGr11hvBzltGbnVP1Vusvasn8g\/En2dWWHdP8noxErAICPrypiG4VZ6rq\/b7GiTEuiWRLSXU0Fm7TmwbWfsU8xepTrdDLov+R7nUOXq9cZMZtsdEWDxZTS676VRvPPzOvmq+9VMZPKaqSOdFZQemZYJiTUGntTHtXT378jUWS3pv3V3BiyUy1OlgSNcfAejVFgpZtMFwS1Df6rwCi+uYvmj0+BhId3xLPFXI1pG2Tmpc491X0BnpCT25rESPdLZEGY6XAeUk4EbfBDSwjEfGkRd5coapUOPD1NlEYloW+drqGJSk8xz6a0Ikq\/nw7gVWUDqruWw6SPXMEfVAjGItHODnWdWXrjLTQuhu3BYrMy4xchwk1yKmJBnKsd\/mwg3px9zLZojAfE2KisG1X1Amy5jHMNnLEFAkywTqUMFcC8V5RSS3S8uMgBSnF5JCVKTQb+KC0KilRuq68UtlBk+jvzkTGcCQrOlq87MQWVbp\/6Mu7Ng4T29W4D1OXg8k9bp3BpNz+8jI6viUlwl8FR2PrumLZe4\/DhfnH1mHFgI0+7HCgNfYXcUdvICFkbiELQcP0PPsVXrs4I7aBo0mjeRW7cncuj7o1zvaRACy\/VCEXKEOZ10Uagna4YAAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbjsE3jTDdtjckWCfvwTDtha\/9AdnTpE6V\/TBqC19+bBUiFsW+3kRbX8jZRgbHbbI7\/YmA==","type":"ideal"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"MasterCard","paymentMethodData":"Ab02b4c0!BQABAgCCognvnK3ydYPFoFKGKJEJleIkYbKAN3VVg5WXPNE1ud05KRqgsNVdvwuu9NEwpkb4UutL9KBUWA3feoTBBAWVJt1qpgZXF+JZOzfJ6BSc1a0zowCMQz6wtCI\/tWBxKxaKFaljAv30jga3+JCQkpU\/4gq2ubsNWcOWJWDFEvH15WN4gungZebQzS220kOfwyd6IS8TnwEWd5qg40rt0xD8xBaPoNYd5Cx\/C92i+6PtJzIX2SYBjGjG7dZmKno9RTXawhkjJmssEvFGgw9S9U+\/MYwKBel\/daKBTI1c+JIc4zqd523iev0YCruNLHv7pO4MTy0VXRwizCBURJZ8ZskCUbDM8FFPwxcel7CnF6ts4R0blmKKZCJr4VaX3uInfETy6x\/qUULaSatmFusDtePyQDzZA\/8c1jX3Uq896mnGi2nsK0DDeFzGmPA1rKEg77YGPtu2MRL+7\/9d5WOoqBzTe8h7Sp0uAP8mwx1ySXq9hdf8tkXrnB+yDP+DcBA0+sBNdx6PocBCaPfK4rwXZanRwFisZT2vrV1+e4iKdBAOExLm7\/mTlmhD8OpXugJkZuEY9K634aDcaNYB8aK1flD5J7y+eifQ0tuc18brADlJXIqpVx3uPQyA6BP1dNW\/nIFZBVnayz1lZXErLEDz899zB++kRFUKaqWAdGRUVU3DgRAppOX0EK6OiasLkA2YdsdkAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZrwQHzXOXVvxGnqd5Cf75gjjoMkWzjgBSDVUu7iX12mv5VN1NNupVld4T5R40AiBQ==","type":"mc"},{"name":"PayPal","paymentMethodData":"Ab02b4c0!BQABAgCNokZKlG1MT3DDsUkmC0wuH87A3cCl2OZGQ8uu9Oc2na4sg1lYO19JLWqo83fNrq2L+9caG\/6t802SVQtD2ywXUeEU\/JifxXHbgD4zgC6I2XrJB2BrAVlfEu+Ni2Mkmty6R89owPoD4BH2BBgnb6pKYbgHJPP9qJj4TD\/oNst2sMkSXPNJv5v75ZhhJpkYM2MOO+eSgM901ssLWT9lj7ppbiavqoO8lpGDNHD\/IsJEqGvWhpIXrOFLMAx6FsS1xnTljouQv1kWYG\/p5esvpGenhWQkreUl3uYfv172B+3pRpCtHCL8qMflB+pdYKL5c9Sn3oTfCd3YtmINOtEMVcH8zew5VY6jr04yvc1x8sUYcdhovYfm8C3kGuDG+TEfuet7QFeRcBx\/zzv\/GIxsxqaJWA2mJEQNqjMbYrv1PzQLA44GcdgFI6xpT\/AwNoj5MALM6GYKs\/2\/0T1lYRh\/\/o3hLMx9R\/X5QuiufQa5zn2uZCyiNXEDaJ1bLNQ0gGQ3X+dkClEfidD1oxfau8uanfQ\/LZNsFWvWS9qaEyLSRBYEfQDDPMYujFy+C80PD51rDOG0nsppKLJ89kPR8M2F3OGE4PG2ENPOBtBHuYtnSYTUFFw3jSL3oZ+O+a3RBDlURp8QdtgZPYZHG6WBIb0AiN0WK1Xc+i3sZQ8s+nJrshBBRRBdkOu3rQvcuTX0wzkVrcOqAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUnF2up7n17FMeYCgsWh5y7+HaUMslBb\/NQw7cuTFWeKoMv7CLTU4HNxt1bdkYHC00DSDxA=","type":"paypal"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"VISA","paymentMethodData":"Ab02b4c0!BQABAgBSuoz29NnQafIoNneRKy7zbb7IqZLX6ZV8vFZ3N8ZkrkcwfMrKsfHesG4Qeh8R87jaWboITvb7muraTbZSTFbULBnyIlKS8j7g7WnKuxoTF541aiEjRGcF8G+5mktPsM09wFcgEKMJuI8CbztrjGMirsa8LINAqqMlJwsvwJqMDmBjj6S+lEmq6dxGNIjBZsBeSqsihOfZ1UB4Jz\/Ne6gWwvhl5gEaege6mdDxs\/y\/g\/93Ml7XxwkGeedbh43LcLPg6lLPM1QV5NQ7Qt1vWAA9mw2m9ev95xitkZRNoMXgQuk\/M9kDwofWVkmfxUP8W8olKjjK0p4rQAEpT+ORT6RPkpNBpzVzvEgwFUpZr4XP+LCasjf177sLL3MoZUJ4fZ8QfXaPLaIq\/nY2FFESItOU1ZotNF\/EAsHt\/OHd0Zq9RSTLeSOfGMDgo\/itkS9dWrQOoEdYT\/7plVxnKo46eABC4cvTn4G1s6CdTJYgNXkA\/IcMc3maFvyyfzNcDGihF1VwpMpWEDg+I5is6FZBU6IKJHXVEERmuLSzi5OImCn4CWXKXXrM4+3U8+OtUQxN+pKBXvxaP1eh8VigtWmrn94MtvSWlrJOOFn178cV\/HqZNk\/COf4hqC8qilfpSzvkMteg59N0sLQ1hNV2FlLZQjw+PTzu\/f8onV8M8Euu5DRkexCsL6yXSFRqurrTdabb6j8NAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQRC+LRtIEHnt1T9Ayq9sA4kWH6yF\/z2vdEl6fMR\/uE2\/6SRXJvd5DqpPfhoLNBPeYjJ","type":"visa"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"American Express","paymentMethodData":"Ab02b4c0!BQABAgBEGvruCjCI0v7n7aiHYnRKwExtyMG\/Nu0gW1S9yqchaWGFbonc+h4sZf9dK60J6iSibKWhjuYolkUVx\/+GwSb\/vdZN20mJTlrXEEPAyQI4qMIb5QVKa\/WTVbZdeOp9kDhCbn8fBBN58Y\/Uk0TdHOH4wfz1rOYaferr7iucPJXZB8byagvbUFvzwpS8GzoDKrp6XNgbKkd0y5oEeE17Cl0d3fGgbCJk\/B5D\/kTYEuAzqGZUA0eKQOkZfcnc1J08aDNLK5GPNpNjZdy2oeYAmsLZY3Zube1orrk1GsVIT4J0BWA2fw\/TfGPzxMsJZc7SfmErZSyJEWpDZraRYFIXMZ+IT5gFYzORRkkMFyqhvoUCGTyK2jRZzk00XCjMZRke\/fCe5HX0gxDz8zBDWpCR6ekvfk6GKkKtaKAu5tcQjFICarRcX3wIPNYhxrtESiWtzTugjnH1ZM7FqacdrJ92crsb2u8f5uxPOSFNjJwprkXXIdiSYxCiJsz\/vMy+usvfw+vGCUtwDaBXzvWAf3yYvr6ZI8r3RxMRBFvFpnRHpMDhuVGkV+3S1HUWV8xExq7MuY4jEPlWTsvM\/eZyXmLg8O3MKvYioaqvUDa9kecB5aBAw6y8+lSWgGV1cHyPl2RiqUNXdrz6+fJ\/KmQ5x57CFgw4tiPoivUJ0uTS69F7TZQjohA1QzcXutAWtXzBglU99635AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZfDoLu\/zISKFsToh1bg0F8aRlRFGDHwqcUx7eum3yCLQD21cqfKmrTLyacrlo5aM4kt","type":"amex"},{"name":"SEPA Direct Debit","paymentMethodData":"Ab02b4c0!BQABAgCbwCT+JO8UEoxoBPrI+qyUS4vR5TT646v1MiN\/gUM4MVm7jekk7Wd0Hmrjk1\/NEg7NTAcpsfZDBOcMlQeuTeDsEaC4kBf3tqsttfw+qY6TbaFLCtgNIr5wJ3dm2TwVhFCYVMArwJ5zoBIsoONUWpSKR11DY6zE5vuDgtifNA0YiN6h6rzq8O9GuCrCqUJbu23PMejDHA0rHDOKyxyOmBXHRvUHhNR1\/Kwtrvx+fYANnAHgkznTH4ldSXcuaMVtZFqcpHZTiYpLv2ydiT14PzipiODpRGiXy0nO7b5N8Rs27nYxlgH\/tDcI4eF4jl981TPKlF+u6XEOGm4Ebyya\/BfTDp93rKRMxo6K\/LrfI9J4WaA2tEZo6eGNbRuKPpBlV3ASu7wpCfSSw2NjouVTCkfYt8+XeeJeIIYZ0p8AWjn4LTwarmSVZ7cYw9b9eCU4XX\/RrcNgoLFPXEr8w0McUF2n0GVWDM7Q5b9UtoZ36yk185LXmoMuy\/\/vaBIvE8m7Qlgo\/YROv9Uem6muLu4hZzW+V+WEKAmwGL0eJZCdjAeGWz6c0nty8PNMUv3pf7tTeYN1gsvQfqlij3ILsRLcw4kNYvElnGlCv8dgu3cxlz6DsnMuy\/EqKQMZAIoUCd6eF19I3NfvAo2j5MfrpSKS3QGLTP6TXKqgTNb6d8sVD8gRKhCDK4Av\/N0p2CHGN\/YG5xaBAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWQL\/0ruABUrzlPtx5llC5MJp\/\/iChDPZ8r7lkIf4QbzPP+8ETdxbzNZU4vwKTmUjffpLdQA2aswKEtOzYM=","type":"sepadirectdebit"},{"name":"Paysafecard","paymentMethodData":"Ab02b4c0!BQABAgAIhU3xKBF8QbmAvj\/6ONqIvvCbMr98epy6\/KIV9u+yJz2pSj4PoMDLbJxV5PZ1Ykxaa9WjWvTnlZ9NgeB+eoO26MbmIoAsMw8knjay+FE0Pyg5Gj0JXo9Ibe+D513sf4qKB+wQPXfUEqkniitTi8o+jyhbB123rCAJWvbZfPOEKE1RE+FHSEZyVvJmHQPl5y8vWsCKBHjyDK5oLJjtxDfbdoPRrMc2ogNsGlfI\/qpIFW8HXNRKXpzCj+YF4vif8Zn6Z8Eb52rfNZI12xVG6hZnmox8BmMgmSnGkCwnY3O3CFpDTZlCbJo\/XWSGgEe3xeHk7PiZSAjPOVHpDDALRB\/wZVf7XzGYqKkiwtjnzqF8kGYy7XUduLeVF2z4C\/QzgF1DzqzIA7Lf3V+0UBWhpDqHJCrwkAWyTCaOXrqw7T66pT7MtZr5V3lGBUqHk8T\/hNwcuzg9wrx5eHse\/wdC1+2eVay3i0YWyikn\/rYt7z1iyTTIyz96IxxoyMIq0zyULkniylcCspd20\/XgNhbrRmdAt7qPmD9rH+Cp7abIXbbiAM4LWfn9yOWsOsALSDr2TGZDjsmMISCXzLHU+SDOrp2SiJRJ3NHNsTrdEbX8I6w7zTaviTsNMEAd0t9gbyb3kW1F2rqzJT\/UPeQb5MJQ\/wqGGYbIOe\/XGE9BKxQoluKLFhBv4haTKeq9Rr3VsuBtdUxoAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifew63Hop++4N+AhTkkdsSKG980izIWOIBwRrfCIR6YloEnJY\/80hintVkjZcIzDoQYFnf\/zExjiwIQ==","type":"paysafecard"},{"name":"Bijenkorf Cadeaucard","paymentMethodData":"Ab02b4c0!BQABAgCpQPz5Zr3DETTfSmxZeO1skeivMnITjgMXOAmpc6OHdPt04Qs0PjkWF\/7+nfFXEyS6dhYw6aOGIFTcr7R2xav\/88lWDCUhP1G7TtUl87npuGEsmlaqS0Kasl6BD+s5HQ1rlplfffupDBlFj3rePozF449gWoGX+bNq1Vgeh7StI7XB17K\/FDqEYQi+N0NUEtJpCDottPouvo0KgKuED9r0RQjAb8k3nNEuAFxkLTCEfgrRYv7HPDil4dx2yqOhsbv6DXfq0k+JxIFIR6HscRXmggWx1yzou4O4OB5UepYBSlxoJMKqEQXFQxURkF9RI8gOyG++2KYLHHolZkqRImnxeSZ88yZ3zP1eLbaw96TmsXcSk2Sjg5qWEr8RpJuL9UaXEpaOLaqm6E0QMXkbw7A2945YMYTc51tIB8hjY4GOVsoVqkKz2c4Md6yziKlv4XcfI5cMic1rI9q3x+NTSnpNAEBY9XsfE3KV+5dcwIUvIBw4BGkH8Wg9+N\/WZFeRLDKgmFwZ8kkTYMKaax03oHLR5\/NyCBX6GiySwLOqm6QlHtTIVajskcW5qQO9gbz\/JWxBBBtyAdeThE1Qv\/09fZULNYPZ5CgTot0q32It2Jash\/jQGf0lKLDjqWu6Xc\/rPeFDk6M5b6k8NZqSj+fegHK6+NmyFMzaBLWK8uyeSzUCbxDHtI02OGPTOI40iSVTnQfjAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYEvni+wibC9so6deSW0g2CaF42cgtTYVc0woMUDCt0gSvKHfPkxEExT4rv2Pj6tBy5nTOrvmoI73RtR","type":"bijcadeaucard"},{"name":"Fonq Giftcard","paymentMethodData":"Ab02b4c0!BQABAgA\/VmZkWktBF5weoHZawlAmhz9rivBPh3eF24ct7JDXb0uvbxZCJ6cweI0fTU+i4iyExCthFm7I6wxgRLrEznH6033kj9J+rr7d32BywPOxNq+dt3yG3lZN\/LfO11k\/HeMobXvxU3\/al4nszGTXyVMiLTgf84vzyCYZWifPx6pakWjMeHI0qTYF2cbUzsGsoob+AUIh8HBQ3cHs9eRVTUI1P9QAErzjYCNzFljjayFgG6iWuzq113TpuLuSoA3YHn09moZ\/AGu4HIUnTK4Cfp9fu5\/FMzFHzRxzf0jxcy8xrW3ClyHPttsHxytACCvCt39xyryiNcHnmnZGzvcOb+R8DLTG\/jXLe6KjQHfWl1WjrCOHr74PDBglYf1wvicYj88iqQLI6TEzJopctDxmWI4FEyfQw7DEZX\/LooqVUwYblRuV+k1qg2RVJ8y9NaJn4m4R3Ti\/5yc9Wq1OrvpYUbFMB56DuCBm63knV3sEEFJRSUtVti6uDLP5NA7cYM0NRWLjyxYBMiI\/r\/zWOEg+mLjspuO80gQeg6aC7PzfVY5bj2YGJVY6TmSmVdNZAipa9xzHH4RpB5R1Pf3cBT6+xchT6i3ZFVC8VY9+iCxxdpG4TYeqcLW6pVe9hHAe6vq97G8+F6Gghqxb7Z\/DlxIPRuu+D4lWa2mshpGNUTdbF4xuzhDxi3\/zjFAoR8jPpymbJQZoAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVU7KkI531G4lKfLWRXWEry7pNzwCMfzANGS3PGZeYA+2n31DEhwavXsiPBvv3Sx31V4XCQiEEUNE0k=","type":"fonqgiftcard"},{"name":"Bank Transfer (NL)","paymentMethodData":"Ab02b4c0!BQABAgB51DuujA7vUd5HEKFbHqfqbOvXmmtjP4CdUi0JruTVYdcMSuKAATLdzyB3ayN6V5KrvUKitJV3ogvhNPtJ7gGBKB3idHBUb6v2iy+YEvuTb\/\/bJ04X3OxxI\/9f70qvVKtbSjpXhgmJrO1E0evJrIhml12sCVTaAL\/paykhzWFvHzMmUZV62KWOayWyiMEzcnndbG\/CkJ4OMe22ipfsuNr8TTEQwzmAMiSt77lDdeN+y0JiyQyLHfR+gV57FC5PDYgP3ylpso4W1VXCcGx6jRFTwHhb+gyJf7HqrWErYl83GietwukM6TB261cadT9NHbSfh4FCTDvL6twoRzhefGbRDuO5xvs569K\/e9VCSEnen1Fa7vZP04azaZ7mhfYUcL60CFoWgNkJt7NrFlmSO71BzpyvWwEJYFnhk8vLmjDd8UqitLyV2hrusnyK3ESHiE\/k0d5Cbil3CB3QEyhw4zC6WMzXIutTMvLaJyn13nR4SGWhObWomXkSvX9NKv8NrZwy2BXheRAyOHStD3QLBORrAiq9pEWPZF9wv+eBJFNmDHCXwK88nlKbFKV4WzTO4vGPbNVGrHyM9DVIRHt25neVZBYcDGIyVrUI9txBm3rL6QUqnt4ly+5gDFNLjhpFs26mkcex0++7VgpuzcS9WUOuiOIY5uBplYS1aPesyxW6uhAypRves0tGoyoUelhL0ZXbAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaOmKTlIMV4D9THzNGG1oMsJb6VRZpIiBiSEWovHLgIBa1wHI3H28jenqzyq5a+7rK5XpMhLpq1i0LLu","type":"bankTransfer_NL"},{"name":"Pathe Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAhO2Q2JTyJ44bDAkSQQlkgI86+4Hz\/IMv3o8J2Xk9Ky\/Ckz0b68SDv35YholJFlJezRYrYWntzXfcjcfrv+HsRqej9Aieb8bGo1NrSSUa5FEpB\/aGXAP5Bn4ph2UzppDyACOOy97jlG6CPiZZZ2RPW9\/2SBP+Zwl3fzE4PyON4uM5piN+b9c9mQBlUZ5trTAgcOPBPhGpdesNqOklsHUYedp04B5RH4fyMDQTotP7WoHpbptMTPhLuuNn9rFRaIZrf4n+hnsiGa66KnGa\/MK0RKpwI5vgcY7TJt7Ym9lqwcnfjwYSW73hEeZj9J4r1nhTvc1p8SSnKN2wKCs+Tj4Bla+7pPzJjxpiNdeENOj+DVKAc4qh7lrGvLs\/eM6sTwrmk6k6bqD2VfC7yIlcQuWgwEDyU3BELkun+\/KBfwH7O9qC8YdEQ6ftHknq5qu7esOgmKUPrh0+0pO8QSnuzeObGcmVZsKZSWPK83W10XUtd\/Eb557f+E53C5wurfM6hlkaoLA9Xy4tuq3OyzJSn+U6f5jnYpWoPFbiU6FfPI594VjasrFZiaZ6pZFVvqe3z00sj7J3FEKtPDuABbgCoshdUeqkftUh6hNGcP9YieHtKEXxqiXFlk75yJ1qZeLvh4HeBJUqwctWgwyCirIBqMTI3icF31cdnwMYj9x6pnK56ahAAcSdzbZPYiLmLBmK2IDnwAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVSWDvE6KaKChC2HUEIlit8WNjy2vPU\/veo+SPjHQXporYlv409pRe+Ott+IgTXXbCtWN8G6oOrVI1ht","type":"pathegiftcard"},{"name":"VVV Giftcard","paymentMethodData":"Ab02b4c0!BQABAgA+A4idTs3qRa1aqP3B0gIqp1\/XQ+I4v6akD6AGmgH5smozPUK8f8UzFSBqwgq74fKmLWOj6S563FZHvcS2DdPKSATlh8bdG5htjyaFWkyHsuyga1\/fX5cE2FVFTNNoIsS5elKNHMDEXko1napgYprIJs0Gcugn8wFRZzbd+iVIePbiyQqlNdgdcrDOMncTEsRVR7COekfWBpmskzsVjFeG7h9LRqbtyGQ9py\/u51MUW1t5OL57vuxI5mE5QqdNEvIG+04QdIa7A+GuZTzLvnw6mDif5RZvD7BLpYmvSCBNCHJLh7JYxJantlkz6YqBf7cQjHBjZGLvEnDLJ9zEUDj6A1r9zIrPG+Ds42PyPPpskOZSURGZdyrXcDBrU5UToyEylRi\/gtnHMawdHnw3VIDmmTNWm4ma4XzQgJM0yd\/AhZkqLGUWnPeNqKMIhN\/ZOrql39QeB3aj39yAJ\/+XYiRFeAGK+o865GFONaw68JjO8q7OOPADwbDGUn24g3oTtFtbDtjbv\/l8rvkA1wc+DQomK6pezGf+P5hkKQgybaxG1ryfXyaMQbv1hojwVFRC8tWbVOy9bBqGmbZb3ue2jt7lcXOtx0xTswFXzB8C\/EoKZQ0H9Wi\/HgswZ4y3SxepNzD2utrehnbyWVtZ2uyyOM8X+qT9h+98W0V0vF6d7TTX2RB0vtmbGcwIpf6SXVn39CZEAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifY0HazzPpi5jbgPfqO8hww7YnpWeRhSLkbwJPQ5hYZJXsXn1Ma8rnwpYYi8jfO1FJKBq0hid1zapJg==","type":"vvvgiftcard"},{"name":"Podium Card","paymentMethodData":"Ab02b4c0!BQABAgBzwaQU+Tg8IgY6LWZFZR765RW6ZQ2DZYU0DtHpL1P3XYk5TPwF7aG7Yb5nc6wFkt0kpUSyCFKNn0h+L61XtT+NoDCTTYCHfA9YtTwb34NY+YmZGdKeukR7TQJscKNPEFxzc7vdRXxJ0vTBuyXiLP27ms6db0e5BtAfgF7UlVHoBDhTBl0UZSK97b0CRrH3orO74z+H9UjeP141HR7za7ay9Jk9gXEtgFQxoEjacvjC+IuRu6MZ+rfrTiApkcFcnap95mwxYQdzPWkZH9ka2S9NFVSBTx1g1BmFopj7nNQBHnru8DXVxnF2THJjf9N9MElcFcKnMDf45szoYTQ6dW+0W+wTKcQEUL05yIaULsYTfqgFegKJtdHBadGgUZu6d53dCK6TH5gTxSmV8gxuOMFfJ1XKJcjJ\/WWFkgRA+9FJSd9vrGHxVP4ZXAEzt6SteJ8Ew76VvEOkAp9K3kASCLMrJDKifEV7t\/5VDQkPzg\/+EWScYpwtD0Y1HPziNaum4xEpHl\/Ivbr41ZVDSlgc3u3z0ET9VPz6sWP59oPY0pWy+45XyL5fia729tJCLxCPC6HxMTf9YR9DtneDA0fQWS8U3AS2sTiwYasVj9EPOY66YBqoF2A6127l08qV8OJaZS4enIvuVxtE9VGB9ZXVBB9t3GeSj+121B3fQpcvWbfavBCmqv9Z37f3YphvyLrb6gkEAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZqakCpG8Uf0AtkpxtcdUkLTz\/ij5cbS99cT58Cqwnjo0muipxwf1dRNtDIAaluVuyvM6IHNGfql","type":"podiumcard"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","optional":true,"type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Maestro","paymentMethodData":"Ab02b4c0!BQABAgBqjbzap3VEI1UTDAV+YAxi67UHIAXoXAQYl9pQDP8PGTVnvd5WGD8MFgUPYUSz3zjLiRomZirNNwEdxns3glOLxnbasMe9cit5CbEmP9gZu4MMCouutZg2qhhrPBLewc\/RKJJPetKUjW2W5gHXEUcX1tdt63sg2Z8o5g3y5+WqH2NnoHAQN8DYXZ8W3jAcltX+Uz\/5hIhV224RorNAOM8tgTB6ADAM9mMfAU6YEHHB5ADVdM1IDtRbg45c4CdK0nIihZx\/kIcDW8aygpWMpPCuFjFpO4f0cAtXW05N8KA2VjUAqjt073Hzv09fXZjVV4rLo29NNP4qiVYIm1GRQa6jQGfyWfVzYRCp3BM07YN4ISP2rVNkRoe5c0Tae0JHb4pUJ3gzr6BOXEySl\/Q0rSPPEJtmHGEdtmgRKG9UWhiwQVBhvU6MDDEkdCbfAeSByT0yMwmFgqHZVV6e++2ZSOxiMj46mj7x1e\/Jl8v9OuP+YoqYlWqZkdC2Cccm3NB1+8vkuid\/sj+x9mmjHfx63oUZB0WkuRJvYcDrF6ije8C0TdcE4XWVOOc3jHsOSSq62d0pssHA0Q85YP2w2RiOuPrPI7nddvr8X2U8C\/UhO9jHff9\/3TcygwEEBZ8TPWJaFrDPzHVhMTMQdqcWsMCOguIsrWReIT+xytzNbv31WkhfyRBKTiRvzxvH\/sV4UlKUv4+4AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifdjiFWBHVC0eyVNBpmJjARVoFkvoNhGDK4dId7U+\/B8peVyQA4VYtDRvcwUea06G++wmYTq2","type":"maestro"},{"name":"Rituals Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBDd1AVaDRsad2eK38Kfjl+D+sqlb3Jhz4EhvuJXUFSv7cO0Q0vxYf2X81UR8if722Ts440VycfZaLlMzlCHnDhqeb5azij96SubBEZGYVdrpup2WLI5TrPBPJlDwcqbK\/AYbZjvSD2lFnJnrCu2D03q\/RE+CiXudWYMOPwPxA5uazZ8dlXXEmvh3KacG1wVwNUB93jK0tIFy4T97wrNPuBcgoEqpzumVZr7GVdu5ZsKZQsiDUHshopdhTZZvht0NEiCeE7dULsQw0uRh0+a6YHDsjGfB+cnfEhkYDr2BtoJvvsLRUIGs2ph2aW6szoFs0HP\/37YecNjQIKPSRN7XN+WCAxUlcFoYPbT9DXUXjHQMzmGCghy8FiuLc+abBHfw2GOv0nUQveBMSkyAaw9Ae0ViCTxCv8VmBLdlexnd7T8AA8frVZBFD9nA4BleNwkieZ8Jmlfv2XSUYb\/tVdovh5mueSd7sdfp\/zGwtjX+CQSW+NlSaKja+Lyn+RDhVUnIP+u6rV7+gdXLgfaAUqfFWi\/FunGZFiS1\/kM9YJrFbNnyEf2Rr2DscAtgVpyaEpy5ynUIaVXvYSxyNqilxX8MEayJkG2HE7617sy+9QQ9wR3um4K6bbeTaUlM\/TPrKTrsCMipFYevgFXMv57Ra4eLBzQKOIyMr8UpN+561af25XXxBQulOAgBXuMINjKZiYcCG8AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifdiOv0yNIw1pb7GKPw8hm4kjqLasknYB22lS1sjVFDm6RQ\/TkAi5N+4zlIbmeTFB6qENcBY6","type":"rituals"},{"name":"Hunkemoller Lingerie Card","paymentMethodData":"Ab02b4c0!BQABAgBOMjIh114zJyMJ3guhOub7m4v5km9d8vjTnuzgFZxUFngv9ioM0baZgjbHF1kitGBWUiWuffyLY6+NOXg5DRbxNZAIJbfW\/dxPkD8Vv49TuK7XKKXvaRpBpLiEVIzLlvqFC6KF5pohIpjioYTbK+VH9vzjGGzyyvG75QoXz1nZj2LmVrds83Gb5JjBxeBtqwROD\/0RvmS+wf3ybnoeh\/06SKaRAWz1W98PMe9AAvDT2s\/LFkPWjmFpGnWDK7mwKOWhIULLfnJZOD0pnb\/XorX3VPae8sJBEJdhuZgVXk+aox55WTAUpGKW+8UU+tHY1kda38Nn4ndRQh781os0v6edJ1EFxlFJp8cIcXeEf7kvuIoufCPiLf79DSHxJVCsEA2Sq7uKcTnlyaoz3uXWXp4JA6lQLfZKvlwrzcx04TdCXAO70Y8G1PSE7HMAV1bGLdf\/ce7Sys6VTGHDg+UZNLl4rY4PaGyvhrSbMBWjiolIKpfSnO+nn0U0JEbFLHRHCrM5ojth10+pLkSaaFGR+HBhKQ+uVaSzw6758\/yeV23TondUCl9uMETryEkpQvEN2OxgH0TBMnmB2R9ubwYjGY\/QytJZDnhwWBm9jbMJIoixEIArUiSZR2jSuq2pTtb3crGl8gnMDvz6yvY\/Wp7pWo8Ay62pB\/EfWw8yQkqCVisNehAcd2Pr2NCcmD7w2Ix4aIkKAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXPaKLqHcQLV4IYHaD6ib2xySERpw3Mdd4CedXeAqGC8nKp0pPLQ46X4V3TZg5GLBcHk36UmFt1E","type":"hmlingerie"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","optional":true,"type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"UATP","paymentMethodData":"Ab02b4c0!BQABAgA+ir9YQzKM959cQ+mKHK\/ACCzf+epb7mwhJpeemAETLlPukrlz6cc8tv\/XEzHYcSDuBLD7quWFzkxWPTVI3q1XrexQk9bWgqV3GLdkzHnP0isR0JLEreivj6Z\/af\/q2IbbAd8c6v3Up2GLZgOPkEwiLytz0pmrbDgE+klCIoZ3vYKhNLJHDzAPaT5cyg5Rk5pjbZxz9x3WOajMut2HF5mQw2245mtaKYLT9SCcNCEOEB6PbRCLYYSGCvm0fE3tF1QsqptFoPReAx3U2NJw3ssOZ+C4W9H5qPR22s4HCvB40ZQIchux9O9x4TiQkD\/F8d055V51py3myBZyIXW3IHol483fYM2FsVs0PMkE+t4v++cKgQHw9I\/T4S4xpIxGhdxb\/Epz7i8QhxturHB\/3xFbr2JmktzFtLI27NJ7kdhfRE9WghQIMjmqulLBXc2iF63kuHKNyZGqsyr8OKS0mmGdWgyaR2GKEQvJh0kEBa4ZcbN5dWF7C+bba\/QGg59dAttGIEDXYM2aTI\/o8uKvPKyWrhtzkCmCtj0iMaDEKSiKVJVqfCQVVbgl8xyQXA8ChDbGo3TTPRgLUAWDllswkTfBfvbXtL8sNNUAa20zwo5xAMyw2gt0H8C3xnWBDy3jNmqVzEyeSe0xFvPXk7deYlKytZ6SUdUsbc83qaOqASv1NhBOL8ewqdnnYszv1JTDp8loAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiffr6Kyg+U\/BHwUbzhvvBmSBEwlB5SD3xWgEq8rzCViQNW6TPdGagXycftIVUlnJ7Dmp+","type":"uatp"},{"name":"Primera Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgBr+wD\/5Gyd\/QR5Gd3nQfdZ\/wpiiOWsTDw+AhVQV7IJwyxacuJmewIRy0O0O81MoVvRc6hb7vCTfETXbBclLTN2sxgwWMJEAAW468XQPi7oVNoI9xrn6f1cscY2frgc3L+zRA93sCADMPVK4VoJ2BHkTCOoDSXeFcc\/RhLBjn7Uo8tVohMsWGuvHvDT0GyDne2V9cQeJ\/8Kv2Wrc+2eO0vJYfspLRPvFF7DitCYRqPknDpREwvimweEm2vZbfZO2DGrBizZyGIep1HK35rVk8\/d5Ep88WoIt1IXlXoZODsyx5Z1NkN6RSlPQtZspLb5An2uxmDGd1eziUsFJJikbpn2EONJhJxGNfdJjMbvRA6qdE+1Kx6Dlk+s9EQ96Bg8Ho\/19Twxvcnhgb2xJyoC\/EkE6dEA\/nwQZbwyTOw74PeKgBFcbx1ZvcblarESRTc8R6JB1fuEoOKVKJeifkpoLU16dvLZ7YBQKnUKQmskcwQG1H4A0qn\/kq2ztY1JdI8haDVh2ZBQEJEHhMGXqeO4kX96W7y0auXb46NfGhRzLmu+82I9DUg13U\/MvatGfYiTd3KqlBHxgxvx3DOFKnE2NKeoxiyF6bPRZFKvDNhDXZFSF55f8Mgjwo9CD+WCF8YbM7GlRxHVq7STP3pFI8CSLScNaPp+YsezSo6\/6gJeOdmw3RD1CQXCaSJeywTMaC1\/mlaRAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVgriUMVq7kjHCRe8bocfRBC4Ox6x2N0IFlO7PWaHuFYtIoTGvSa2zyXKIDP+WrqyPZ1s2Hj408pibGA3Il5Gw==","type":"primeracadeaucard"},{"name":"Fashioncheque","paymentMethodData":"Ab02b4c0!BQABAgBTwcz72WQ\/rWZS7SgH2Vn8g7rWbGC8hUIDzjU2RezIuYG+QZc7dRUdnWEarKjDsnnHwhj2+bFRC6dHaG4OcSbbQV3Umfw6DKYzAQG237U859Oeb8hv4sgi9bsZl019pZ1Lu6eNCficLEVFklBNG7zOcTth3OY2fzrE8WwtgAQy3MoncJwwDtU7nY\/kYV0ld1yggEDG2\/nsg8qK61wXqkvpUxWGHeCZqjivzFdA66PHPB05iTj0WlsRigIoHQ6Z3NAri6kKe9oaoj1wOVpZ3LScUcAo87w8CpbYvSROEOnlXfLvOQD5tBO8sJQo8oZ\/Pw8\/Xz0UuAn3G8My4vR6wgYs+5bkCYpnU0yF+4g8\/nUOs3V3IXb0ylgoXO4X17Mb6O9\/zfWxwNBXiVOUFWPkBA527y69lJ7s+P1xrdBFBTOnLsm2nrSNu0o+DKHYS+OXbK3niywYaEAp5viCBAbbvm2ueq3Wvz8t6lt6TnQx\/RFxE2YS7wKJEZqWeGyn54xwrgtFKkXwL41tUInvOy3DNIQ+QCGAwDt3bAqiVqpmyeu\/5d2w4wya22HXs2vc4M1BQ0nEOs2RgOQul7LYyz0iOm8IpkZLIrGuq5Fh9\/nyTeKalYCYs1yLk01qn5\/RTLSzJDEeKO3IpBUXt95xY04Riu22XzdS0LaGZXXsjTihOUVvrhDq8gRHzofaaaaN1Dig\/07XAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQbcBV13AySSRL7q9jEJ66VjBiy1pyPT7p+5rNS1f6nFrX2yxwUAuIrtfRkLo8msxea0hY6+GBy8ntAl","type":"fashioncheque"},{"name":"NETELLER","paymentMethodData":"Ab02b4c0!BQABAgCChzD1kgErFNDP4mOuRgJyNzV50gjQtREUn9li1iXE9EHo37JVkIbGJoWIArhh08dqFhUJ02+GUJ39M\/pvwgTm0NX2i\/EoWJ8MSV1oNY2imOd3\/vB1qZ278DwNf8L2mI0b33DZu6LQomKOX+9lt76RLbeQR6ub2CdDZtMI+k795cNCTqpBNeUjGF+03GVfq\/PmVVIGwTeRMxoXICK8bMdUMIK9lf7RQKeWBdtVdwsCE\/3Vxo55m\/BSNMV1TBx9Gb3DiW947mYUXFp8dTHrTVXubFGD1ps6uI75qRzkmbsk\/W7giZxW6h5\/m+ntyxzG5QVMbwHYWlxMLD84AxkG+++4snsbE\/m0\/EF1rLA9a+4C9AngtZMjLugMRGt8fwuzYbFQPY1mY7hxxJsh5DjY5AHPNSWUljSQXR3Wpa4\/67H8RZ75XiKIF7P+B+R5twWFx96AHtTd23pusLHnPYl0VoN9eOiA257ciLFPgeyx3\/RUpfmPllsGgy59+7Go4fCe2jAsAWjDQcVRMs6HyFFQ1B+GRQZetNPLCBpgKVThhiiOikevHsNQ3R1W1OIRfdPe5Jt8sZMNWo9N\/nG4yqb6m0Wrq2FXdecjc5PQDkua6VfokjR4ikjBQ1UPeYJo44f0obmLH9d6amH1yMM5A2nv930VLjPuOCvyj94otuZz6jiAPhCdNAEXB+8IP0clv4vQtIWoAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXOXG+\/p12zPuFSinBYaAl9PsoaBeSuADkiwhiK30SH0JmDstGNO3aHTYsorlFcraXafcoQuag==","type":"neteller"},{"name":"Adyen Voucher","paymentMethodData":"Ab02b4c0!BQABAgA4m3Fmy3uAkrABwPHO6ZuMqte1FwI2I46Gj7wYm6jAfz9CYWqYqAmiMdnjKlxjfYPBws\/eDmYwypyJzUmSuuQ0ABXtT0dF3Miip5GISHtTRPuY4PVc6rhd+faICXJq39e\/QI4sFwPg1k1xu6i3kiSZMG5qcOaUbCcmbo7sapxu2b0neAnLj7uoqJGt7wWArzEoJ1OY4qH8+D7f28Y2LFo8cEd2rva5DTBzTLP+tksXVpzqZW9pkOXT+e7ECLHc3ahwtqLmv3jJssBQi7uj2yDl64VoPaNfwhAOpEirY0dNenpOewqksAgdmvMVecekfiWPbeuM9cyrrAUzypnB2IfNmaIsRkRkmS\/UXRQclz+IT60QhoowIPlvGiZdoAbkh2O+6MKcSqhmddYLur0F+GTi3knseyff6r\/6Ovg6E8ZxUlGaR0gZ2b79Bf0INA3jYYZgWI\/mV0nTfMZ8QbWwanQFNP0BNyKe0i3qhdKgvapPHcMiVW2N8BQZk86umQTn72mZg5J\/D1D3rJ91TZbNqSSKKUdIcePlSpjd0hV9J+NUTWCpg3xOUyaAD3oZLBRsStmiFKEhFy3T0rw5m0a1A1fLENYq\/vg8cj5K8igql4PtLKfNVckEls9EvBLfW0vz00nqqXRoZMgmFh+Em1H2QHJpbEQvq1Co042ZFGx7wfZADBBhhyKK03Bxpag6b3csSQ6kAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQlEAX4IlhbcsGZk23cCI10LWUzOFL+evz7R23OxpQ97a248sf6C+osDDcCQu8Y5fQNRGSictAY55XdhLKNrS04=","type":"adyen_test_voucher"},{"name":"AliPay","paymentMethodData":"Ab02b4c0!BQABAgCf1auSGoTYhtg498bFc6haRU6NhnNLG1J3AxjfOfY8MQTk3r2R6Z4ApsTvCopJHVz\/SQzuanZGKuD9Eg\/1Ie45c4tVKgO1jlfBR1d9uMjKIXcSGpzt1Zbw1HRCdHfUKv9kgQFgdSm4PEQ9Xtob0Jr2tGjm0HWmEPFN01rseW8Q6wxvBbVk1RhJ74rwgmGGr7GZXw9zRPaiaqh6Tw5F93pILHz9MFi9R224925BjGeF5trdMM3guF2u+S9X+9YdFPx0E\/uioYPWL4iUqHb\/eqUMHL+Ul56z8ZIakje6Cne43bwAiv8n1XcXtiojd8pO4TAYEPEO3OFZId6g048gVzaBj3Z4NOaKpPa1hkricwbm0D66+349Xt+baHl0JOtPOR\/bQwRHWop7rALG\/hRjivbvrCpER8iEiKaPxNSZoae93Ue9btPL0VhnaWD0NpcxicHuvZbe9dKffnCRDwdb+oqKMKSrgSNGdkeaO+IoAPDhvZGD09WFGVdWFGwsm2reUVcOfeSkeAfiITI\/ZcFlXcV94JXvvYP47XgvDrTnubDVfwK60hfVLbzywzd1cV3+nf56ss3b7I782r8RXcF9GJyfNdlvI6NW7aeAwsBPHcQhHZiT+5VHXbbxyDd4qT4tN\/vcRXz+HP4qULTxg6wxIM4hztcW2X9aJFNhzFYNbvi1uRAgDu1+S5xChfsEqkutUHvVAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiffDrYa7tRXGfbYA6Ge161KN7sgVl2oNzl3HnXezyndspuFFgDrhoiHelB1iOfRNcojjlLYY=","type":"alipay"},{"configuration":{"merchantDisplayName":"Adyen Demo Shop","merchantIdentifier":"50"},"details":[{"key":"additionalData.applepay.token","type":"applePayToken"}],"name":"Apple Pay","paymentMethodData":"Ab02b4c0!BQABAgC0zYM5I3qqo5UGCO0s0MdIxxxd7b29RLo+dgUPNfEFEeolvX6qNqKBHPjX+bXZGskIJFxy9YWbQQSZkEAEqPydtGr7rvRr2MIekcs0Q9jazt62yAypML6Oraktk2w3JDPZuKjzHo\/Z+YYx+\/1ZHOlpWL\/rGB2cZXSO1ZSx5EQKgfTmwlS1NkFfgQzl8sQC1htidsIOZGw9xPWbmscNhpqEZCYlDOfEzRHElu6Y8g5D0yHOXX5TVwXetum+LM8CvClX+DEzp9miM\/0TMV7J+3XtUTA3xcPT\/+byDfygb52WGmiHlEma7rDGdlBQ5Zz7Tbb8YW5y2XNp7f6RZ3ZWy8MR+V+BbFhnbvRP3pSsslI92uiDgT1j8Hk7N9cWPBHmp9eOb+iYa1yFEe9BkadGdYiDTlSrWJSG8goTRFBKRj15d43EvnBu4BXADSh0fNEXykhCktcaolHuusbFAr2CV2D\/TA8V9FwvuNXGAgU5szzvG+jMCztRg7EFGElbAWPMYyENO1EjUpQQ3\/76jS8qXBej\/OK1WtmUoCO0pltPoOPaF+swtitwsF\/t6L7gAEbmufAEpmBc4uhAhfSjh7vhurbWpbsWkeMWT\/i+xAxX75WzCc4jLHEmTW0dDoWK65aHpFqNhc9DnJMDNApF4jy54\/qmzZhQMdv5ZkOJ\/eUcZWybsBD2yl6FzpkIlHBCE+ZZXvK4AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUn8cdiUMVFJnCsfxIFvccbkVMDMBW4yRrz8Qb2XROpsA2iEH05CECs8gLQYfrZbxIkjAOxMzQ==","type":"applepay"},{"name":"Baby Gift Card","paymentMethodData":"Ab02b4c0!BQABAgCUrswZjd5pZD1KaDp6qqgZyn3\/U0SZj\/slMY3xnJoJV+2FyFKMW9sobzu85X7UGm455G1HAsbm8EyIFVshnlD1Sd5ImzSgVn5dvjVytMKuWmQotUFVoyhg0SaHX0ZF\/+ZbqR3xaEYQvhAZdMJ2zlAObRs6CwHKA6xYPQIgoEPVxBhGCK1XLkFWRm0Q9+sMj68\/sa9EKf\/+osl+3R4O2ZB\/4cM4p0jvOBD3FYEZaDGJbONomic58+i3Urf82LOaU\/VBIfGCOLY70JwUwoleAR8+tLSiJRLks9ujxgf26naSML3f9H6OmjjG1LMe2Nt2RZZyFyMkGt84ACJ7k\/q\/gudxWskc5a7ZjmgqO4mrBmRmy\/DZxcPcWavLS+m+8NXaPZken1i6L53mvb+BryRtIOCgM+AhGyUaPoXQOF4XbLqhNqTHRh6UjH4MPLYJrVoSiWSvRsv2J1268rFTHyCFzvqu9v4LCGiP7B45AFJnKphFb62kr6bk5vmdbpc\/S9WUwq2avCbU\/dGFyIyn5rdEammsfp2X+prIEBkMdpN1arErttEpMoCtpKwMqytrvgrDzRgK2iPWAWu5EXB076VJXQt4FZgvWVH77p\/d2ZB1nxCNNp5cUj9ITvLwugnVDqJVwdt3Ze7m46dOj8F+AJAX35t9WlGhmh3Meoiq6VJwCgUSEBCfaieS3oR9KDXDCJYZ2a5YAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZ+JyZ7fnomDQmxQ9n8Ai8mE4Ud5mN8EwTSRGw3hkUzlflEBbmW6H0jk18hDxxxXoMoirYssuOCdtbE=","type":"babygiftcard"},{"name":"SEPA Bank Transfer","paymentMethodData":"Ab02b4c0!BQABAgBzYbCACvYN8F4OSxYlOtPC4ad4Ei7HCFdr0P2mSIdhX0Dl1ncNiKMZ6D7hynZq1IixoecALYJLKLynjW+GJOxzMzjLI+MA+7LwVWkCDP0iHnpLgJUzp2g4sOwr9TGZxz86VMzJ+LhfOU74tQnyF5QeFf1KT0vGRQGhYMLRsZ7ZMleWxglma8WDdFkakYzD4mLHmhYsKORTNC6wsBPUewd+NbZkEA++ajIcTdH4NWR088EyewAWij2WXxvvtE5Hzh7iEAqoCUNXcWeb0WkeHTYXOU3m7iXH8y18cxz\/ioTYmICcpG3tX8uvWmmhiZNFh0ZD8+pFcrWJAz5xmBHa3bCtLuf2Dra6NuD6DZ9i\/bIg8jBJ+Oxe7EVwIxuPMWJDI1evntEmreLWMS7ryEDHjwanCLNv1rzSypBlZIhiJy6WxlvjIjekqjFMbVJYnJNRoJolMSyOAm+qE2ftM\/e6ZmN3FfLlGLpqRIG7m0Q2J1muiJBv+A5FLAJ5G9gjVJvDE4iEI8pLbX42UlFmRMRAcCKNuVsilf8bW3a+Dx\/T2XuLdFE3jTs5KiQM89NVukVfIR0BJi\/YMZdGqQuXNxGA8YxbHz5T7XQfuCHgHsiaWvGfgn3X4ozTyddCfjguIJ0pOfDi3rUwjK2uH0eBwzTE7798AiVcjC52zUEtpZ6fDgKWRBCEudgGtV4Vzs+CPIpRNaY4AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbOWG7Ib98uBx5r9C4Ki1MOyP6skIdgfqL0LR\/tMyQrnQjHGUVCNi\/tWuaF0ubq\/EGOUWRvN4dER4iQiHg4=","type":"bankTransfer_IBAN"},{"name":"Bloemen Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBYEjHQXHsPQ53zYpWNyDvC7SNlrLLaAhQpjEYQk8PPmdaazLV89dowf+a+xepP8tHOTUwzobDVj\/KU776tP57HmcE4gjsUikDXEfiV4\/CSmp6wszy+IKktTTQJ\/iztld7+uvlAtRw1mVPWofaA+B7faxcxduC1jZpi+Sx7ciKHQylGvUmSe9saoz+Z8VyyldP+K0RSzC2+Pw8CyKraL169mDUXW\/5FNNb4Ig8HRVSX\/5Lhi+xIckSNej3wWE5WBRcnzX0PUVKVK8iMO0RPVNmmBAu3egsDKf84F8YQJ08sYEupa1orFHzvVm9JkHzca1zjKD9nMA0rv4AKaglpy\/j85hPLBRMvBEXdJRk8FDojP4C7cXg4yxLz6YbqT5jOB4hd9E0xBfyRl6T6v7XV8vzXA\/XyMsQpH8F7q9kddAIobfNlxSrwqRmR63zPIXuXOudMinxlH5B3F3RHmG5s7Iux6wLE0vrfEJb7T46vn\/+ec6q6Xz\/ubFsE10ZffvIyEM45Nn4BvsgvnL+33zNryl3LEA7ZYCLczmtO16jkxPa5ef1ncYn6+nwPaytmABtJWV5LGAlnoCB8llP8lxDWFQmccCymO5C5KqT27Lirlwr2+9ea7mb2k2mpIqrkbA2oW06GXJ8vGrXHlZ4vRtxXiJM1SXNiU40tfjsY56dYTwh2ZRDooipnPrgBrgDtwnESO1YZAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVq4UMZnNJzezmTRqBzy+ZUCi\/kgQ8pLf\/wuWIkt+XYuYdBNjzZ4wgivSU5\/ixwXRr6OIqRmnfLVJQyQkwc=","type":"bloemengiftcard"},{"name":"Boekenbon Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAhXa21F4rgq1PNi+V9vpr6buE7fMZ2vfXfklIHs9yLO0UwaEBLxDY1aLRDkrCoPX\/zixxQ0J+iM7WJMaRPj9Lo86q+oee4UJt1q3lc22KKlrOwWSsMAWQ4EvtFexyITl8jOqfSzstprJDMC6a6cmD\/Uuu1\/9u+EucT9hLzor7uTpvEB+qQdWhVOXkIbi3XgKuzHkZFZWC\/cXmeuvihyaFdS2E5N77AfElpwTUjjkSWdhuTT4YpEKvV7eGNcb4tknPkhtW7XNXBjOeFecLNJVRSPPs8zh25nibZ0LESEAxUVQI+Ix2aqT0\/YARhZsKWVkf7yW24eP5uLO+3XcmI8GBHyd7ysSDU5RkRBcieId7sBI1nLxmxgA\/4E0YRg3kcN0l\/ejyLKhndPshLpcbJsdQdupQtGj2wvK9iXk5PqxlgY8xmI73DrFI8Hj5KYq5BmT6C17J7Klu0olLa2tQPkq3y3jYgDc+UhuCjLESVt3rEe8LGdKyVg1NiJxJV2iF+wqONs6FJBMKh\/Dt8uMkt528lRWkcsPA0kC182YEYzjMFnWMs1NaSemtwEd2gOvNJbANxduIawfrXA+tmD5Vk6NnMcWfO22hlGu8Ov\/A2d1BrBa1210OPxWi5h36f4xOvCJZB1kZrF\/8LbwDNthGuIOUoFzX4s+h1jYGnG01K3unmaRAUMYsabp4L2sw5MU9ZtPpRAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaO8DXOTDuEp12ZTJ17xsc8hPNMSd2fEMNY5K\/Bq2ZHktR+J1Sip6zl3AMAQJDedPMUNKhYJpRg=","type":"boekenbon"},{"name":"Cash-Ticket","paymentMethodData":"Ab02b4c0!BQABAgBsZiHDR0Gve3zcnmYtLxMOTZLS4VF3wWqCwdtspiwJYi954c0akftgKzKMMcXoFRXDPZpqJ1DeBbkZ5eKjZzRWnjliE8fjO0PBANuflbRoNwyHe+eVa+0rlve03uaZQp4VO66WjFLS\/YulZ1AJGGyhka3MVkhsE8AWdJeSADCTKFVJA8qC1lBJjaB\/eLA8EHerqPxHYpi4s+ykFMsfipRHP9pIk+5xULE+S6NtTmNVT9JWsD6F+hbDFm6BOtrUnEKx3FmlZSYMY4n9CT3paF0sH2pNqJ0PZ9QgIzO21pb9BhCBt+1rXjLNXp82kOzBI3YRVdRGCeSQ2Rp69ycAGhLikftZ1fwRITnrMfjtEhgdS1qbIiEsAhyB1GIBa09755Z199U4QINvMIhrFb49G1YOsPyBXMyzQHgEAUxY7L1H5CwLDo6skb2LzrseaoKXfF4BoqfESoFiRbnI\/OcD0nh6+jFswHIPXJcCRIhfPqu\/pvnHNs+TpWzJgwQTyPy1C2k3D0e5gH1I4gcn46xYpZ8IccL3U53CIIFFLaVwjn\/wUackQO++SixCiW2A0ot5tS+TVQs9w8QrVWKLLiqTSuErcmgyTi36Q0\/hwJc8YCuMzSEYiNxk2wxHTdlHG4\/W21a6EMp+SnCWQnotauR35c6nH7frYHw9x14\/UJ8RY6eG+xB4fN\/KW526zbNgJPLk4fAmAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifT8y+YkU4\/u8F9ki4mg7yPxc9sfwIjQ+eYihenv6i51RTsNjHTECoPrQzMH45WT6euh08tXFLEmE","type":"cashticket"},{"name":"Chasin Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAUCPrmfgcg1JzKH99DvGr8BkpD8H76IJa5X7CQlnRCC4ZWxLbr6sC7WQbYhQjZQ0lYdTMisYPl+8QjAEPr1N6OGsWSbofrBhc8oNe6Q5\/kaJkHW5JFqUgMjnun+jSDRNSyuLOdsPgOV9BcKOYwiehV7v8dvtmS3KW\/l0TMgwHEn4V6bixIsDkEPd7uNX5p9ubVmiKQW7qry4vXq+OFbbxIWuq\/L9FawvKcYbqFjgwgsdZlQ+Y5zmlaDSQ1hfV9Lfo44Ph3vXD7Evyt1PKrmrifi8hcDeKQfW66kBulfIxesI\/MS2C13Z8cD+WutVG0rbD0uc5cxttm89mjvZrBez9QqTLH3MBK31WD25UzXKRk8C25Jdb6iwxR5NTDrRFQwfBgtBdFSpv3jhd3\/LCj5ycPkVSNOKQUpiT0GIBNJ4f7uxY8+vTGfcSjF5jz4kqI8Xgr++1vFAKCN0KMqEoePGxPIeTszSCKZjptZioNxeR7uU0wvaH18iqZlUmKy5K8r00fZAkxC8aFZOuKSx7JDdzcx7Rbv+4fBiLrwFXLsN5Nuksm0WIQE7zi6J67SGXtlrXo\/bpnp1duZzJ43KmWZYljglXd\/l2usrIYC08dqEwc4DUHKHVfiYzZbzbW+JsakB5bU7iXkJyO0mQZ\/pC6fnVogb4bo8colc2fpM5OD5lnhRDeFz6l0F+msrFfX9vv24wkAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXSVD7Xq\/yT9JnfU4nQiMdrcf2pE45Hp0ed6hMf7e9Tg+uY\/f2i70QpL3dxpumUcnd9zDUWTOJc8ddqXfQ==","type":"chasingiftcard"},{"name":"ClickandBuy","paymentMethodData":"Ab02b4c0!BQABAgCpjBOy6+XhVNGcD3XQkmoZdhv9fam307qmGdDkdieV5c7BN+QZHV2XF8AzgRmmUwTtHGgCvxIA7iIaDihSypB5XjC9NFu1CDwFs5zfPS09kuiZxgQXm9anvVlUgDy7l001y+n4maQtgXhN5olaUMEQ93QWg2WKeLbAzbE1+hebus8bcjAcp300TfIwSD6pztJxjQfwRvNzLrhRgszRipi8ruiGMI206YxJUq5yjpV6cut8MgMfioh3\/\/PLoiVWoCjkrK0R3TjL36fRVwY4XNBslczfEUlHCTnM6jLjjCqyAmNHay3oLv93k\/UxaJoUo9iMzFm7gu+NM6V\/eruSvj28dypv+UN+4JAs1PIOeihxOQxI56Zv+jKTO8GKL2VDOeXkBNy0gQmm0B1+vyDUGSV5Imc\/Ykafk4qgXPXG0tz1LH1UHgu+bh9qr63zFpilRpiu8OkoMqHa8CkqyrYG+Au9Ql5Vfh3ZJS9RF9mu1llY2AvNdoue75rdglD6kJop2ng\/8PO8vUSt29Cdemamtct8zQXd5qwC5jukW3+93brD34tTdKdi9dlpQa\/Tcla9vwVwxEerqjiSKx\/grl+R6ojktZXT+tpo5Aeey85EmlM5L9\/CstOQDjA\/hU\/D+iixa8z8vlrGGUisSOn5Fqu3n85ib1KGW+RHNQAJu6u4ZRBCLhDUHY5qNmGJtD9K\/pvyP1fsAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSFcmmFsCSPTa+2JtLxC3d9MEWXmttbt85uKKpUnwwo3MD1lgu30j46g51TaVETPNu63LZYeC94=","type":"clickandbuy"},{"name":"Costes Giftcard","paymentMethodData":"Ab02b4c0!BQABAgB5dh0e0SvTSdZSqNYMMXtGSsTlyg4chLnvV01NpL+W7I9Mz\/KgwXYe+LYuP2yGoM6TAzQacDclI3AAnXAQJi7+5ay\/j\/a0\/m9ViKjmMcsO5f8S3mlxVApyIp1lKQod1QRWdnfGi2jsbq2DQ2hOa2WnU5gOofDPN\/ObZBAhZK3FyABfJvQ+mHMQ3yzAV6UMxPKR8VRRVBr3qexpeNsaSnT46JpijJUU4B1FAJUsIzivvDSzBcXzBNI\/9EKQbA8wbLb8VGVwKBHun5rPB5jD1uCRjvt7d0XuA6hNZiJ8yMU8Zv4yDc\/YmTEStNzZmy+ZjSZOHWKOzoyCDjfICJn3RnvhWJJDNLfbZ\/9KQV8NcPm6Mpm0fCjf152UZ9YMp2nKhGZhnijz+XLGkzUfAokrJB9d+e2EmiMa4CRubW\/gwFrg0yWK3cUV6+FsJT0NyTKkhv5\/k5paDvp1GF3JvIwXPJzpUEkYTolCXBeld+2YNcdjvVEWC6+YC+XJofqSjs+EanKcoG2giz6QXv9ESYwIOLQC7TcxHhwvJu7n0qEPWWvKUdYnxW57ZZKyZeAlwlZ3l6nNwv7d2cvEwxWI\/MSf0dqgN0mvNJTxpEpDb7Uv88IdA1QHBzl8y5Rfn\/XT88yXj21BN2wvqAnvCoU22FgtK41Ti6HBsRRakXeaakmilJf0HxDWh+wexHnojtqXGWZgQZxlAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQ6kqwSa+fIsdB1ujIQB3U3EgrGldRb622nuP5vCg9vZM5Md2djfmnYIK8poj1WQO4\/+ZpLTzxrPFYbk2Q==","type":"costesgiftcard"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"ExpressPay","paymentMethodData":"Ab02b4c0!BQABAgAlRhg2\/ZqSemwr8Ih+EPOdyII2d0Fqd+vxWEbnLhm8aTFGk5cJ7BXwBvNvp7+kSkK2+u61SeKzbYlwk8wZZeLW9ZnSvtFocxEHYriAwg0V6feWhMFlVNwvMwqZ\/649y+eA6KEX0eCxNJLJgGfzmgyX2IN3R7SEBzXoidFDI\/Bu9L1L0oTn3Yjq9zGjrgmlPBUV9CULM5bexH6atWZJoXvQdaUzEh6TOGGTY6myFl1UEVk5+tGP8imnzpAiN1NEGuAzRawNh4yhfkPpQ0Cjm2CNFCri4+A3x+23jXkRFSJtCsZIyl6AeXtbDdBEwnRk9XO0GCxqTwvoqMT1mIp8tr9w0VSiUQfO1YHrky\/N1DLjkWuAmuZkW8rkgO3XVhwrtclmH8+yVhj0Vo9NmrJIQ9I6Iqxco5+368N8plzUCseAlWMmihdlSjOJtQ2bhnBCJR2A+1KSYk92bAccae2WQMWU2cbKZxUIIO9IdvendoaLzXj\/OvpMw3H6OvSbzW+Z6BFK1izrNRilrUyPOG5yL\/bnmpHJt4ueoX22JvnYCQ4KOBa2Lj6EUFyQbZbyv16r5bTEqX8ksZqVpLnSHhvyx5kFcFm7h29\/+GzZ8i\/Zi+1W121GBt38+ZmmNTx4iwRRPQ7zcp238cPnxarzHOLpWHmr42VKrU8ra3wi9i2AoQhd0hAQ6gXAx5EsYBBos\/TzRTbOAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUtH0xd+yU6FqhdjryMG483NbCa8oLdhRm9Q9uNTwIBmqqaCWfAUrVW5+IIq37DYV30=","type":"cup"},{"name":"custom_settlement","paymentMethodData":"Ab02b4c0!BQABAgCT\/yAsGsICPsYIG7hiOwZ5D+b1O9G+K7GfQfbJrYmfFVPbjSqh\/XaKdZa+1mTi5BKwuUAV\/VlOPkPQ5yHLS9X6DqB8YqJVSeWEC6HsfX31\/ANJ7ZcL4HFhVq3RM6D0b\/V3iX4DoOQ8yHqPy\/bNHYxaiF43psUHdBjWsQyFVlkVhf4JhC4fJdPlOacag5twyZHDtWM8Qx802T3GFWUjJ6U04I0AigUBTMQH6BbkthtMnCXsoie5+vbWndD73v8luguHw\/5wh5ebwwsgmbVLzi0\/7OITS96hiAQqR2u8dBSBYKhX4G3zfJhmNJyp1g2z5BU7tJp\/IYU+LSDqkQJnmUeFhQGt2wAFIgFqjIqTrFDzYDXiwb2U2jygr8v2TzGbt\/hTTknv\/xVSAzU5DzADJs8\/nv7l0uP5XWAEFXfI7wuUHxBTySlIWPAH\/+uoyhu+QLfAT1jLW4srNTPgMnFlgiuSRVi\/KGPAlN4HO2O5bxWxUZ\/136Ak8El7\/BMzR8tjPRG7OUjZp+4ehhCXNeeBH\/OJ\/FykNuysKSklhbOE7Tg+N0pNZ\/fiEOgCh0OWam8FOrtLNO9LZ\/M3HJiFYnOT8jdHp9dvUIIZ9758N\/jG+EZrVwNL0bfH0thO+GhTKCPsfcO3J6rTYdOpW8zMijfLk+KCjVQxTD6oc27Ha23Nm6gfNhAPV\/w+Ptb9f4WcmQyqTuGFAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifR75XW+jn7EcYM0F6+owXDrbhi+60k1z1wlKr27vIyAzr8U91Jm14Q7EzlL9zrlbXd7OzeMVjbAOCdHxJa2MXA==","type":"custom_settlement"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Diners Club","paymentMethodData":"Ab02b4c0!BQABAgAo7InmjrgFwmA7lm1eSiENy0cDe92QK9eCftyZ0MRsSqugGYF0kNdG8LCw92FLceMnnljTGM5hhmlTnhUlBESSfbSOLf8d4ECCcc2W4gVCNoOxccHzoQOFnumjwK7\/Nw2F8gXIApCxRUCnzbZdPdXbwoJRaak5KOIkmgStEOBAoikvxvcckvOsP5K84tK6QlyavL7pXDSVIcwsiyKoxzW47wjC04ti7D+DkPqBb7pzhcx8Fu4c\/28AhXtinNMPLtDPjDFA4wkLHvVuUBTEiRy27x5wcDWbHOVEMnP5yqKmJuD7Msad09y9QxJPgn9u9SlbP83ZxPRNFD1jjx3z0ftrQ\/8Gu2e\/BQ1ib1ES1eR7nOG08r5aZ8LrkJMdbuxYK5EObCAv1LKaiJNN0EursZsq+0lLR3I6NdtvxlICrimCYS2pB2vNXohDF8Q6gfcFZgAp8fH7qVmMPnokuP4I947gbDTd\/gH\/sx5fxUVN9oRQWCmhN\/6y16wMCW9DV4vXvE1zUaTNDM4E1Exihr19UKyifA\/DrNKgfBE63SSav8nT1v3N46GZbR8XfXs0R6iad7nxgcrX978op4fRt2tt8wciszulAoDQp2xXCAFTcs39mBqBE28zh97wD2tv2ml4SjWU2HJfXwX0wYUAZdbc5M0e9a1RqLwM5blEx7veR5SaUxA0Z5dML95Lu0GjdnDyrTbQAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRjz1jnjq8n1nAh9RGubBrWwPJjLS7IhRac9SzrYauDeqPcken4Am0XpvzzJJ6O42bAUYmM=","type":"diners"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Discover","paymentMethodData":"Ab02b4c0!BQABAgBYFaiKDD9t3ppHHM12pcphfSfkzj5XQmBKyHFyTgXmRwgM5DCf5p\/qm83HJ0Rwv8++3VkytEGkW5ezjx7niA\/R7XRGPC4JFe5m9BkNUad4OJJKn38246IX5\/tCTC50aazjLDSRAYDfOFwjCK3iCy3jZdbHjsayq3Sxk0uektVCAfGvgOtgFRu\/qbKxfHYX5JhRhRD0kLHqoPy++r1qFoa9ZCAeItPwOOIiOh6y5sIS0egka\/z35JFIpmPgZA3T0F6C4+1\/33Lqf\/Imxxa1WbxxOK+hRFk9xKO8vWA+QLhsNKiGBDdwrrP1IBZu2\/3GRl4c4vTt\/aTfzBMsYEAEhxYKvdpm+HLv1uvY62FP9VzZc7+G6tLgzhELi3Ugk9b0cqW2QkQa3GjRc9oyCmlxpTg3aN3HW2WcDLNH5obGAeI\/KV320zNx6Dcp4QHfJqFhajbiH0kJpM0f14PJFqFIvkjryq\/3xx4rq4VWTvNYbsQfdkjmjxdpuZA2lVFbM7FWlfr6dujmw2\/k+Nc\/LNKocXLPMFqNsAE5sgnBCiaudtBhzMn\/Jqg11uuejX7PwuvhkH2IDe+C941niVbdJwATT5s+rc5MU0ve8lYbannglu7vLpa8Ay+dbViS5zyPTCYAYOhP4hUVPb4ISDJfMjaZ+7HHvTmBbp9+xGlrIOUshG8qkhA+h2IWHVsMFvPKmfBZSrlpAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZEDk1OhXuh02mODttzWBOOFbwWhn5U5VBlnQZ4pzEFgfDteYqOogaJ1hfiz5hC3ciAefezhAg==","type":"discover"},{"name":"eft_directdebit_CA","paymentMethodData":"Ab02b4c0!BQABAgACkXJYEWEQVGc1cvYHr\/PEToWbECDcX2D2SEXBnZpMLh9pCFet2Grp6Qm8BbRvR4o4eqXB2Fbf8dgp+PlOYeVpF2B1sKriv56YOW4+eJOx93BQuvFjhqcDAdnuA1WEd2c0p0VRzd92CLVEdAMeSJZf4+IenTJ1xqKgJUq8AEKB1N4F6LLKMHJzgnNKsimyLitKgW6DVprbambfKXL7jDNK0WrHo\/9OUBJ31eIXTFPWOV7COwv+22ZpRn+mnkRFmNP4OoO6LfgloHwMY4ZoVWrbFFt7UTDJw4HAwJaEiOMjH+prjEevGqKheo75HxpsmmwRic+P0DJkjh\/7LiNJuKAOQC3EafrRCnErTJ7lglYN2e2g06KsFTgPFI80mBm44\/5MDp2arnowl\/9kxyRuY2EOcVkmZkHtN+PCqdmHPdkKGG43IC8E2bMgBaKJzLr\/TL5oEB80fEw2MAd3IJMzn4Wec9Ihtp4goBH\/5svLh8MWGcqZZQH80VbdKJ40cWNqw7yscqttDHu8+DWERqpYpkV+vORLsZeFTAb3o5S\/9RHIzB02easuTBrVKHyVXdHmSH56J6Zj92Hqjz11ZWR8JVHkYW6DGqvS0nHI6iQfyr1gGOlSGAl8TZqr9tXm57lmSWc1PV37\/y2EW+xY\/PFWFx9rg6z+pZE+LiZpFGe+BKt5GhCOMWe2GSvn0bSAVwiQI4dCAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUDGPWwpG\/h8MJ8mwupRlOeOI6M86\/yxnR0wEHs0UxONfu6RZ805+qkbIM2J0P4I7gmdMlLPcnsCro4LatrBrF0=","type":"eft_directdebit_CA"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"eftpos_australia","paymentMethodData":"Ab02b4c0!BQABAgCvuSe+6o1SUzzcHzxwAVlkmC3SOJcaaj6IK3hGWSkfHMN7VTgEOJRSZefRN7PZMGF9BK2M\/\/wa7QZNERXeqPk\/DokBPZtA7Jir1ANKZB3Ls6EHKUMZvGviRVMt6yvg5RYkbP02\/CG90SYL1gZW66R7bB3o+7RM60\/+HCCIVMcgLmn3jIV\/D9DoL4lZ9Rdm\/FIVBXzxzhmXzx9FWGO+IjwzadF655idJkV9Fs\/nwE+nGyN8sM\/nYBzKMYYW1XxsvR8JYKqk1XbAbDf+euXRVNXiWmdNnTl5MPGXIwt\/D5CmVAZNPhcP179wX63QaC+3AG0eZhyn5Tm9sm3Rt9IMsnkexBYd9hSmSKp1nkq5mgK3R6QQJVs8yexWIndiseKpX6ejl24gp8iVHa4R3io1lBO2GbId\/EDhCzqjVspmT5089REa8DMC6HBVBnFROw26tt52NPDz5Ga752xSS2dV14gXDPpij\/qqXVkz\/rgESVzoBSvt2irWBr8tR8Xnl9XJOb\/M5MQcgfv4PlYeTCc\/iTPuj0e+GYzKOA7bsxmUrewVakmyUtWTAo0umEQn5ttzxl6Ro\/PYX6MlJ9TM9tVmPMIgV8pXg7sETJ5SZ1enW0FWbcuVq+UAkeHllhc0qnuYEXYQxChlsER8Eo3PNcLLGNHIBaMlSrxtHKx0ttsSmPMAuRBHV7wp6ZHBYoexL19bfn8gAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbcE2OmagQwrIkRbuPym64f+o\/YlUEAjA9iyzKP9zwogk+kpCbBuJ966fwwr3DOkqOQG5j9IojoMnyfGrTn\/","type":"eftpos_australia"},{"name":"Nationale Entertainment Card","paymentMethodData":"Ab02b4c0!BQABAgCjeMTCCWbyHkLqIzi6WhOIs0cfGy8ohqynOFAchP5uknx5zoGGlmnn1yNW1wootHnZoQ+DC2FGnBcok++A6EK9tpAPzDj2a15ZmCjxV\/SkQVnywWvRfL49xQsq0vfQSYKu07PVMT2Y0GWilXW5LCJEoV9Nj0AAaO05iTTwuuI\/LiBYwSLcJY0Gy\/nQoVCGmi0HRBS\/lgFzlZb5JH3f77SbbBDkHGuQzK6XR8qxGP5lU07G4pwJ2rlBHddEYTtemdJVS2j7SU\/5auXz0PCkgsgAV7CoHNbclYsL6FF9ZRJbWyDO1QpodnY6ySo3MqSuhSR+v2sJxqIYS6MNwiYbJPJj9Lnf7ZY158z1v9YfM+XLZEB1gt0Pu8TqSTJr1509zavS+5wefj2nm5HFW98Dho3dXJ9p76OT6N44+j5yn5B5bGuhSainoQkIEJwc5JM3Wiu1ZVgNLYT3wMqHyIEVArQh8hZlISVuZphxnUj6w90IVBnUo3cMUCLegjeFoBZEYHi0j9mGqMVgyTL5bi3wPH7nhIYuXk+LZlCcGPPMWbyr5ebLTPM4F2aDNdFZ6WtXkBVOZT37P27nNFXVw3ZY1T6ZhHV4\/NipJqWUTQwJ7bkf9qAym7aoZc7AyoyTKM6yDF42xKK7xU+FgNEolMBJSofshvnlbSsj0Fm\/PRD0NxGulBBiNC+IiUig22Rsx\/VYfF9mAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRG\/RN0dnQzhDj7uZ2fEMdkGldletkPTAybC8wYB6LLM45oVYPELjZX7YUjBzaoZ+cxKhMqGOfm+s+xh4pM=","type":"entertainmentcard"},{"name":"Expert Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgCTszJcLXT+uJxGttigZblCmXk1gAX20z37AeDCztrSgfBe1Aqnik7RXJPua6aFQhmwOdeeffC51Q54RTppmkaFAYn2+j7SDko0dSRbIvbh7n2do3rYWF+TYDtoa0Ebfbg+sbbjgJ8yXtv\/OohsN4uR3eUQWaDYkv7QjX3jDP4h\/V2QhvRYzOf9CY0qWx9rFmMyG97+Ck5vltpQHXAAjFaEZUAjJ9G4grUuWByViFBtfqcauN7a\/uZ2yaf11giCm96Yju27Je8whJiKgkq3jq1HrEx7nx1nqF6vS1z5JqypRsvXZpw2o6Aw7l9N5KSX5GEK+DGtf\/5o2X\/OPzakj7JqRIBd4\/czCVDpX2d1rh1F8USTEBOyTmAmJHMldg4PaVPTJnOQkXZQLEQU0fR058QDmUKQ5X6sO\/ssL6uK4HxP9iNrYl9ZjERiFwEYdJI3NZq8Kf5mcKtlgxYBSZvwlud2WDv5NNT\/OlRRrCJ8DfO8oykgRArtCO1gaFdhguaT9qWj+2l84JhrldUVdJbTgZtPzdC+RaMkxsEKENWIaPFSr7J8xyqj6sI9KO4Z0v8qtp0Xndy\/3LfEFJW7d94iEbg1vfJhDrp+rDDxbN1ufswcvELiv31DuBPyj3zYCDdruuGtfBa06jCR5Zed\/xdDqQEYzFTvw+mKVx30D67l0Pnx6hDHUvryfFE+T8FuaEkViKnXAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVmg8HpFTq3+PEOZ0boCkxR5E4l3XlAHYC7o2QP\/gU+cOf\/RLlNEd3pwMgpFrA+qq+LCSa71oCs6WKAd1w==","type":"expertgiftcard"},{"name":"FijnCadeau","paymentMethodData":"Ab02b4c0!BQABAgCyjxcgXJ20YmmZzakseod5p2QVS\/6zXRowLF1QOY8MLodRhKc\/tKFwqfUNmdsNe4OnZgoUZnUzqadPdnqGy1ermdQfv2Rfb5ZNttW4WvC6aVxFlTlCOFWM9UtWgH0O3sIc56Pwu3oCoi4F95rUq5IjTk8HuDV+CJPWjKVME\/1r6WgKTDK3CgIRlQ5pJ9gW1Jr44oGendVJXXX7bgvZAw4FXukcEytJdeFw9vW4BU\/mwYYRwhLx4ryq7NDTFTEtLQa9JMEtUl+BaLSgynKr+ChnH3CzrZHidRGv+oP2naYHDAMd4HGjq5+mjsHeuzM2mdAq9CQ7qWFBJRemYIpJ0k+9dCA9IAquQCCLn0tbdRO2L7m\/k0K1NxDttxBKWD8ZnM5tayyf393Thu4sVMaRKyqhnlYtyDikzAr20hCXQImmLmD0eZeQBJGqXzUCGm49byy0sXgDnvZ9V8PUXzWPFUDjca4g2FBrmwx3PZQKnyNxwr+YrrQTcwE6wNZDLb82v5Y0Msnw1vXENZHMyZ5MmiPG\/+cBGLmnr4\/X1YtOyz6ZCcS9I5qhJqohrRtxN+WyEwCeljjxydpF3iJA1wPeqT\/UIAq8OojvB0Uqo52opFDwExq7c87BBeQAGFVqd0FW4MV9ck8Rp3sAm4aQY2D5xanUoDtEI+2XnjG0w6Vh9wRMiBC9vi0Yly6XkwKihOxep5PNAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYs7Vz2paAGqPnXyXBtOMrU96V8rY+5icpFu1YXSvneWrazsOO3N+y3WudVeU9mQFVBlSFG1Uf6p","type":"fijncadeau"},{"name":"Fleurop Bloemenbon","paymentMethodData":"Ab02b4c0!BQABAgBXZOsuynZasy3ejqMVaJHj7rBBmxTdB+1QljXleun\/eQHtLB2w+r\/MOqEboTzAdLrYu\/gCLuWS2O7jI3+4ZevHWmx3KA0pNNZ9q1CNM6tLHwQ0nsGwDM1buTG+g5tRULY13M44YZU9o0QWnwlbm\/DmxAYtyAKIufwD\/TuXHVOhs+lj+UWcamJpnLJ3OqwgXuHwBWkwZ9ARn1\/sBAlVKYY\/Po82mKrmaly7Go9pJR2pS2ENvV6jYTSicPP6NI6tYnuddgk3T\/APxohNK+qcrx7La3riSRl92kK59\/7irgcuEqcEZEWX0zzlrjxPzzwlxS2PxRRzltnKyDLs6hz9PPtT9rZgiYyh\/VnPzIFxQklf+iqc7amV5WjiDOhKz2J\/tpYKMCLcbyIsKU\/TmLFORiurCwU5MtLWaIUG+MqulDKPNlGtwt9jYLWokXNHxTuWsff1M3FKJc3ofqtrbSChr07SoEX9aZDa1m8e91O6MA0qOsR2GbUsDUHdZyXOx7\/V0pesmC2UGjGZByJx6dCMeF0Fvf822YZL1otxGRLB4HLgSkXXSKv1XFN9GsX6dFarF6iO2SPhkcVJLUgdVmWvh6iQHD+5rw4E9dUNsxWgscCrO3+CUoZshg13yrCaNFD4nzHNtz+Zf01s0PawpD8ZwSjq1NrCvCbmiFrFiYEtiB3d4RAnrZSlH5YDLXTgqosLfWT3AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbOO2439Q9BfQ3ByJJMSwrJDvT6Sy1M+0bSVhmsqr6Rs+TmOr5pAZ3F11J+22AO0aSk4sLHTWO+GpqIMQP3oGg==","type":"fleuropbloemenbon"},{"name":"Gall & Gall","paymentMethodData":"Ab02b4c0!BQABAgAg7QkV+4kn1vULBkb4lRhi7bw0dRiZidC4vqbaHqkPPi1obPM6TJu\/twpWYhMLYppfvscQ56oUQThyN07N7\/lbwZGgoV6tgFtd7ZBtrgqJPPoVM8sdLBmRLC6nBU3d3U7Xu4SvtlX2JQmxj6t4g0zcgUqNhaLlMjxQ5cnMmbWz0hZ0ustLX1biM5gk7FGDW5\/e73vNgb\/rAkfQRPBWfbGLEC+n0+QBalDuSeVZs3XNdAp58mhchviEmIppKQMP5c+ZsCLyeqGYM9ROAv6QUbtXUKFihruXQDLkqPJABIReTpujZFxqV0N7mMyJbEeh7ikSXKqjQmqqtVZt+wciVz5kcWR1k27K\/3WV1Vy9HNT3Pr5Dda6u0KKm\/G6lf1oj05yaozEJhJkgdrJ8lrSe10oFfCEroNoj7bSx4xBoA8IKZ1F7jqzbRRCgbFak2OBgbOo155Hc3mQAxtgZ9teycjMfKAjo3xblhQuqObQURMp33pbvlCL+3ToUifz5ehydevrHLDYZK\/AA7sv44AiJAy6W+mgfFifXJM3+XasVBNz\/oto\/stjymaFMVVXEqpaYiWOKsOmoyqNk5mHMM5ZFFrfz8lFwojkkjOlQWCI6d8+PeRlGp9dW8wmKOvFJG+RpPmYj3c1SwdGT0pevQo91hZBB46Ypn5KXyvSg\/t4vatLrvRBaXqwwvCMKwYwTA\/HlsYSUAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifW\/eRKmjw8uoaWKOBol+hsc8L\/WyVZIIi3NlOa2q0DCbXCje31jkFLJqHJ3ls3mBT\/A6ew==","type":"gallgall"},{"name":"Generic GiftCard","paymentMethodData":"Ab02b4c0!BQABAgBHMmxoZXymjsUwaJug\/qfoTG4VC5Fm1vVTvBgFQDsUodpLkylC+O1zyY3Zu\/MhuDQMpm2mSImemAUeBq16uSlEBnJx+oQEdM7sy0DTfXGTaGqpO0MEzP9bBLdHVKvy9IeMXRJKkjTuOStL9BN1z4EOuSJqD9zEENPMBJ254lEMFXCu\/sUQBhYH4Z0qJZRwjtd6AdB1Uc8\/qwGbmntKUHx+Bxjk\/AKKHrmdFlVJ\/2fjavkqJRIc5AuCjwpnDZ\/zUqx4pDHmG\/Y3UItCCFmSZKFFTsPN9\/IFMkYhfKxipzv96eHMJXV7OAdEVhplHHW57gqENbAOcKvgTBzvtxokLtZTIQZNM45yHDBlkXN96T0fU4ZhdI8VmFkTk0kKWtked4o5BxhRhf9YsrG5sby\/XNMCGbXubTlrhdmsg74qSt82GHXyyMK7+1qFI\/WQzMDHcW\/grSllUvBR89MujwbHUrjVgS4Q\/qQNSFet07d53UY3maMspxdpjenYVP\/6OyMcE0SQnR1ZXNHm9OA+TA7NR0IIEFEG4XtdzhuDc8acW2GlEvSxsTWL44IaBY6PRilpdF8U5CJHkPEWC4criLpxeOpkX2ulgdc1WsFSwEJkzZRGdq4WYWkrWaLfVwj9Ihc3ftK2sb9928VKmDMg97gc52T3fh2NSv2uVRZGT4Ay\/wEpnBC8Ev\/q\/COqfzFp9HHO2Wq5AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifeuy3dD8N58\/UWJfGCXfFvHmQFj8EV+Ams+QEs4c+dTUH1uLGiS6azxtNi0sZ1numoBF1FsBaTM4VDvsWxI=","type":"genericgiftcard"},{"name":"GiftFor2","paymentMethodData":"Ab02b4c0!BQABAgAVPfvRFY9o0RRAtb+F8c2kYHb+aOlojLUI\/ta\/6uB5W+Y6yFF9vCHY69AhGB32kH6EHHO8bv985AJyaRwgDs4QyzofNDevaz7zDb4ET3Ak+Q3sU2ObO7wTO8TAP+YCTOKgJ3jZaEKt+ExzCC8646uTWRuWQ\/TB7j2p5x4MEt1Gb3k2ehc8608r8oLywYiIQIx1XyuvfRVDHttWcNj+Lza1tRr2QTThFdLRa\/wNfuJPw1\/AYFk7HUzhh4AA89dQzSRYHs+3cglU0VdMvm3NEgvXYpYyNJGhbCfujfUgzX1ZfjHhy1mQP5sySPm5hXxjvF\/6deSM+HaSSZGw1+f5N36sVcrMNYPKMYlh5c6zy2KzdIIhxm+mEIiC5qlCm5Fo+XALpUnVZfuViLPWIvQCIFD\/mQ5b6LLyUQK3IgTvQyHmF2yaLihlgfOHt8gizJDmHOSPMNNPb3mnnmgBeIKvEN3YHl3gY\/P+L0xM6xh0DRo7gQ5PLXPGyF1D00Easx1hm6x3kEF+whefRoM0TI329Lyf9C\/DN7gRBu7tZyl3NNYjPWzU0mJfTdJOsW4tT4lrtvG9drC+6rk3HcPtvlsk5jl5fF1lwPtZ0rxJD3kLaUa3XRh171OaM\/ZiOlwLRoRCjNGUdkDSZg2yhJJiFwbFpGfIAXJpJ1kjxDw\/ScBEVXe6SRDRrvOxx8kRmGFnoWKWjf\/CAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSGXhyjG5k5Fo0wiLcQFquadA\/zmxoSfuiiT\/\/TplQlLn+nMDZbzPA6ly3gwTH1bVLkbgAiQx4QOJ7Y=","type":"giftfor2card"},{"name":"Givex","paymentMethodData":"Ab02b4c0!BQABAgBNifdrYoF8tGus92zPakFFXih5UpuT+eNNHDUxAOZi\/0HgqoH7Rqb1Y7IVQWzFCl54\/gDUokbRjp7KLQftd4eh0w0rKRZt9WF1DL27bGUWZLVtI0NNU9CWllxjV4VBPJmm34Za6BJmMhfQ+zLU+7HN7mVnjIa5ALjWDsJBJL5h8X7oKMA9TzTh1gG1iomGJ3nGGMdZWmNs5S042Fr7Q9mgspFmTV98ZdJAx9nFAQl+yzz9JTqziTobW8TkTOkZFVTBpGJL7JxZjJ7jVBWHoWgmJjWsDSdElxfTexaaFv6AmGO0O7jIEG1\/16vxkEIM+EAWfiK11GRUi7H5R6MA1\/ERdRVv27A2PsG4UliBU4arKzQshHVEjPuE1gqjYlz4lQzBCMlc5Hwxoxlql98l1iXbsx7MHMF0qIL4BeTM5HNGuCXsPF0jSIOU0Izcwsn9qQf\/fBHIYktlXEg8mRUpX4iCFXVJsKtiG2aMniwv+0724iQzTPIrBYctGIBGhIM5nxl3AuCId5ViZoaKj7+Pfw08jZDd9vyFCyiFKRCMF\/eUvjv5dsa7IfVVZGn0GSgggMNpWAnYRwKU\/xfgJ5ZHeNfTFK2jOFCdEnjFK2jmL6bvgFdh5PVR5tDrJOYLRS+4MBKfzxSoUO3BcaWvr6ehHNQuJw0hGW9S9HNObgVAjTVWVRBedGwXUWo6lHDTgcH\/8UbNAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVqIw13EMSch6N9oRAeH6yyfpolZ274j09YkRrdFoi3640E3krm8TOXR6q5PekQ6voGdKQ==","type":"givex"},{"name":"Goldsmiths Card","paymentMethodData":"Ab02b4c0!BQABAgAZbPAxtXPgyy+KpWaluDGh77hrNCi3vdeV4nqg\/XkG2dXutXteYcj5uKLfD\/\/dGP+ZUSolKJ+PrLdpzvAbkO\/JRQIPTBQY6Jswhu6C6vkI+mu6dsD5EABoVO9TiGBrnu\/oJGPUiJF\/uX3hUJU4+o6MiZBoNif12tOa2ZSeTYkxmprOvAwd+JMUJSssSg\/fRJeXJT4iMlobq3w20Myk3feJO0ynR42XAeiyTB6iSPOqqOVTD2XFOh4wMMJWNtJ1Mof2AkqzFtFrPvOYLJLdr7bIKsOKXFhPx4Twb2yDb6eBL2BeRdP9PsYujI3\/B1bUzmDgZhyVflxamQztiWGEYskPBjfbZSK3m1Z0tsHg14trN8JqAR08hw2cblX4eSo9eSPyc2W2lgINHDhY0QOmxHWDoHq\/qjhtbpmEI1owHQBwKMQEm8dj\/lg7v+38TNuLo2cONFP55H8vdG6M1gmruwc5KSfZWxC1wwfO2loy5cPwYDYkvkg9m53oBeIbzotPANzgxJmbciviBtQ+IdAe6W6+DUTd\/erwMT9QVeOP9+cJlngOLvj7Dcnjk7l9x2GQVUwDDUWacql1VK4hEp\/h5h6mpK+N1mDXNl4z4sbWeM7R8OTRvo8WeEcxKgkz3Re79uNmS73Y1\/f5nw6B1o6\/B0sEtMFEXw6jd1F6JNKsR8IhUxDY6liK9\/f931i7fHZqKSQTAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbQFTtA0xTDJ2j7HAvF0qrE3gj1c0plKkK6A\/cQ6jkgBoMXgL\/LjHifQrcbVjFFqXz7tzyLgSuYyY\/xk1w==","type":"goldsmithscard"},{"name":"Hunkemoller Member Card","paymentMethodData":"Ab02b4c0!BQABAgBSDDWiLp4lYErsDSD+XimeV8jVzJB6z25AY37kR\/rtkZg8MHvPfEf9+ryljyYHTPrg5bTUEj6j3Yxc5jd3db8to24UiCdrwBz\/JWRUaCPUIJvFrWOPejthgNdCfttgaqfOdVknMYyU35lKi0a+pHuBvkcpZYxGn7Enm9Y\/n+GHMqjLdsnjM7bkpzTF8NEw0JKxUHwLNKCJrvVpe1wP5s8\/JDpt6E42ne3WgHSKcLgmxsbAExj+CC56Q0NJUgdFULHvbF6a9CGmFvHSvik+DOm\/KhMsWAdWES9qkzEw5Z83R\/pFHEMzX2tW5FoZkNIS32jIc7HSaKwHMF67PmdtzgjjemwtLLNctpTBL9MiSfti4B+XcOEBzA5LKxTyzHBcFZLXCioeakxRvra5b3i6PrkexvHrNOtyRwd+71F0Wp\/E+gzpb1KRJ5pRxC5uHkIiBOkurdcKjPKtXoLgpL48NZYWb74FvMj3W50e0C\/cJAdYRZp7yNf0mCvOhLva2ORkJvmaCr6Jfoik4J\/YA4QrM5WPCil72Ubxw1NBcIdoDAkCDJb1IrjvDryvxK2gk7ebVVd9xwnU2y+u56aYZcJgLKJ4XEalGZ+Cpnbw86q7jI3YQr5KaVfFB9yyhU3ZwshPNI3XQhirD\/ESkn+j87lnZWp7hCmsnc2r33ey2PkQ96jo5xBU+luThZvIVTbVJdH897rVAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXoEjevtwzQTa9rY3bi+w7qKrNij6SQfOT43DEUWmCoS1f+F9aLLZMbCWTN7mLXOkQTMdVI=","type":"hmclub"},{"name":"Phone Payment","paymentMethodData":"Ab02b4c0!BQABAgBiy6A6o1vNm5FJZBNdGlULclQpPMw0UVyk5sTZA8wlFQvdHt+YvXKWzkNf7sv9lgoUqGXIvNxk0K3y\/7lI+EGPuQHu\/RVlz1D26kmLxRp+NnjJy\/m4vxMSy\/38NgBJJcrMoXtUghrcKFf3mQ4MQNyZEJ\/IXBh3y\/E7aEDkfgmsSy7UTfNzhjlLzfBVDtLhXW\/QlJzFrV0iViSrVblHKZEowqICP0QwRJS\/XU2gX1xY038LkXj6s4NpBWJka7mQ5WNsinpRWAGeR+Gl8FCReixI09jziI7eJ7tDln4P4JfJGlLC4C\/pG6xagpVO1hyMcu9+wT99sz0k3QmEzWouAkiQnjMNRubfnyXJC\/wa9AMHrLfH6YkScbmutKASRScHrgd8jCBCEIDQ5jAMbB6ZhaTWGqWdwlIuIbmW0HBt7l\/pEQdVAW3x7PBUQwtZMGXMvdFKR4YAE+Lhsc40G7FUSlzLxLs2bpfMc99JUu14qHncEAdeS8XViEvYyR45ZiUWR9z9Fxwctiqt8KIp5faZNP2QaX97W7ySL\/iJuIZcg1IxjKzRc9ydtoK\/NZyBWJu18ti3ObXPPOsQMGzsndigh2PbCEtvy26PXPsXHlY1O1DHT7w2rBfg3Akf9tG57370a56vO4Lus5LkZvZPmOPINxlpNNxtX6O18XwhYjcPvA9IWRA+BXqR3KbrDCFBfURckh9cAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVwWSTKtbn80e21yXRcWWxceN6SKo4qJNUpQTf4WGz3Caaxo5WU2yKF5C7Y7yImP3pw=","type":"ivr"},{"name":"Landline phone","paymentMethodData":"Ab02b4c0!BQABAgAVIhc82ur8irH+\/b2ZtfjOmtNeh68KXn3JN3HpG68Ag+HcU5+J9Kn1\/Vv4YR1K1RgSBCBSiB+o7JHhD26pdHIvhywtz6tqltLZAoEmETfSvoWgcPIzXY1JtohNQ0tFbWIDq6jyMh+xCqheiSlQL6CEdpGgcSFRb4D\/J0mjMZ2nEgcuYkyt0UpEMyiJXYcRac\/9GHql8xfEPAVBKD\/XjGUtz6Ya1tnd71\/6mnBbY9Dlw9nK+Q7Lrj8gz6VrQi\/5sDV5bqNENK9A7jovi6uameBvBzlVfwyt33q+qxnNr6wcE1J9VLWhdB\/YKfexye3C0z\/w0wP1J9a8SFdHjd5T2m4rLkqav+Kxrd9UsCEatXZtfOrq6HULAw\/fVkzJ9U9cvlU5pronnEb5hrWhGePaXU84Ytl3OZguqcSff8Ua\/wI+9bhKRO9eW\/Aeqf1JWSjs52jO04Paw63GTTM\/mXQcENbJfqqk3xEATTUNMVDlSgZEPrytAU4ao+LZJ77tZEnHdjlcRfIcWjaHEtr40b3BhEAc8vCSMbOeBzES81VSH4Fq1W+LR3J7k\/xkcsfeHluXGVKypmyoOLNCzagejubPCQVKVp3jZjiPUh29U\/+q2\/aOy0hoivRNgo6sojwU1xke9JyJE5oxDH+WTbmCsbK+OrJJqcCdCuWbsiY73v45Cx98cBB3wEK5i1rH3AxPiliiqy\/YAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiffRSu64ZrMMuTmwk6B7cgd93x7q+0WNHKAGNvJnpC6YdyCShju+eNCwNm069YiPS5OvtvM1OxwA=","type":"ivrLandline"},{"name":"Mobile phone","paymentMethodData":"Ab02b4c0!BQABAgCuF64yixDh9VfjK1wPr86Fke6QAVX+FXvop9\/9rekLpDOVhkNEsNGFu9XlPfbVHEOl24l+0IJPlCbm8KauZMjjDZoprnoYk9AfpMQxeXIww4sIOqtFrX69SSBqrOorw\/22c9eB+Ak4jY0QV65EBPEElG3midzeekcMJVlQWk3i9moaZEPoW5APbbXVmR7+JDPPCtxJ1erbdg3ES0kvkJMlcYuSg+ZQee19\/xS+m3o9yCXmDa2V5nUpTIxD\/5Lf8\/Zf9Jn65VgupVm3cEj24ycqWj+mc7cxWFzdp67DJNLAcAMn5NJIxVExPb5MQ0dz6eToHTMUU27eQ7NyIn2jYmrUKZe5oosEuHAyJDAFARWO98j8CCi5BN3Yy26u7AG+cP4JEjRZkP7lNaTM24GpqI6T11A5ec11hfeSx6\/0c5hdhZQNQoZ1OD9g\/+vLRGb8mMi0Ih8K8Ulm072exvb\/1BRrkWWJCPA02IBFW2yzWqa8YCcuFMnDjD2eOHQoG5YZKITbsz\/uN\/9aj7e1ReF\/WKvz8uJHfg5Jd3G2iS4TBNgOgfeOk0rNXb0pO6iLoyaiKsGg+LNz0v+gWu1Z0B6kinjUEWGG6P0649HRCb5a9P9HgteQSMLA1r2I5guRi69O1Pb2EEEzYsGKfF7NzidyapkuIG6zLXAfoQkLazz+9dCtSxAMGYyaEApK6bnOMh4I0fpbAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTRJwnLsgKJqeB97bJOSJbQ9wWOvM5qTns+NZZs2uaRMsnAecuwmWyLuKPbA8IlCHFhqKj9z3+o=","type":"ivrMobile"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"JCB","paymentMethodData":"Ab02b4c0!BQABAgAEMTePvF4CZtCd9jbirjR0AqpOPWFCV25nc9lQzBq6NgJ\/BL8rbsbeYPEEWf7OWrSMdmiFjeJKZN9k6sxPWcb8D6AHgmVDklrKEd6R5qntMY+L4hNs0TP+Qcx1CzZY0zUFgrP4Gp5seRBKKpoxGUkAsBMgIeZRMQMaz4EUzttrZB\/2p1\/AjVVyULyw+mYl2AiRFCzFJ2HwUFAds3W37UNlOHq8QBcy4mGQLoTm6sjlIHpeudZtlkoRLnUhY98plBecpZYZbHiT9JClM0LOXwyoWPr+\/j58RROGfzcsITOPDbevuouswq90IJcxnsEdnbq7KQCminWgaSB5rZv4fGRWSa6zF5X+bBiQixLQD1zqq\/4apvoEoRcicEA5v6WVH3bpXQBhuD73HFVZ0b2grpq8Rq0eGV9EU4QWDB3mnkVaR1BzqE6BC0fR\/9SxAGeluSJn7HVXjuVZ2b\/XamQ0x\/4YHNPW1XtE5PIVOdtXH\/LKvDS1ceg5PtdEZ\/83Xqjx3Y47XZktdKTrzE+myWJnTD1Gzv1\/YN1k\/qOEiGkyqBAy3ympPI5U+Bu0S5xeilum0kjAWQR5bsGF9WsObAVJ4xPhkYt1V7p21td3gVTxww5QFDFkMSK\/6MY+qmk01gRSRIBflK0bntv01YTeG3iDL+MOALbnrY2StMQ3\/qPjJjKXIBBh9Ksfw+AtNheXk6K0CsdtAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifR6qJrtR6YnxrhZIBJsXHJDfTdPVNTDjG\/KdBq93\/LU+m2blUK3nlsH62gxSIeD+228=","type":"jcb"},{"name":"Kado Wereld","paymentMethodData":"Ab02b4c0!BQABAgCVaykYdBYOd9SXZhmtt153kzRwEhOK3aCqzeW7sdic8Byp5+th0EDWafwfIIG7LQLf33UFIsV5InlmAdVAvMkXRt2BAThNLqSwCR1+CZZMOz5okS2dFDKG9rdh1+KDB6frYgRViisaJ6W+bv77l54NnF+A8B1lPjKydCEnv2eN8\/3mi321AjMDqim8IHrdTYl2pE\/\/R6OEt1b1jALkhn+73jt6gXboMPwuQTpkNMRxNRP\/YapLkKX04A3Fzqnbep3BQhXBMf2YEXOjQw4ryVmDIojOpPjhk9eu8Umxs4sW96dbo0eRNXbNd1+ScDM4FZQPm8nQ\/BJ+dabn0uZwqsz64cJRx1+O4c3qwTsa8ztSckaCL4b7qKYK3rtYfzPfyOV\/wx4fyNHtbRW609eYOXV7ni66Rla+hSOpHFBQzhLu0SbK\/7pdBMA42cCvifn0CL\/gUjkqhi\/1XWSnU\/CiXV1P2BaOTLAW2rutEWMovg0bo58u4\/2MMPXKpcgGEYc1ooXWycZVxTvTBPKcM8BLJItjX3xABbEEdbCqJefPMSpPrvT7kFbvoxuIQhrMEYbhaCQ7i9\/LCXmqFZF1qKrUxBUMdB3sSAGvPyGnLNc6zCl9lpfirhZ73XdRyxsTzFL0R8txBXqxI4IiPFWMRt0+xV2gAFqBECY9FeoG9nMFFgSlAhBIGGTVTtPIaltT7xYDVKzSAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQif1\/rAtDWA05NbEtqsQDOvnXV15H4jQAlNomWkD4I0cdKWDRiXzV2yYt67F\/2zz9IhbLZJ6yz1","type":"kadowereld"},{"name":"Karen Millen GiftCard","paymentMethodData":"Ab02b4c0!BQABAgApYI2hbHeDfES0QE9l7pnLSIA\/MIKgTloS1thlyAFgxG\/AV+rYnCQoHSn\/w3vWtjgM0rydLWjQdIqWsYKKeRBCXjqLWDPrYB7gaGT+\/RiO5w8mI9t3Ol0LnI+TwL3NqXRhFDarMkr1wBkqrynHfvcpbEbkLVdKSYWe88ZoroIiEAg3+q2tpn+fLwXuCvtUXqqqzYk+Bo\/SYJ0mbxISRzFIsE3ZAaUnLWtWaJf7rziyJa6jzcsVDgqpItpMfenIarVFcLQv7Sif1E4Q2o1WoPRmhvlNO7Z2DluzSaD+1Rycg9b3Xi\/pjkKO4YooCrDKDVthYXbe2j6RVsZCyZFJe9v5Egp3MUpnT\/XwiB+cbaSyPoC0YacoT\/cnhJ2aHTtV6HVKUZPD8Eh4jBdi8qAPgbBzr3E5LEtHuSYO8rWbZQMYS9EnJB0gm\/DtoPM4nHUA1pb0ffSBZmSQgCeNrr89ZfLvJZP7itZI+tjfaFoAY0LfzzCSge3M0LrZMADvqG8Bg+h2p6bnMx5a\/ssLUL7vnlyfGpl2OlhWDbJTkpqA5yt35usFniOMxkWnhkchq0BENL3wXl\/dAioDkSTdVPxgfZaOy9FSVJZNR2gCFmYhth6Yk55FBScUdIis2tykndN1ahSvH3tF1j\/H6cLFdq2B2DLoHoq3i3LeWBtvl61I98EK+RAJMIEwtPVsWjrNHuCdWhmBAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMife0jMycTD84D5BBKAd0mGMSGHRKH+iwhg\/G8g21qaX1vqxzE1WJnq8OKTrrgrGEf\/fBxFsiqIQqp58gGC3vKtJfq","type":"karenmillengiftcard"},{"name":"Leisure Card","paymentMethodData":"Ab02b4c0!BQABAgBYdHBN0+5U1mCMTmWRzq5wTWWrDhl8i6q6yiiyPcG1froAbrlmhntvHiAeeGPwwnIdjfOrthR3HcO87Zs05HNaTwm9mhxk+3t\/MVat+r142qs4o5OKdIR4uYRIBRrjDG+UhUW1dAnNvrCCZ+kZFuh\/v7Tzfxy53ReTO4CAOFmsnUAqnynazVvyX9lMIYoTsd0KXjB5nLGI1DV4\/y9M2M4iyHmCIB59BvF5x6bnz2ILtfwRZtQe9HoV4WCO3I9titDktmdOHnCsQkKl11JZSQAIWEibGmWhuQmiuTHI+VuTW9qKay\/Ya5j5Sfkh\/eCOA90WmOaqynJWCdOCiYsd9IiURwsQ6SqH7kUoBJ7tl1UM8LpJyZcLDTX5HO\/nSwA5KBRw93cHeryBtmHavfH5VXP60FFMCQr95WCKNFfJv9FCVydbgaQ3UiMg6D1yBJtJqwOub6aWyvb133KgIpJnhO522X\/KxkHzVkARyeauOvRarsUlidn0h6IYAmwX6JVeJD3FlnDYBOGoY+Ik2DzvBq35ylfjKrNMEntkFoYOQZjaB+4BIUp86pJSq\/bxukfA7+ML7VYrXs0G16iWBn308k0Jle+qyUhqXC3qevJMp87eG3mrgaBr\/Li3IfaBt3o7ItNdG9d1l914lajAmVjxeLqW8Cv\/tIsCnal6zwBksIE7HhCuIM2CuiMCRzlhHA3BBpZrAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifW+wiTHgcFa3INU7aod3xbsafozYBWij96xh6jiG2bD2YdA984ypmZ41uA0Fir6Wl1R6nGGZlyVdrw==","type":"leisurecard"},{"name":"Loods5 Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgAPp\/\/FjuP+ULAnqOLFwnVQX3pGuTlYiMmSXXg6EejxddbhxBf3\/CPBEzIRktYwuVzYbMeNrxbAMRDArExdZJMcFWbBHOp9pLGcT4mRWm2pmf+aRdKNygeS3mI85xlT\/l58PpHhW4oXOzp0kh8UE3dPbbQzbMucaC9FJa898di9kK7CHBOinGqGscnbJuzBrD+O3Xf2MshZ9JtJhFFNbIyLgbwcv\/YExyMkAvXddLsVS76TlrPjqQsCOCEyCU9+wwjP5GRaIHqMbwx+5vD1Zy8Yh3GB+fqmE2JBbrO4vStDSUcRJmonZ6eGmS4DP76lQ46AVr1PY4KwZO\/ME4Ku0XH4vK49EJKQISqklllxa+2YkGAh5DsLvD0tAswfQ5LvvvmXIEacKjfYsKNKa7w+Z41Bn7PZTwLYp+FBnynlGO6AmRYgmJSEag4rCueZD0qJNrgcJqMp33l0eKNb72wDQLZ5EsXZ7YihTq9gL\/tsVo8sgOrZV1AKWhnIYzpIwSNeJJ3clkqOu24Tilj\/v1kqiDI5+yn3oaAZO3crm+GTMWY7jxKmH3lY130\/jdCMHbPTugonAlJalpI6s0vfA6LbFcYX2BgO867Cmox9SSBN9EBG7a7FNB07Pf2keQcdeaWg1DwldGPSMCtMC2oDaMd2s3exyrnEOg3rdbh6Q39rfhOJOxB0Rv25Orn7jDkaBqvqMf3RAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTmdrSny1kEEHmJD4iRcu\/0ZPmgSqVodRq5eFhZLL38XWtH7T03GQC1BdgABBaUgDAjZ+adh2El+70f6cA==","type":"loods5giftcard"},{"name":"Loods5 Tegoedbon","paymentMethodData":"Ab02b4c0!BQABAgCXTxvpM5NovdKZ1\/8MSJMXmIDzrG1S35D2xRgJhlfH+rHlcAPdEoeS5E7CcUDK\/pA+NsqVXSKV7YpPlzDI2Hot1wK8+vhHh9g3hCD\/cCtThplaywBeAKWQ1YYeXqCiSbLeNAtTDWs1RvPAwsWpDbSFQ1VnXS+kR9vE\/T1gG8pthSrpV72aUg\/Mm2mJGNe3BJxzou+2eU0PEiKW45EmQNs+1QbZLKwvE0ByvATBb6+JvaXJqdZYvk0j6i10EoavvcgMQEdTiyI2eFwX7o+F0B0GFRo46ACCQ\/BDwekg3+tPfDsc6WLwNn3BrXCR6bHAWUcPQ0EmlCRDdg2zbT0fyHAGV+2q8r6Fzto\/\/NEi3xRJqC4uYvKg4j0COUfZSJseBuvwKaSoEZmVyni25Y4l9QSOeGC90hJZ+FLbbo2M5VqftJII8VUBc0o5bRKXCAFBjn6iDHa\/FzS8PLkehLkAkWlU1QRUV6qDfOfzMhAT6B\/fGoXVq3EC+wdwsEhZP9\/j9DmFTuLBZ+z8L2yyZcDmhKD5137ifvtH7StDaSfpOdZWBGSOTpuA+E8j8AqfuVjyuoaNCEopRAV1Les4mIKv0juyIhxsI+cgUU4sDfKqvDkzD\/smGGhloC80enbncgLV2zCgm2ysuLTORBlVhhZBKnR8aEA\/faDii0UIJE9b5bOJnRC4VefeFNVrTkgBpYzhmpNyAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSuDGOUZ1xiT9pv3ZxvzDjXdbJ0JQnc5EWVrs9HK6TTPDiBmRDhwvzvrVYOzTJjaebHY\/rg6+nzHLXMgRRnq3A==","type":"loods5prepaidcard"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"masterpass","paymentMethodData":"Ab02b4c0!BQABAgBvbRPkCdday6ekCo+Z3GBDCWwcGOq5ZiTrLZoXTWGZBUHw5QuXfypU2GIcEEqLfSJ2B3jtCDUT46b\/LqyOskbXrcfe\/SlzkMpgtjYyI5p5o\/fXAV2EYSagdIVYN\/tjWvTLvabQqxTmHObqbeSh\/oIkoe7XDN5gcTZeqpOuPe348uJNEhns3+CuTgfuh5n03tkopdKlPKSeFvaN71WhOLmWnrf6cT9UTQz2KsI1oR+JVzSOcW5YACk31D5BIkaUwJaiB1wzinjIbJA5hpg8jofvqP3pY1V202mpWSki5vGWXhgq8DkqYzg4FV0E1i1jf8PMBH\/jkEOAkwSV2CCfhQLGppXGjSX+aGQfhnzxuP2JlmCRVMarGt7xHOyUUglKS25S1xkKYuhmnwSJkfd2UuGIqbkESIVDV+8SXiz400lAtg\/MdWMmvxszUZwPsRkP0eeCbvLUge47dYKVXb1ebWixC1BzXeZkGxOOej\/b+f45JQYmHVOvoLkzEDUv+HHbT5Olez4AWCYUk5OuXM7ao\/jmOa3DGmzVm6av9LahfeiiPO9fYcX8kwoFHZbKcKRVhsTwyZ5\/Zy25VoCLnmYcDt4hkRQe9+nDd5BePv53YyIgkkyDGeblw5NKRtTjisLo6PxbX68rGnoTEA8a4La7s2Q01QghihIiUQY6QzkLnn8fVxD7U9La\/f+dChIwRItGZbpSAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXzgfp9PSVL\/Gx8GNCR2wS2qzDA67ZCQ3hokL7QtZwiELsB5krnOCZ4XyCrVUK5QwO14XEq\/o4bM","type":"masterpass"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Amazon Pay (Mastercard)","paymentMethodData":"Ab02b4c0!BQABAgCkDBQ3tGm61ichxvJBt0uLArsrW0pZ6\/ZUCT4v3yeMx1GUHVywYKo5\/SBT9fA14QIYOyBSEvDzHG+EVDKbsq8ZGGO82ArjEbcpjYbvn8f3t10es+3Bn+TzlxvJiybucfxm2Ix2d5yi\/MTYYcdGKSFZlSxGFTF9VNDzMTkP80rzRYApBdtrFuRTAPW4h7z+tWx996HBYUbiv0g015MHCHS0SoYh2jPOHhCm17R2xBnf8s1jcpIDnjZAiMj3VoZemVSzcYMtumbuU+R5v1oUaH3deAEj14pu91iCgpOmyTQrYiJgg8p9u7uUCDXRYAYgoLVkBIut4PeFma7I9Z7gWXqrSt6ffHTdvO2kMmO0Ogc7IlrBrF62koBdnfuJ20jDEjodF\/LaKwQ\/yyh3qxo06USQVNvYXl+J+E\/iUbNgw5FR2A94I\/2MAfxiMDS0ztdBbAf1QzaS44oJJ3uIS6zlCGGcenxfRdXMjOXEKloO+F2C8XMvctctJVDgY399VCogiZTLNkz9STRrjg4r5cwZIw4KvXMce7A8KWSK55BldyGq0x4de0n\/lj4ko8o7ToXj+\/PryBvtUjcz67+i52fLxvr4i8iqls9wSBkRLVfKD+VfKjJxnVznDdsfr5aDBa4hGwANGbIuqI4gv74KXCdIWbbJqTfdD9VA9q49dg+Iy9D\/VhDFlUAxdRLmb63kqQ26dgAFAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQr8SVcjGZnuArjQaqBsW1KR6igs7NQaTIKzWHB8oBhPefQXAmoe7TzdgzdRb4+yoAYJPcPYlnLcT08=","type":"mc_amazonpay"},{"name":"MOLPoints","paymentMethodData":"Ab02b4c0!BQABAgBIfzDmB8qDGajvq2\/hGWIzlhAAftTCqpB3RZLeP\/TGvZeKFPe+CMIFnX1zNtOhy4NP4CEDmM8jHy8xXedS1QelN1pGXP1nTko5vMr7qi9EFkQcvSvZpwO5\/Cz0njVYjFgZAAvJwK4Ytdg4osnk+3X0qrn64ZbsA8ibRGyqEEBAClvIY4AMG2cGXyqru3ltxwVqIc934NpZ1NeZdgE8zFEuNRLdMtGmAfigLDkRpRf3sOlPtpY9u0ge93ibzP2jRjUGy5YLUd1CFJNx7fhtff62r8mNp1Lb9SBCu12cnUNVkMsNH3mbAtK+q2Ck7Jvd9QKiIRHbJYRnPv\/LN\/nYAs+Z0sHBC1c78hT7qDayuGZ+haasm5eem3V80JuMpw08V2IWdGunn7pkGKJ4ldXUw0tUCKD7DSUuLa8Nx68eiQxyzWWRq3PUYGUns60C1ZXkOKwOQOhCfx9jsxjNKqRN7q+9zxHyB\/aCM\/fZkIBsiNpBqk9aTCMQ3TkSCxI3TsFoefDOKZXDqFWxCPq6HVVGt259XwVMIFZzT6AKCdC7OcWeoPw02aACQsj9dnkKqh6HDGhAAre9pr\/mPC\/p7IcpB3BDnDQRtCssFkXUFhMNVxmxxyb+JH8FShy5YnaCU7P+f\/J6Qn2Z8CNJyr2RZ77s9N+nthMhKxMC2D\/3CjwVI66TixAYIAkZUUhlX6XEN8KJq4ayAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbFQr5zEUMohN+rPBl0SdluHCYZWtcZCKV7\/8yzvzDoQYYo28JyLUvJ85vPAXh6Ii46M62I5TA2G8Kje","type":"molpay_points"},{"name":"Moneybookers","paymentMethodData":"Ab02b4c0!BQABAgCTBiPTMkm+\/q0GuKneUn7WEoPf1DtL4xj6+SXQxAufri9s8gesf7z0fDcZSqiApb0UaHPJvZKWIEMonp\/d5F5h4jHOzCNqMK0kiTZ1l7vw0s\/aCawT0y0P7Ymh5Pgg2l\/wbiAdtV9neFh4nT2M3Xb2c+Do\/yzIOU0LEVauTvCyCrIZfHvcfi+hZtwwZPxYWAlzJKyVpmD5RYlf3D9OHuk4nNjfGXY2uyaf7w\/0EIJIhukqPnEey2sizgxbz7qWgbMPAwbWmLynwczbqfGiI3FZpS2zyajTOXk46DcGJSifc9H2arcxg+O11JhObCp2v2Stwh8DDX\/uoZOhdLf42sjZyioygBgfKpOnELyaxuevhaeNM9c\/jEnYDdSL9P96DifoCGLGpn5fAGADskxHszLyoFMOP\/kRbbIeSnHjDpwE4Y6rFLXOpKOFJdjx9A1p8SyHSjxhV\/G1ylk6Pnan44fRjORpEH+sF2XfDINRCwZ7EU3lH85n+P5g6c66vRbZMuGssb9KtY5yX3Jc\/IAQmY\/kS7WLmbemqvCCy1vMTwyk7J2Nhg+DFhLvzEgBwrDnCQxV9EzreJXOEtBnQ1T9w9nQmrp+NjiPVcHnfIPSRE0enAGy97fff+nxxqvH+yzm61XuTVG\/BRBjKwqbS4m3nORDr5klpPK3NhuUtTqpuCpHcxABoFJFarRJiVuHipKn6DdgAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaQpyBEyvmrF90NAwtfp5vweigE4s433Fuo+TBuMzX7RoiC5Iby4MKfDBrdEF1TRbztiy1ZO5Ec64oM=","type":"moneybookers"},{"name":"De Nationale Musicalcard","paymentMethodData":"Ab02b4c0!BQABAgBMClK9eoxk3I3\/2Uc2XS3cNA3UU9qdSYKQWnqw9cODwxat\/NB2rqgl8VffbUy3m0ptFDomc7bU8jMHoKRmvGuQ\/eWI90bRT98Djqtv+uSIdgywfdxmO7vLq1imx7eeGYJqGCgAbJSHjxmy1yZtE8tBK0dbtNByCbh1cj0NFHhTma9S+2OQZ\/MXDZizQ\/nNywOCKbdwPgsNnWiUr8wB+qFfjUokSN9xQB7eUUCR4b2XUcXhLF4\/r2SKgZuf+lgnuXN8LoQH29d4S4TrM0Ta9UKRPoXdrE\/Jvn8an6HZfdhg7U1bWMsrVUV4aGGyyAprpncPN95g5jTZXconVKiQYqzwcwJhcMrL4XyEmvkkxH5pM8CxRnHGXrBWbXomKODH1H7fGWMhFi0D\/LYIDPcM2Wfa3eZuJvZbH7i\/tuLPI9BzjdfMFzQE6sZbjUmW3l\/wu822w0TT+BgcPTf293vPV7WX4ijf8JcZ0ocMtP66I9yvvJImjy2Y8MdjCcXiCK4HN04CZe+VEKWgfKCAiv9pz7Xj4LfP8ohxZg6W8V17GgHaG+Hc6pV+2GppVjf9GuEqpVGRpxCE6wPHwUJHTdPK9BT4Z2ddmQvmjHBUjfObam+6X42XbC\/KGdSr\/qSkPOuwbp5Rcv6VOZi0+DQ4VJFzPfsMyePQPbU7EEcXQfVBLC4kChAj01Xd33Y+Ap+GLlHTmQBIAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTZcAEoJQj9aNMkMYRkEpNwSVuZa27xiaZPz\/680X5J2Oj\/Y0egTvIkZhrq+XW7Dw7JOmpkk1DAwVw==","type":"musicalcard"},{"name":"Nationale Bioscoopbon","paymentMethodData":"Ab02b4c0!BQABAgAGKrzkoMjtFTu4fnBoLjSBEaMe2XxSmcMZYBoyXHuBL79m+JTEbU\/n5LOmpjeHaVqUxziB5Tej3GR55t9aWR5HXY9vCb\/mxJ4qlm7xdVjb6Yu56ByP9+IjpIW2sTViIOsJpH+44HzxJAvWYHeot4XQaUf1YF7Q9tgHaRVPKqS0nXWJp7i4Nx1ExVb2Lof6WrkGSCdP5+M7tPKxO\/DBpXa1ldCYcb1ubWTyuhHePgvvTga6\/rLdKXyvezuKftLOC9JW+a35AM5O7M3k9+Qes\/cisZWWnvkrNyaPShCBrGwIWu9O2U6qd+2bbaDBEh9qe+GJdUkK5jxY7EOs7F3MeUbWoZiiNkKvp5BQqyh3VoLVGAiZJQqDaPlOQtX2iCI3cqYbwgQhUI\/Y+LH8QLPaE1Sq2gyAeZo1CCKa5Anmgj5rhpFt81SPSR3h+P6NeVNs9UypRDfn0oMRRfONoFNPsl92bLeqi0GjVqmI1Rqw8M7HsH1NLt1MjqkV1ea\/oR1Sv1mLTX7aRnaObFjTgDlAe2EW7\/nSigcxwVGS3ZtqNcksCWojYzDlpu58Q9tnTXRpDy69LjE6KgsC6R8tVumcqzdIWXm9JwWCYIrNZsjb8VXaNH1keUoh2nJjhudo9HpC35gPNqa3J5yRt91qq\/XM19UgunGFBMF1doFJn+NY4SCHExANCp7Bqi4lrg+7BndrxnriAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaOHVpDdzaZluQ0EsExLisZZe9P8jj6B28SWNM5DRuFVIYeo45SKNYL491pxNOffZYGHFCeHwS83mYSO+aNSMjgRow==","type":"nationalebioscoopbon"},{"name":"Nationale Tuinbon","paymentMethodData":"Ab02b4c0!BQABAgBSdBjHAWFeVqdlSeSqA0QDmRkRKU9VRbtV30FXKabZ2HfdlbzZLePz36F1dcX9zXR4BZoWazM3wD++T\/lXOJRiudsx+YBJzj1WSQkOey5wV71V4Kq5WPo1lHChvm1HoYlEJ\/8Jnw70w4n\/Wiq7B2IEy37XIoltDFQfzepQ0Vc8C8gOaH7DhM8koFeASy7CYJM2zRMKDfYhsr+5CWHdia3hfmCv67g8\/8JM2xXU8sRZ5tNFqPCTCW+DMSGYirVEqe94C5TJosaUPQdZ34m3HgQW0dDde83vWPeHBD9qq60NFK5+ljsYboh+I\/Ko7\/qYkJkLjJW6XRjxFSsUytrWHtvUE+g47KLyQpg+wI0Kl7yuaCdlzXqrIDOqRUlzm3\/GvsOlQFnZ45FbvdSdF2tlWq2hsheDNgx1UbcsGlgR2xwDqgfUi1DYXwjHvLgg2oyfyCTjvWXZRpSX0TMYfroD4eBXoUSBHNsw4dcJ24LMlR\/4uDc7XNDATMHWcDd7TGm1eND3hl9QjeQpqcdVpsY2ag7EHrufk4AdEqcgCQwz5jPXsWXwgZX6SIZfyGtE7bKNxDl97kJ9FQhSv2QnhAiPLAleg3Qrd061MC+CAjqOHxCGWCs2v0\/SR3qlRMkk4WFn1FHfz045fSfRRz14x3cDcMkz2arEv1aK\/OHmpNs5Ki8+6RCuHNwaTlfgUy+vZGMZA\/xnAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWnZH3JT\/GnQpJQAGmVDZNXUbNQ03jywRl\/Y8cUDt2sV1z46Y2z+hLkgfwjd1mEQy4RAXTPdEgtHP5txHGxx","type":"nationaletuinbon"},{"name":"Nationale Verwen Cadeaubon","paymentMethodData":"Ab02b4c0!BQABAgAOvsGqCDu3E7De6XOZvDu3GAadKeXW9pAYVtP+w1bqxGPUsNpOvkR9VtnoswfuV9vmp1BPUhOjLx\/ntsAIA9RXqrzROCo8n9p7Pv\/zhcF1sVSecN4O1ae2HUoFsHUxn1MHWdOwJygEWEvNZNroVe6z7S6e8oK+CAaJZLO8L77\/wMMYtnXG0l2hIehWEqcw+dNR0hQO6QrLz2cnekzu13A6DR3pkwRrZ1oyyfGqTxqb8JpSS6xuiXgryPtFOwKccmnWH4nHNu8qc+emuRipL++dlIp0bS22YhVyseUuwBBR+heYgXL6hnmNjKqCD2Qos2XJ40oO3eNT96hxy+kTPHkERa+LlPnBxb1FFh4iEir66COeE9\/YGmnCaJ+GyKGw9BWIF0lg+qsNxYjDDHQ5JXnddzVc1f4mtjaO6cyR1zSNQshu+IXraPkczhvGI4K2BUJpEOp+9zCCWv00U7f7Hj6k\/7UBWM5GQUVkBiMXXJUmxzqxTyXhDL0AikNJy4zg+QvgIjQHtL8TFdGd\/vH2lyKtkDrQNnHfLgyGM1kftBlGwn71BpkBgHM\/S0q0laFnHGlwMmOydhWmy2dBg34VREea+8wcz6jTKeCepRp4QZRAyibXdoxah8OpL5AfNqxzXfTR1Q5wQCTceimL9Gj\/mNQLOaQLxnkDkDD8zsgWn5GI7BDiepPIoM7gdgCyVya5dTzMAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTzqh8Ewli4hyfJllzYIZ2tLPPGyRVA6wXaTcI8+3t4S3VpFjS1i+gGatuMTftnuF0xFr99rBCNaoVT\/AWKSjMETKiqDdp0=","type":"nationaleverwencadeaubon"},{"name":"Onebip","paymentMethodData":"Ab02b4c0!BQABAgBKxnRmdq4ct6jF4AMU8YvlVD6PTAZ8LGgOaj7Kvp7Ty1jZpBKgQE+nWkFVMxLWSDVZV9YbxhXa1Ux676iU3KdAvarZ3SNUMx14Cf9uWsfNbD3eStRVuri1Rn\/a\/rtXQiGgBkl9MPII6kQbiRLoHf2VCyYMsaazdZSUVcq22oLOHUcoL1Pi0gZ4+nGWzUWKgYh3KjqtavrpUEo91vBbz6MA\/zJ8o8DnKjhcbK4SgHYj4EdrN+3mJ+Swdm8FN3t9WvQCFcu6ljhyYO9qeesaJo5xhgpeMtrGweGiJuoNAxE3k2l2Yi\/062I6AorN8tfP3Ndx8PPhqmKr81hmRhV36nWksuCz6Xiw4OkQ26Ra6xQ3O\/x2Xg+AZbOo4Ifug80UErQZrApNCe39tELNy539kWDMrvvbWDoT86DwRgvyGiWAbGrDBMIUUamTc\/LOV3HLK9v6NhyQQ+HR4w7W5\/Yaov8EjK4Uf5YygHdJfw949TbWEnYISutr59FmNp1LQ1U3FfucRJgciOj73lsvumNl9sbWS9y9vxPGBfQyputojHifrxyOJCLUCO47vMc8EWbr7sY2Jp4D552w1mfhpyJ8ZNC+rV5G0YlKqFMLvapomqmHoKdxAY6Zq+PThEZfmqc+CCeCbeQuOwoDs54u6DbSK9qYpSSQ7S1JxNVxZUlqb\/+2zxB0Ss91WpOwJsz+iefTsbBLAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYQKtCYgKMO+AOBDbpjGbqKyXMBtXI8euZBIzH1RBRZOjQq4QxmGtQMvhdwTHZSerMybSkw=","type":"onebip"},{"name":"Plastix","paymentMethodData":"Ab02b4c0!BQABAgAz0XP3DwHY67V8x1Kq5j4lUIyNcxhyYTeFvi+o\/GsDs+\/CUmZOgs36zBOxZoNQlx2oZE4gX1CIvJW42O7l46QO18yk76FjW9z2hEiu8OUBuyVx2LCOuoGbf6nCpLHDbptCJeWmUVjvvLrEp5ecXJZEF61LJRnsCVBPMYQGC2HZg+G5fMwgmfTQ5GflgSWvJJNhYewaZEt67kIEMkH23fEWk5fcrwXsK5RLCdGiPFtfroryjT13DLimjis8cn51wAeypTdcBLUDb3YDVRB0GhTMcTBOUawfga5YA+j7iXUBOTZA\/s63dDncGLRAFvMADdXHIwAdfzpcfXp73P5WmUy1xVfdFL+yT8thdDbsimGMFYW3B+DgxIST6DHvdYRQcWeTWHaeaBbxBLSlssgXZ\/uwZ1l6F\/U62jq+lvp0SLCL5VV9kNjYL1gj6ILq7Q4kpBlakMUCzD5HyXFzJTBIO4ppAnNwQNXxV9CGWWejaJ7CXKtvkMhMVxQuYEdudJuV6rjkgfZ2TaHtJ8ZDabSQCSlHwgNTbC+NmESnQM8NiFWUmRUuDp4bj1xyKsSgTckTKlGeYVExV\/DNjLhVETP4z2nshwNjKljFFU6tswU8fLlNIS5bSrBbntbDQpz9EyXSxlTGMn77KUBHsfj1snOMIn+IyXStUMhy+EukYyAs0Xm1oxBzPVY6E\/USD37p1Djfz7E+AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifcImGyztGTi+gJ8yHHByRjLvwsi78BpqhidrN6Of1kKrk\/399Y1IfZp1L8TkLTL8CPE\/j6ZA","type":"plastix"},{"name":"Pluim","paymentMethodData":"Ab02b4c0!BQABAgCpN9PgB+5PbyuCmztxgw6+aK6ao3WDV\/dDAYA4yaeYk0kSzCzSd0BScnh5Qou7ii8HijCNxdlLKa+KOfRTK2kUey4K0lHKqzjVBWg93+ls1WdISaSlwN6pU127jcQy7ayLhtt3Gay5zASPvNLuQfbQQUi0BxlbpgOyYN04gOyhdbHsbGvRqYayMNOeXLg6kcPJr6UtNvKvkX77\/FAu\/q4UujghWe7pY175G4+kmdYlo6iW1pqdNjdFJvHizzS+MxXozRckbl2rrxrw4PTS5Spj5i9EbfUoaBfoNt8SrDyxBroh4cUqPkNbX2gN8SZMHZ9Xp5EWPK\/TlHNfTiUfgJKAqXiN+9NTmDowtNOufhtckm679r1BZlhPQ9w9Wqw4NmO5lMv2VfQfO3q2QKM4DTMzOms9EsGVTaXixB3lf6ay+GzQZiNQpiB+PtCkcJjkRtAkuIR83Ru4MSTI9t11vPSY4sQiNw2hOkxUPzXtDinSAJQ95ddPfxS58DTNRIpIgQ08puopzECpWkB\/JXk9E4ZPachueVcLvAm4eOhBUYggtbQ1OtS4ifoilTHUISmgMBia+GeI7kPWfPjBumAvYA6RiGTP9I9F2XbNQNhNPj+A9Xz4Tv0ezu6Xatl\/5ikGUjArUkFUXse9WMrAQ8goojA2zl70rIsfD8FApqUGBuviPRCGzN1z8R7ZetTAgE8mqbdsAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifdHayxrlLM4RXYxNWex0cVNe\/l+mirjDxyZHFbANdCJUe5MtnIPznUnI5Kd\/ODC4AMbU62fupTbSvwU4","type":"pluimgiftcard"},{"name":"Illicado Gift Card","paymentMethodData":"Ab02b4c0!BQABAgBP8UNwgXCInrEhB+jYdTLk5ia9HzyhVcM903mjO9aU+YI6HwyqK19e6kzOx14TPy4uVwC9o2ZSG9jj+Q4P9crDepL6ltz7mEdBo6I1d4j\/dPbg\/ilL\/I\/WONbzyQuYmBBzZI1f1GQG5U+iF+d0XM6h7RrVS5xU6DZLkFkn8cY\/QPMu\/U+CDdjJKHfTUCyAnNlkBhM4olMHJK9QKYsxDLBbVRC3PeobNU6mP39wCCOqEGph9xqayFnIZnEI2gw0axCg\/m1wCAjKgwfzlLXt2cZE2qy\/V9xHxE+OZ\/7rEyAg7YPUYN69R+fbXfRNq7hvxNeZ0D44oYeEhCOk2k8Ue8AgnyUT9sx2gehBVw3GbvRIQPdhSN0DQGVXiR1MDgwt54NqvyiXEqR+gtgyR6\/FcWV\/\/e1g9g1ZcvAzLaFT\/CB1oepfOyhIXe6A2WpsCgXZ+ivz4sUKNRcZ4gcX7cG2beBWsGz+w9FHaXHmY0PxygmvA83PkAK8bts3ZM+1Z0B9eirW1OoX8xUkO+UzesCuHW4pcu+sr2wZD5YDSt5twGzzcbcpmSc4Y47TmewJOYl\/VuIwDd4l3DwsscQScoYQY\/1eBjC6IBOlhrmsUbL\/yq9917Ij9ScYEQ0g2pLiyM8MZY1lLHg143+ypIsfkTzIQtcYr1Bk7imHgnWIR8vqf51EkxDWYMmtYA2KtCSBqaI3nAWYAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWGCfN8Hg6fIIN1PcOKhn5oAXs30jSfkeuIABFhakzz4Ik6vl627\/JIlF1x5yta1+FUrbmuIkryal7ZE\/paOQw==","type":"prosodie_illicado"},{"name":"Rob Peetoom Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBPrkGi1lxsmHWAZ5YsdvcYyX5gSxxx1GKvThlarnANnNV3\/5dcTI3kfq7ED+DIuscvS33bMGGdZB0zWWk7nEOKodpo\/QmhQpuqsdy126he55Q3ld+CX9aigM6eFTmCqy1bQNYqPJDzp9CHl0gKxRmRjHeJVAgVN8ixQ0NcfmcJlyk4cX1unuuI8jfLbpROYUij0bLQbQXIC68sgBM2WDaJB8vymgN+XAJMBsRLxNe\/7FKOaXptqv6L3HxleCXdV7hYbEvQsW5BVH4jo2u2ECmC7eqeU0YdQ8qrdXCXj+TAtI7jyOhSrEN2Dy1K6dspL2ralleyHpm3jmrhS+NRDr\/ErlvEKyLB1+xkrgDyMdDj6uGHNb0g9UJ2O1MU1\/+bc7GfeGp1CRDq24wEbRp+YtNbZ5e3sD0h7o4E0iQcCDpowZ1EsMqUsy1ORCtznaz30tL\/jK30yfhhuTtNhXC\/xvdlm\/jkDiZHYRUT+1d\/GHc1Q3HxJnpbqkYTJBrK32gu7\/lG9b8Pob9n5CnbN3My9vMLcBQ5cK86d\/F+0i9hSmj+TiHS3cN\/11FY9TRH9neNHLnaLmdqjSfOp\/unodw\/Ug9L61QgOB0V2d1H3BUM0IMWs8OBLFqZ0NiDvVene5COcSSEPIFfO4+Wq9Is7OworoKwzaizc0QelJPzbw5gIIccXRBuPDqtnhc+xY7wD8T79IMeAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYBTWBV0iDuGH9uoF4QDbEGJ6Kdg1kmTtSAVix48HVSEXHf6AR8qT19UQOL3PSAaXzNdWzP939pCbZ9b2LzVD2k=","type":"robpeetoomgiftcard"},{"name":"Shoes&Accessories Cadeau","paymentMethodData":"Ab02b4c0!BQABAgCamYFI8NGAGQRFMz4zD9ZaMmORJl7JgqyH8MSEdmNSgVNNXCdjwxq42EpPta8vNYIJxoHwocOIZCR8zkOP07CMS5\/tJ8\/GPz4LSMwBzc8cPxf1iGec+7SwpetVWQ+PrBhcgGN\/zhh2G\/XZT2VufjZyy6xb3H5BZRtzsCNLjAJvd9LeWjh\/cVymCuKnZZ8po0BxEiF7D6HVvHqOt\/ien96m8iAhAwWj6\/bk4GdmhWaqA8DFqb+qTbDQ5CxjVtCVB5nFvbquIuFWsuA+vV0FcpmJUUXqRi0T74qLCpoiavztSedKK3tCs4OxlOocgX59DIiTdnmTSW6RxdF8QUavk3xyX5XRhO1qGlNRLXVXkEjKhwrMXHUXJMQt1yMQJ1vd8gLCgwNtJbZOkEr83C6H8y6LazXnhFGDVWKKZ7KCS+QTOQ2mtQj\/bRa6DKTenJXitXYoKFKMAvY\/MuNPJZBj4np8KnzMDgpnJN5sLOyrWQFczdYEVPPD8oYzBagVRxVBdwB5+7I0h6hxsKfAGZIdbW934p2Lp72b8SmXMPZval41FS\/j8wJ1x6MbcQjBbAcz75cHIqBpOXRF6j4dWVndwaKcaxzBgwz7162rI6OsMRVrGHNak\/4FSM68ffeyUHdf3NA\/zTE\/\/weNErLmxjzvbNFu7Ghvu+IhOtDTyi3ct3ewGRCP9b+BccSXwIsgJ+NkAvDIAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVuHpmeLlJGlRnY9U\/6b3rWTtSTca85zykpddNhov3AIQzlrdIgACu9SOITAeyv740R3f0t2L3fy","type":"sagiftcard"},{"name":"Score Giftcard","paymentMethodData":"Ab02b4c0!BQABAgCsAD6QS5AWxVyPO2sJyskpyFh\/tVIVCByXM1cSTo5bfw8SypTWe+4ZlPHPc0ezt84DhXEr6TOfsjXS9ASKFkanm+AQvEvWvLLfO+l+T3RpxbmOQTGhzx\/y0Z2GiPtvylE+Hi99Zg5kAqwW1U0B+MrnN3VQkT5UGScY2\/oQPtpDGIxM3q1pOJ1wmc7xU3TRaw+C7r+WQhGmXvAyRqYd4KWlRkNNzaG\/CRXiekrp3dMp2h\/FqMetJnUyodp\/p3gfC+JtpC8UDrijl7enUJ3pN4VLYeeAlU0XtXRFjqT2vT5Pwb21ZIPvY0ViLVS75lW5b5t4zvGH\/gU0t\/0MuLwBEi9NzfH+zKdIBxldODf2Daz3fAMfo56ThHC8UuBncFYHXYT04bMaVSbkwfFgxxUXTv\/LwYZYKgnOkU4IgK0ZCCPjMpH8xLj24fUEPVcPJI2h6C1fFWtgh0H2lP+XQ4b4qOMa7b2paLyLNEFxI\/V48KKXBFOtpkino6vXzKEpYWjTalwA+8K9PYfF5FFOXym36jNY9dhijiBoA9\/qoyuQqZmrmQ94HYkRnSIR5wBfkx73Hr0U6stj3fwsd55M20JiGKp7bY2z81VCc2z6mpmjRyhHJXG5d70wX3ieNqKFNStHyW5+lkIeaJW404Svytck3kgchxou6CKVzvaSm6aCsGTG\/RCFmAjn2Z6NdmHBaQrSXcutAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTD4OtVWJcstgpTY1+ZIpSrWXEOWsSqSiZuQwnq6u95IdDrYQkulLduW+sOzopMVSSmaRLGtgdS3Y2AR","type":"scoregiftcard"},{"name":"Premium SMS","paymentMethodData":"Ab02b4c0!BQABAgAEOrM9BagQAJYKZQNCiGHVFFsCC3VuzYZrfoCCn55XO9TnTaROMV0h\/bGll57gS7TqiGuoCeK1l4Y4V+aNv5OC5c\/wAUBYDw114hWAsetFwu6pXLv1br9RIJRczpyvJlmRomRLPQpaN7cls0typ5WoFFzp9WpwKweFBC34ZIPLEyrVyZDWnxVrq+kP6p9BfLwGaxjE0cxoTq7VLPYtOpSU7Pxf0fDmEd2Jmb0ZBq6Ed90TYs\/EyNQX\/UWEMjkZstMGB86zCbroxBMLZBmF5GErKIIeyAuAylvyA4LrfTg7T00AUEyD3X9viyHFigtxUkhDGWpvK8iS1cVmygqUK3h3DXHvzKmvFOdfmeI84TEhflFgr6HGCNSXKmXmYVVZV9ZJp0nDrNWGvIUqfBCfOc4N9d7gMFqJsUaIW8eFqpwpObivqnqtN5ZMzpWp5Jc3Xdrbwa4N6e+aer17AqrUQrRqHSr52XtZiIWtVs0S5XJNQJRjNU\/Wvc7rg4Y+smVcfpBJJmhWxn4EPtNunALAoMiNRPDxJSOoJnM2aampaAQlmc8A+EGHsykWCG4xUjytLYWcvOn33lyEIAEui6Vphq4sdCnAfSebf2g33BuMZrjzJsaapVhjtARxH+mT33kdgm40D0WkE3RplfCCAXL7LOQgErWdRYoJfTxqkRHlI4bwgBCEwecph+cqKikCuEyH6i+vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYo3nNjRHRR0bt+z9AiaiGKI3Jq8ondSBT0URcHGdoA4Axf1iwA8xF6ux+c0RBBUoIM=","type":"sms"},{"name":"SVS","paymentMethodData":"Ab02b4c0!BQABAgAeBmmIFVM3F7FmI7FUeX8E01jMco1k+S3CS+awh7A3cCfpKvVuolk9y8ot0HN9Z+RnZnVzRj2khOGPL4ArHUHJmBjCxknuuP7eVEZqbAR45z+FOl2uCHw7508\/fLLCLg6F+WxliWe\/9zf6\/kLz2rWgo2YIjEM2Id7uper4lCvXZW4pe6IRMABXnR0owxpv3ZFyGY7pxGst4uLiQ9NFmbU7\/5Q8T5s6tSvoTTMhQ6jYsQQ1UQGUxS1DzPaI+QkMiBOxB6iRPH5hvnLdfjnsEBFZqFwDxqmJXokHu5pA8ZcPD3gOasK0yxkrOnJsvIYxqbgNYf2v\/366osBNzspcwHySDS+6qJY3ELOhr3iXu87zs\/JF993pdxvcS5isDXPZCUjx2zt6gqvvOSmmUei23TXbz66N+ESdfP2Z3AeYbA5U9T9f2T3QpIQeas69oQk2TPrkqeC3uU7Hpebbg8tkE34cWCRxWnwrtCfhZqt9DWMDc\/yZEPz\/P9AvpfcDb+hRe+dlfjPiVMSN1XB1Spc47amAKQ40f7FJqqEPfTe7EpgAoykt3cOPnH2DBQdkD7+N9nJWX8586qRXy5iqF4eBgpce9PhNYrkAOgAnKINAZt5sHmXqyvbvvAtw0f\/IViyz7dGjBmCqgVzA4wqpEyKi6SPmo84cJz1aP9TmVkRl4z3HKhCf\/wxj8atKh+FTzLWQrdDGAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUdo6211\/Wzc0dqvxJR3\/jWN028MVDDJ25rQjkrVgftRgtIjiWwm7vIdtV0o+QnEa+g=","type":"svs"},{"name":"TCS Test GiftCard","paymentMethodData":"Ab02b4c0!BQABAgBolc\/4\/EGNHf1pMDEsUskyzhi9KYN3VJ0l3+0ZjemuURepWRERtEhwImXhdl5R0+cnJbs5jefQfLVytf5e563aoA4lwnadk4XJS\/H0qrhBjQ+9uC8ZFwxAKM8Q0Sv8t34aidyRAFl1IxEc3GjbSE\/ujiYL6LwwCoRNOZB2GgojHGZPm7Trh5Q3WSSm7d6LspS\/qgLN+P5QdrMHg3395mh4ITHNll4LeBePw7tFjuaOPB7\/MuDxmauyaHDs23knh8xwRKFvydDikDNjANai4LWhNX\/74YWBPiQmI0GZ2glGiWUeRfyaD2VhHxAiYdPLQT2GhcDZ35o7Th2wX4HSg76TT60fL3VXOEOAinunSOTQo0dcY5aN55O2CQ7CzK2XxBRc36Jy7J0gUKk7fX+Qa74eG9YGfHGYYzN2QIDCpFK787syWcKQ0Y6AMyQTYbcIs\/iGkzZ9V2URyBh8sUCda2nhpBgLq05UBRjPu73Op3DsS6nU6VxPg\/BjGc\/rbt3JF+cHbFQDfiJKiFQTOTQ25gzMZ9fwW9pi0ED13Yv4WCGVTbbHGoGePSbMyopjzcwcqhSb1LyPmpKPoGeHS3wnrBRK3nEZMWUJ6fNkX2SCCVB3\/QeFxK9Psmr10\/pYrso2Z2lD\/SdoMebrdLFWRKHBuI98Z0vHs1yyC6TJhJ\/AQOfjxxD+4nyK94vO43QSq2eOfs0nAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWfqRm4x6b1yAPMGiiE\/SNY05neMsJjWAP73Niv3rOlQnzl+TRhMwVGR2URszHeFIwAYF95evu7q+h7Ui5M=","type":"tcstestgiftcard"},{"name":"The Sting Giftcard","paymentMethodData":"Ab02b4c0!BQABAgARZxSi9l0bosY++4DiKLjUe1\/\/9X4LNxVhzU8cuZlqFg6AKs64qmU3Jz3ckBYIwawAQ1UoRP1EH6l87scIb4E7IuQC+Yy+D86VuV4JgXp\/8blzq6Ix7uruU7TsGbCMiRv+aI1DWSrmjk\/PD6yElbE2D6wuN1zCz5u9K9FAH6gh8TztyGqnpj07fuxbJZWGd5V8pi703k3YfdSDAaycUavf\/6aKYp2oMGKxDngbxJ2l0qwoQfOrwwAVFAoXIIWkGmUmk8Ez+bAThUzmOzJ5X93le6sJUPQpxN1c4Ak5avVko9DK8VWtamkIGXBoW0cL\/FQDxM\/yfvIbcsL64oCAFB+5LUv7+5E5W79YY7Wf1f7U1ok1bk9QWgFvG3pr8PqxoITc7LpcIlitBeclfsBD8C5Z4KajJN5k64ECtcoXUdaGtE\/RmbgfWDWGjIcKsCnpRcS3fHWeTFGFatbins7XL\/v3LVzKVPkZpF6TNGhsXtqqgZeV+vkIkCq7E\/GDddpljLkspqqSVvayYEf2HvKJ7yorY+5s0DMXaEqE8ZIdI5MF3SQXDozK2oqpYSlOY5bPAA1t9bR9PbvN0NX0gtjo\/bcFKs\/steFeNY\/CkXMkSq8VBnV3L4xmOBo3fNN6UIOFIehmrZpjzTl1xuLzL6TbW10a2cvfHCxn09RiFMeDeQrH7RCCTI1cd3NmyITBNEieuinBAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTU06\/CT1jKoO7oqHjl3sfhGodXKB1a4l1iTtGs9B3evGnR3Y0sjvjFzH8+ucdSZuWJxSE+1lOP658DGh0hb","type":"thestinggiftcard"},{"name":"Ukash","paymentMethodData":"Ab02b4c0!BQABAgA5EDRTW1MJj4ec5EAPY1ATwMYvsgnwLTbirwaXJCCGiCe8I8CgF3jXymhiHUku2JYCViZcRK\/tCz7oAMUX4wxjbZghHlmZqdzP5BE\/KDwvO2Vsxr\/qmSotuFvbbNigiEmkeBj6LoR7pQGvSVTjcsp1W3mL47snog+rsn+jkj0pXJhZ1U8\/aXrbB9wYuyaPWYrtqeDa1PL3BcHtf+Z0wNpdaBP+LpSpgq+klmUARH26RgaJ81EwnCOxESR4Uyj16bPzmAJUTxMaZkC2jHughbG5tAJn8AHFZyVTMEYWOM\/1aYZBJ5v7KkJIN\/Onr+oYhQIaEvJH3OplSAz\/DW7z8+8jJ0+5Frv1\/RCApVUSfIUOlN3q10OtGkkDgGnQ3ku7zMQj6AMrI3KU1tsmaw0C\/B17ZZ4z1XBSgwvUcRiz5M9aNCg6yNs5EUvdYd6hrAwM1LDvrioq+F0gWlTW3f+8Pzydx8GMLC\/xcYG\/CJ8KWb\/Qwi2JXhrG+ZR\/jE+VHvzSt6zuWaWnFP5pY5lr5L0tki1fbq3tT8EwLP\/TdF4LX7Buk6uv8jkQMC6pavHTJ2zSfmB1OZC6VJs0KbSaphSVhe9ka5SPrrzH\/beuNQpgIosE\/tKIVs0YDOepJvyPHV0fXO51fOX6dwl0XSSnmVnpv6Ejf7NNPkaqrHZ4TFMamIGhzBBC5PaMxFRWVoLbpQ+\/zanlAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifd+vkInPycf\/fO8hcPcxypCKMgn8r6bUoLJ6gYhTB80iJ2SvRW7UelG619SZCjeiejweFw==","type":"ukash"},{"name":"UnionPay","paymentMethodData":"Ab02b4c0!BQABAgCyuA6AzYVuq7r0baj9TvTCObZzY34GhJXajSgYTq5YtvuqCLGYU89mEwIDl8WJeGPmeeoKLKwGr9D6K8sinPMf\/prc44smlae8cDbjQFVyHkA80aOICCEVOaoj9Ku3pGf+1T3\/MuML9yxaI4LFziZS1oTw+K4ca0Lhf3anHgK0czR3jjwpyywkku8am8L2nTZTBms8lwo+2yZTBmL\/vV+WEZhk29daHZWMKsMu8luX5tgW\/E+UHDye\/t2riHv4cBDBns+bV4\/46JmR21mGYqyH8UwtbIFiSJBmR0jo3\/jiXNrwZL\/gE0KKoDYFQ1BecK+2AT+0LkyFdzepqMEL9eMLh\/Th+LbGVlXFttBy6vNZUHXxHbHWdW3u3RgBCpxwCdHy+fcSGfaOKTfUBuSB3Nwd0pHsS\/659ocRfoRxO9pKOGVIqye4twmX2AwygEI8iw2maF8r1JmsvVvTliiSt4LJLLvs51R5atfLqG4yFpjN1Rb3WXtekzncKfn6kADN9nnUHkI+thX3Yrj028TyOXpcGSjhVLAF\/YUFjHnTQuc\/0mY+JpyqtOBamq18DGfFIjwoXAq0\/rRiJVsPwTccI5jS9MAqZwVOl70Q27fYYG3ujiwbwW+REZlxGVOgCDu5xznDKLICF0YBeAi5+3dxfLepkU0n2WIJgXM2cX5pgVyqLhBUouM8o96DqR+dzPm2tuAMAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXLVyNJDBr+PMaR5skK\/WCNJ7GraYtn3IG53OlJhFTvHAkSpSXjr7aNW0fQPF4V9sKyqY9eyHQ==","type":"unionpay"},{"name":"Valuelink","paymentMethodData":"Ab02b4c0!BQABAgCXS3+Lg6LwZu9l\/UIyfkrHZrwgOEU7G1xft73fqNOT+WzZ1qc6RGFxgbgfxp\/YT1c70OUKbO6skjYBHAygugKQRw\/VR\/C0KeRsmP2peysWmHeqTr2goqlz9KBd4vYS9SWMO7gZyPs81M2WvNqEECIsA2EidAoKNtB\/gY8RTXzoXMP\/ZdhDMx3jOwTmJwngiycyJA46d8oo6eAFeiO9iJg5d\/VfC9yN65uc8s0hBmFmOqdMg7u6m+Qg52pob1K1U0uDgnxkWdcYwndFwjwz5WmFZGXYOA1U1VCt9n1Wut9L\/U4Ninrw\/E6VxHKfAgHHYLyLhsFgLQ1DLRv39o8EzHF6EhwT9VofcqxOXxff9DxCvQvWwZHch6SSKqDLLCB3p66r4RxAJ+UxBhfmi9rm9Tcs2AcFjEZSWdTYLtABhlTxkZBg6GlzltimC1RUNInnmK1Ne4LQIdg7uJno2PLvPzIXFgE1MVM+E5Poms8mXJpwZEmsouIFfZc62Vn09YmOwPJWiDkeyuQ9tdyiOI17hlPgcsDZTRXQ8Fj25RB\/L4NoBMakD9XR3fqVsoxRW6eWmhjHEEQTvwtEoPtQo\/BR8105pk8fb3L8SPjxH2jcPCGlF9svIVWJgt+DUtit0SKfRKvb8icQoNzNrFGTlsfIAhLSTvcvu3DDI8vrLJwOXwE+TBBRrXSqOwIRPwEx7ifaQEd8AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZvexSg4zbtYaHe40B2pdrLV2LDz5V\/XHItrgI+22VOX39R8C9vv4skekFaHgZVxkstbOzkZCf8=","type":"valuelink"},{"name":"V&D Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgBXdMKsMJE6QVzKoo9KqxS\/uQcqEhtL4e2+W6p8fP9l5tNvDC34ynhQfI8e+XPB3WawOdSnwNB1HTeRxN3JkWLm\/ei0nZjJObQFqjD9YeS1c0cuPSRMnGd3kogfOsjt32SFt++BC+NM2xhglKqLewi35NSIeFpEDS5TW1VuIkLSUsDay7rd7Nxgy2Ob2qGyI5LpJgBIKhteDfLTW9Y0v1row9fG9xGfOaGWdSXLpDii9ymngo6ap\/CDvh+nIRmr8QXtkb0jKv18NVAOpF+Icd8jbNCC+0RIXBDMSFiPE3HQ6Rg5744p\/3dFkYU90t7FnG81y3IVvlPc2WDHqCC37hNKBxcx01PuB+q0g7384XDdt0InGgeoyTsRnCiVj0dgBDCCwc58tmLrGJOCjXXUEfW2fRn\/P6ImmbfqSFEjVo5jYf6fZOoq8eRqbIIDrAPKEyS4fAmvFdX5XLwsQ+9VZC1DCseVTsf43Hcjtg9dZbFfEaCQ9bi+jlgah5Qt7Od6X0ZLrolPnlxnEKgLqVo+Bi2n4ByeUgSPEzWeKyjM92C\/4Xz6mFvY1reRr5FOyCu7Jso2ev0p9IcIPlx4PR0SUndKhNRayth+2mMmUnQnFQ6uLdh5WFPOwXJtvAviJEg+Ar3yjQlqDoMypKP7yik9oCNE6s4U4f2VbEUTG8CilMPh4BB2M\/bd05FUVn\/nuRXJPCIaAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifS\/x+tlxsUkQlFOB24V+5fVdy5RAOSJ4MqfntnMMd5C9PS9yyLvFpMpl61Ll5XZ6h+6HMZYTR26H0S8=","type":"vdcadeaucard"},{"details":[{"key":"additionalData.visacheckout.callId","type":"text"}],"name":"Visa Checkout","paymentMethodData":"Ab02b4c0!BQABAgCRBzsU5zUnZKcgmFhYDAXqzYkmTbNDzWpSQ8WDlMrVK5qNsuWuy2ZaXnD\/Wwu8w86\/0Hm1E+ftEtsx1S3puWyDYsn0HkGsn7LMf22QlYTapAzVKfMfy04+ftonzfa8\/F8CwoPrwWZpLDU3fHuX3BeQiZJnNPJLBx2P6Q+R\/jLnOLqNZLJQpn5AgINh2PMVAWFs40Rj4bVAK\/ZKTLovtrvOTv9q3DrbfA4Yi8FCe23kojjTS+L0UeuQ9UqaFsDon69UPlLBgQCae\/5mLBjq5+VnRp8g0Rh8F+8ubNtYuV5CRg7eVv2EmvKru\/HbC3MXr6QLk3ZE+9Z9n7ZxoS3Ka\/KyYEF2ezr\/3vtO0Ow1z5eTGChZbH7nnIHrrp0oYSrm+sAzuNbzcom578Y5yfHs+x95OFOiWg2EcrYgvhiy6JWzKDkdkiPbU8VUhiW\/WDO4g5UZU7Xz5l1dAaUQ0u181Z2erZYG8uohFHaLaCoWAJ7q7ALJGhaER3YoMhyIvxF5PDBHo+PJL9fQi7DBJ\/4u0VN3a7JG7Cl51VDn+2+u6mp4yYIDyel8AG\/dQTEQzI8goqpVhmhbztIYbtuy1Gp1bzpohKinkaz85KkeSjDa4zrgWeE4NcVFXolUBKCMr8lbop2bC9e\/ad5vIgBbQmcoSuvSI5vneZHVpLLmf2fx9vBlvBArh2yuY60lBQFujwx9ZqRKAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXV86VMveVKN6bFBc1AViWY+a8zixARejUFEeswDbijtdg80oiA0iK7yixQBMmJp88csCWkz95KSaOQ=","type":"visacheckout"},{"name":"VVV Cadeaubon","paymentMethodData":"Ab02b4c0!BQABAgBuWnaPEjzVEB8\/NGLFT1i3XrlDJzrM+WNb\/Jlv5tb4pJctyyRwbUtHE+Yo+7v9XRANk4DGTuuMYL5BbaqbuUvs2k2JbgnlWHrqqcjA7cEz7EWRDEm2m4jWnMi\/KO5buk0BbQ+Ki\/7YNPsSkuCgUXGrIXAST5GRPzIwFYOS7M80DzlyKi8R7TdJAu8nsnpihktLBVOHBr9WrNRMe3S7p4Pd8a2HJGD\/CakIL9u7LXYhqYqgfkxfdvQrQFaz31p2xU9s\/o3kSWXT\/gnCJz5MuUhqXiudI9mNroS\/AYbUuSZIFFnuegd2t35BW4j8jzvgOZyoPRojqCGmAYUP6aAHShe6XB+7PN6dAIhJkLXznSpIKC1BtyUuG3HyUOwqFyKtt66E1\/ICJCmAAfiZkbJBFaSIUFnx1EM0hY7McaHS0+gfb1dQvBhJP\/fyBDpQAx6SaP2JAG9yivmzkH3+fMNoP6sxVyCX5EHnblAsXQEWxnJGZWWLzB218sox24jDHj01c7ZcADh4gowAJDZYsspaTgddheORCW12ovjADJFQKGMKEtpbFNVZ2TQl+mwBss0cvKspm2kGAPKWX0DjKa0HHvYnepEqAHwT6Qhe6PXORHbK\/3VcXdezEH8uyC6W9SsjsDO6GVKpWWItfOOfCqs\/\/3ViAbk6p72shjiFn4Lu7+B+HBCaAFBKqrM+zvXaV\/tH3eP\/AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVRLRyVt83jIBl71hMGKc7Aq0HNbfIAVFcPCegIt3jqjLySlfdxuP\/plZq3KB4f7vBdLHdqQ\/3WVzro=","type":"vvvcadeaubon"},{"name":"Webshop Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBw5gIZYWEh6Zd7RAM0RcpQNhnPRtUAHANn0tEb+FCguWnzFfqRV4thObH9oySVyjYp1vbALAAJGnkR+Xbm4KLf\/kWzz+MsMidMXC+FWs6hz8covVAtzRIIvEXlRBB17lLCeH9yJnWau96Xrm9l+yZgk0EchvtQoBmYeqSb4sQqJYkQdFQTTJHPAea6JrczKFcheU86s9QeSbzKxUOzI\/0ORulFOQXEsjk3Evm2fQ59KL3oBtcJF1GRJfcWQJ7zZ3JRhkyH9g1+Sbbfj1UYtsyl8d+CTDwFuqWmZyA39biI5VYXBW78id4DuOVKdzv\/Dv4zWy0dXDM3Voce0oZIRwQBC6lg5N2mw4RGAhp7IcUL+4DpZcrTOK4+ED24EmWrlpTusUkHNX\/SaV6Hs35PTK065jXtXmn++GvF5BzA4NTAn+shTTHCsl5sv9rhmmwx3+3BCzIj0cMAiFMTsVZ1Tx23+MnUXFIqkljRlyD07FnIXIbKeJoGtx6t+B9EKHCqEuJDnKWIEs+DnMRQzhiuaOh5n\/G0f06Q7FG6PYAKFGTe\/tw+GSKK6j71dYGgWycNzZeHW1sSNFVRL6pURb3S9RBMjOpeda3fUKChbIPqhjqF+wKl6q7XQvm+w4dKXHyhGI5DY\/9Vs\/DX74vRxcTtutZMhTGxI9JKmyYDQToFhwEKSxDXjdC8tIvsJDu7LQ8ve3nWAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQNrhANo5lS82O3KSvpHQtFHz\/w7XKDsG+sZhRsBQY+N+1Cc49e3d3xeejiToANWLbh9llsOy4hRUnTFUeI=","type":"webshopgiftcard"},{"name":"WE Fashion Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAhMJIQ8zSZ6B6qQsbRyoLzMkLbJnIcfJHIMLS7tmbn3eRoZKTRWbey8PIxoyltacmUJkU9Hktzqrcczfx7UZdEmS5XumukT4NnlvUeLQ6iBNiTm0WNqDqgL8P8Vzpu+6GJsT41oxrPWQUnRIkh9ZBjqkq6Q+RVHJwsYTIdZpKGihaZlI3zNBgwSLs2LzlLnAqLARC5X93KvfNC9WifdaPentJQmmJUx0U6qu1Uj9a6sHB8GNNWBRZW7sV3HhSUR6Q\/FXYxZXmufRcqM9rYxIC\/Ju4EV2bJ+jLaoPpXu7PtOXiT39VGaZ0aX02gehuSgVQ4hjw1i7O6kjcKUm6PXXp0JYFeH02ysL6eUBuzi0ULP09PYg3CyFukvkec+RnmEQBAcWCQmzZ1orHgtCYXCwl43lI5c+NwO4mbNC0FL4f5Y\/UgDy79VFKUd5l3w8LwAEint4h21nMLKZYCJx1S1eCX5shzx+cCSd5GAqWUA77nXkUSwDBXXPmIp+GKQMkK7IFHgG9qTJ9rFvadF52PyEv4bsWcjeAyz6+CWOFBwk5TtEvSKDfKLAqU9+me9DfTP1QBY+FJYiBrOBW\/uBgv\/6NufzaDBWds4jJOVpo8S03\/yNCvM94DTJPIRfibEwGamM2qrERp86e1wjr0ao8B\/Zlc7ZX8QDzqDmpTCHT528mbuBDkq7A9lwTJVNkf2laeBxcqAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifeYhP3EugLn\/D17cS8QOqpBIMSUWAoJfWN7rKm4sTQWjtXSso8521xeQzTTR3j4Lm4b1JeZiM3Bv46gVcq79Pw==","type":"wefashiongiftcard"},{"name":"Western Union","paymentMethodData":"Ab02b4c0!BQABAgCCqIHVjvWFfoO125G0Qi\/aWnkQVzmVVDCo+XpJXABFD4JEgSxsq2trLYLqxixmrJXEy\/e5RS1Y0KD2omwavOanQ0NWqkoerbCle+t1SAC3rpMYodSUhBAQluXCSvMRXNFrzFpxeK5+SzphqzTvgvLuMCN3Kyy4fBzCjXeMJwQB5o2DraGMt6w193\/\/nD\/kVGGexOhMfFNitRypd2g0ILs1S1O+rLOh2UYvEKczLbJ+xOqtCckSbE7t\/A28y+fowJxyqbDZFn\/Di1r+bK2Q+B+CvAcvdxbyrRJeJDQSvYI54rz\/2qk6DvzLS+yKu7uZmBaFsd8GF1Vc0CJWVeLZ1BF\/ShquUwXWWAwtaK3zYMy3C37QEJizTsOPwU8LgQ5xvzEn2W0h8+YrWqhAHnLLSfQv\/QyYlYuSa6MYcp0CfuC5Wxr0XQdHtDtdTDx0ixuCvG+bV8Tey6pEABFVDFLtRHhWWsDSlFJi35EMawzt9qBQ9ri2mIBjeoTZVmYNHHPoQSU7lTupadcQnPauOy0gTc98ChXlDQaYIxgXjoVHoQulaayi5+HDNFH6FgJEltb7+vZ1chT83KDM32bigFtQjob+vb7uArSqC1QZofwA4brnBmitCTuFFsWEf93x9kzru5cFKnZZCu6LYeFBqifpRDnTM+8OcmKjXXUv4OpzUKy6hxDOyQJZ+vzZMa5eASNa1ISYAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTr1ArwVsfDs6+p1vy4hzFpiQEO1qZlAmr0hJBKvgtDG\/ormHk1hx5CoFvjgKJj\/g9ORllgYAkavtqg=","type":"westernunion"},{"name":"Winkel Cheque","paymentMethodData":"Ab02b4c0!BQABAgAuGTr7Hb+sS9WhMaJbxMJQhXv9kpCTqWbc+RpEEcDBam1sWPzqrAWeyEpqPp5t0Ts94E3zW7RTJ0AyEvhVS+KpGQKn+EI7jt0liVbDaqFAG87xZdNdtFVXlfBwMk4DLWgr1QOYW1AABoVcVV1+Mq2hL\/8sv29dh9ORkTf8fFv6BuEGFoEc+Yze7k5gLXnLrRkiBVh7WhpZR6TXMZvebgAjBQ26W0erUSTjzzs4bVl5ZqsULqmHmjj9ZrI+MZ2c4orYMK8SJXb+qKZ697NGEazsyMZZRmOG5NBYzOEjdK9\/SdnabgRgqxAWhy3nSQfqNgVArpvfivFbup14x\/ZM\/P2P6xBFyNyK0v5PN2k9f3gFEUtvM0Yz3zj2p9qAw66U6+ug38u3luiIwLHXFv8Mg87ELftuOJwruAYurvCqyvDBY0j3qgBb8fa3A6EULfXU35V0hVo6r9SHW3efvsocd6vjKQogZP2Tgf4e++kIF81n1w39xSPaTaSHNnc9HEtFcEMrgkmFlm7+MWAIf14xWi+jDdPtJtbSkFE\/lDqxsyE16axJ+nCZ2914Eiplrs6Fmq\/f3T0QXQGXsZwTXMwZV8ubAa5xv5Sowoi2ZGVzDFRhqxK3PfdQIVNyS\/U0zqDTJ8Dco+0DnlPfS+\/S3dLHixJzJDJegh1\/cy10Vz8QUrBzpRBOKwDnktP8pBxNeO0dVr0nAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTRFBBd7HtMO30hv\/1qeyRVC\/ySeAXdYL++1P5WngYLi293p32vLL19uakeOYJbh0acNqVNS9uERfhQ=","type":"winkelcheque"},{"name":"Your Gift","paymentMethodData":"Ab02b4c0!BQABAgBwSzkAZFP62rf9A9s1eTR5eZelvAMGdp75eyxk2\/054VREmax\/NX6bgGYg6hvpRuE78ATV0+9jI4LcwHKCMuXsZWWqj9Ro7hddiMuc1ZDOVmCAchKVnlR3X1R4I8eb4U+plSY5C31VqDBC+tGAdsQjm44Y0e9e\/W4kF6SVU7UIvh8\/ts8McsFMcBNc\/gvQ\/fTTSgLyjghJaDc\/1J9ZFkgtVgAoTSqgziytCwx9J5dV2urWfAX3sIKyI4tIMgH7C2zOvdE2W6woJlxuMC\/bhxUmt9zM9RUWJVzkwaVKpo7RCQzquoSpO3M+koHb+kLLp11XEk4MMV7jVbqLYl4dOS5iP9kzcce0hx+SADNlENxL14W9EHHODaQaeSPrueBGlf4l8GZMny3IQv9UzmSS\/xWvq7lOPov1uFyJKXFI2jILR2dGA6FK1+CSuqlR\/nkyQcQo2XFufYi9g2HatTFfd4MXkUSHF4\/TpdFAd8AshyabLjhOmjbXZG1zukWW3o8Lo6\/rELOloFpQpdadsXb0M5vZVkrzKIIjHoY+EvGB1urnbZNKUzah2W+2chqSC69INtIcGj1M7r0Tt8EaMg4DVAKMXsMnYRIwp2h7g1NiWvNcEgENUCDpuuWENa09yA4siPR9aWcLm9nukW\/TT46erTG3VMhKF++tVp+GFBeFTr83XBDPsKLjXgj3XpGkvhHlmDFKAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifa+nTY4wbmTCGTsoOuYLTfMGaYM7Hyyz7AXsLTj951IZvDN7doNuKw2PdTY9Ed17dTickZ0Akw==","type":"yourgift"}],"publicKey":"10001|BDF03F216DE358DD6AB214B74BF0F8BFDCDA9F3EEE0B369DC5ADBCBE0FFAB2A4FA1E31C49519BCBC7241824EE45F7ACC5B04123446D105B713135897F6CBC82C478DF3B26FCC0DEDDFE8BD2F29DBAF35AE66ECE6AFE48C985A08591CDC57EA2B35F2551CDEEFD3ACFB912E0530B402549399C93C2C23CF74C444515FC6A6E5D267A4A2E51CA97F304608FB564DE70E1D683CBDAFD7E869123C91962380D38AF740033D52DC2523DA80CE72097D2ED7D1CAE33B60C91AC2F6307795808D2D351FD112C283E043F1B266C2C347DEE31EE8D606D512431BC5C9C01099A967532EFA06698F130AF5005ECE0CEE3FFAC24884E2C7F6FCD48666D64D40056CCBE62579","sdkVersion":"1.3.0"} post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication value: @@ -7452,6 +9594,20 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT + post-payments-card-3d-secure-direct-200: + summary: Example response for request 'card-3d-secure-direct' + value: + additionalData: + cvcResult: 1 Matches + authCode: '074516' + avsResult: 4 AVS not supported for this card type + avsResultRaw: '4' + cvcResultRaw: M + refusalReasonRaw: AUTHORISED + acquirerCode: TestPmmAcquirer + acquirerReference: 8PQMP9SJ7DN + pspReference: 993617894903480A + resultCode: Authorised post-payments-card-3d-secure-securedfields: summary: Make a payment with 3D Secure 2 native authentication value: @@ -7484,21 +9640,20 @@ components: cvc: '737' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) + post-payments-card-securedfields-200: + summary: Example response for request 'card-securedfields' value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT + additionalData: + cvcResult: 1 Matches + authCode: 064649 + avsResult: 4 AVS not supported for this card type + avsResultRaw: '4' + cvcResultRaw: M + refusalReasonRaw: AUTHORISED + acquirerCode: TestPmmAcquirer + acquirerReference: 8PQMP9SM92L + pspReference: 993617894914488A + resultCode: Authorised post-payments-oneclick-direct: summary: Make a one-off payment with a token and CVV value: @@ -7513,48 +9668,7 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-oneclick-securedfields: - summary: Make a one-off payment with a token and CVV (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - recurringDetailReference: '8416038790273850' - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-result-basic: summary: Verify payment results value: payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK - post-payments-split: - summary: Split a payment between a sub-merchant and a platform account - value: - paymentMethod: - type: scheme - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' diff --git a/yaml/CheckoutService-v40.yaml b/yaml/CheckoutService-v40.yaml index 4286232..0c08371 100644 --- a/yaml/CheckoutService-v40.yaml +++ b/yaml/CheckoutService-v40.yaml @@ -81,13 +81,21 @@ paths: $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-basic-200' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -124,6 +132,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -150,13 +161,21 @@ paths: $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-cancel-basic-200' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -193,6 +212,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -223,13 +245,21 @@ paths: $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-originKeys-basic-200' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -266,6 +296,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -295,19 +328,30 @@ paths: $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/CreatePaymentLinkRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentLinks-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '201': content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResource' description: Created - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -344,6 +388,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -367,13 +414,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -410,6 +464,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -441,13 +498,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -484,6 +548,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -521,13 +588,25 @@ paths: $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentMethods-basic-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + filtered-200: + $ref: '#/components/examples/post-paymentMethods-filtered-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -564,6 +643,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -592,13 +674,21 @@ paths: $ref: '#/components/examples/post-paymentMethods-balance-basic' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + plastix-200: + $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -629,12 +719,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -661,10 +751,6 @@ paths: content: application/json: examples: - split: - $ref: '#/components/examples/post-paymentSession-split' - web: - $ref: '#/components/examples/post-paymentSession-web' android: $ref: '#/components/examples/post-paymentSession-android' ios: @@ -673,19 +759,26 @@ paths: $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick-200: + $ref: '#/components/examples/post-paymentSession-enableOneClick-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -701,9 +794,6 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -716,12 +806,12 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -743,38 +833,16 @@ paths: content: application/json: examples: - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' - giropay: - $ref: '#/components/examples/post-payments-giropay' - card-3d-secure-securedfields: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' - enableOneClick-raw: - $ref: '#/components/examples/post-payments-enableOneClick-raw' - applepay: - $ref: '#/components/examples/post-payments-applepay' - ideal: - $ref: '#/components/examples/post-payments-ideal' - oneclick-securedfields: - $ref: '#/components/examples/post-payments-oneclick-securedfields' - recurring: - $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - sofort: - $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' card-3d-secure-direct: $ref: '#/components/examples/post-payments-card-3d-secure-direct' klarna: $ref: '#/components/examples/post-payments-klarna' - split: - $ref: '#/components/examples/post-payments-split' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' schema: $ref: '#/components/schemas/PaymentRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -782,48 +850,39 @@ paths: schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -845,6 +904,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DetailsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -852,6 +913,9 @@ paths: schema: $ref: '#/components/schemas/PaymentDetailsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -879,6 +943,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -904,6 +971,8 @@ paths: $ref: '#/components/examples/post-payments-result-basic' schema: $ref: '#/components/schemas/PaymentVerificationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -911,6 +980,9 @@ paths: schema: $ref: '#/components/schemas/PaymentVerificationResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -941,12 +1013,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -3006,19 +3078,19 @@ components: type: string encryptedCardNumber: description: The encrypted card number. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryMonth: description: The encrypted card expiry month. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryYear: description: The encrypted card expiry year. - maxLength: 7000 + maxLength: 10000 type: string encryptedSecurityCode: description: The encrypted card verification code. - maxLength: 7000 + maxLength: 10000 type: string expiryMonth: description: The card expiry month. Only collect raw card data if you are @@ -3244,8 +3316,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -3463,53 +3541,20 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Success** \u2013 Indicates that the balance check was successful.\n\ + * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\ + \ have enough balance to pay the amount in the request, or that the currency\ + \ of the balance on the card did not match the currency of the requested\ + \ amount.\n* **Failed** \u2013 Indicates that the balance check failed." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success + - NotEnoughBalance + - Failed type: string required: - balance + - resultCode CheckoutCancelOrderRequest: properties: merchantAccount: @@ -3528,7 +3573,11 @@ components: description: A unique reference of the cancellation request. type: string resultCode: - description: The result of the cancellation request. + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Received** \u2013 Indicates the cancellation has successfully been\ + \ received by Adyen, and will be processed." + enum: + - Received type: string required: - pspReference @@ -3604,55 +3653,16 @@ components: description: The remaining amount in the order. $ref: '#/components/schemas/Amount' resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the order creation request.\n The value is always\ + \ **Success**." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success type: string required: - remainingAmount - expiresAt - orderData + - resultCode CheckoutOrder: properties: orderData: @@ -4889,6 +4899,10 @@ components: fraudResult: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' + merchantReference: + x-addedInVersion: 49 + description: The reference used during the /payments request. + type: string order: description: Contains updated information regarding the order in case order information was provided in the request. @@ -5517,8 +5531,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -6105,8 +6125,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -7373,11 +7399,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -7767,6 +7793,21 @@ components: BasicAuth: scheme: basic type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string examples: generic-400: summary: Response code 400. Bad request. @@ -7804,10 +7845,38 @@ components: message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' + get-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A patch-paymentLinks-linkId-basic: summary: Update the status of a payment link value: status: expired + patch-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: expired + url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -7816,6 +7885,17 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178914061985' + resultCode: Success + expiresAt: '2021-04-09T14:16:46Z' + orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== + reference: shopper-reference-ekvL83 + remainingAmount: + currency: EUR + value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -7823,6 +7903,11 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8816178914079738' + resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -7830,6 +7915,13 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com + post-originKeys-basic-200: + summary: Example response for request 'basic' + value: + originKeys: + https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw + https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc + https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -7856,6 +7948,15 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP + post-paymentLinks-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 1250 + expiresAt: '2021-04-09T14:17:31Z' + reference: shopper-reference-ekvL83 + url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -7873,10 +7974,1471 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix-200: + summary: Example response for request 'plastix' + value: + additionalData: + nonScheme.transactionLimit: '5000' + nonScheme.transactionLimitCcy: EUR + pspReference: 851617891188737F + resultCode: Success + balance: + currency: EUR + value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic-200: + summary: Example response for request 'basic' + value: + paymentMethods: + - details: + - details: + - key: ownerName + type: text + - key: bankLocationId + type: text + - key: bankAccountNumber + type: text + key: bankAccount + type: bankAccount + name: ACH Direct Debit + type: ach + - name: Adyen Voucher + type: adyen_test_voucher + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: Afterpay + type: afterpaytouch + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: AliPay + type: alipay + - name: AliPay HK + type: alipay_hk + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Credit Card via AsiaPay + type: asiapay + - name: China UnionPay + type: asiapay_unionpay + - name: Baby Gift Card + type: babygiftcard + - name: Baloto + type: baloto + - name: BancNet + type: bancnet + - name: Bank Transfer (BG) + type: bankTransfer_BG + - name: Bank Transfer (CH) + type: bankTransfer_CH + - name: Bank Transfer (DE) + type: bankTransfer_DE + - name: Bank Transfer (FI) + type: bankTransfer_FI + - name: Bank Transfer (GB) + type: bankTransfer_GB + - name: Bank Transfer (HU) + type: bankTransfer_HU + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bank Transfer (IE) + type: bankTransfer_IE + - name: Electronic Bank Transfer (MX) + type: bankTransfer_MX_linked + - name: Bank Transfer (MX) + type: bankTransfer_MX_offline + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Bank Transfer (PL) + type: bankTransfer_PL + - name: Bank Transfer (SE) + type: bankTransfer_SE + - name: Bank Transfer (US) + type: bankTransfer_US + - name: Payconiq by Bancontact + type: bcmc_mobile + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: 99Bill + type: bill99 + - details: + - items: + - id: AUB_DIRECT + name: AU Small Finance Bank + - id: ALB_DIRECT + name: 'Allahabad Bank ' + - id: APG_DIRECT + name: Andhra Pragathi Grameena Bank + - id: BDN_DIRECT + name: Bandhan bank + - id: BBK_DIRECT + name: Bank of Bahrain and Kuwait + - id: BBR_DIRECT + name: Bank of Baroda - Retail Banking + - id: BCB_DIRECT + name: 'Bassien Catholic Co-Operative Bank ' + - id: CNB_DIRECT + name: Canara Bank + - id: SYD_DIRECT + name: Canara Bank (e-Syndicate) + - id: CSB_DIRECT + name: Catholic Syrian Bank + - id: CBI_DIRECT + name: Central Bank of India + - id: CUB_DIRECT + name: City Union Bank + - id: COB_DIRECT + name: Cosmos Bank + - id: DEN_DIRECT + name: Dena Bank + - id: DBK_DIRECT + name: Deutsche Bank + - id: DCB_DIRECT + name: Development Credit Bank + - id: DLB_DIRECT + name: Dhanlakshmi Bank - Retail Net Banking + - id: ESF_DIRECT + name: ESAF Small Finance Bank + - id: EQB_DIRECT + name: Equitas Small Finance Bank + - id: FBK_DIRECT + name: Federal Bank + - id: FNC_DIRECT + name: Fincare Bank + - id: HDF_DIRECT + name: HDFC Bank + - id: ICI_DIRECT + name: 'ICICI Bank ' + - id: IDB_DIRECT + name: IDBI Bank - Retail Net Banking + - id: IDN_DIRECT + name: IDFC FIRST Bank + - id: INB_DIRECT + name: Indian Bank + - id: IOB_DIRECT + name: Indian Overseas Bank + - id: IDS_DIRECT + name: IndusInd Bank + - id: JKB_DIRECT + name: Jammu & Kashmir Bank + - id: JNB_DIRECT + name: Jana Small Finance Bank + - id: JSB_DIRECT + name: Janata Sahakari Bank Ltd Pune + - id: KJB_DIRECT + name: Kalyan Janata Sahakari Bank + - id: KBL_DIRECT + name: Karnataka Bank Ltd + - id: KVB_DIRECT + name: Karur Vysya Bank + - id: 162_DIRECT + name: Kotak Bank + - id: LVR_DIRECT + name: Laxmi Vilas Bank - Retail + - id: NKB_DIRECT + name: NKGSB Co-op Bank + - id: NEB_DIRECT + name: North East Small Finance Bank + - id: OBC_DIRECT + name: PNB (Erstwhile-Oriental Bank of Commerce) + - id: UNI_DIRECT + name: PNB (Erstwhile-United Bank of India) + - id: PMC_DIRECT + name: Punjab & Maharastra Co-op Bank + - id: PSB_DIRECT + name: Punjab & Sind Bank + - id: CPN_DIRECT + name: 'Punjab National Bank - Corporate ' + - id: PNB_DIRECT + name: Punjab National Bank - Retail Banking + - id: RBL_DIRECT + name: RBL Bank Limited + - id: SWB_DIRECT + name: Saraswat Bank + - id: SHB_DIRECT + name: Shivalik Mercantile Cooperative Bank Ltd + - id: SIB_DIRECT + name: South Indian Bank + - id: SCB_DIRECT + name: Standard Chartered Bank + - id: SBI_DIRECT + name: State Bank of India + - id: SRB_DIRECT + name: Suryoday Small Finance Bank + - id: TJB_DIRECT + name: TJSB Bank + - id: TNC_DIRECT + name: Tamil Nadu State Co-operative Bank + - id: TMB_DIRECT + name: Tamilnad Mercantile Bank Ltd + - id: TBB_DIRECT + name: Thane Bharat Sahakari Bank Ltd + - id: MSB_DIRECT + name: The Mehsana Urban Co Op Bank Ltd + - id: UCO_DIRECT + name: UCO Bank + - id: UBI_DIRECT + name: Union Bank of India + - id: ADB_DIRECT + name: Union Bank of India (Erstwhile Andhra Bank) + - id: CRP_DIRECT + name: Union Bank of India (Erstwhile Corporation Bank) + - id: VRB_DIRECT + name: Varachha Co-operative Bank Limited + - id: VJB_DIRECT + name: Vijaya Bank + - id: YBK_DIRECT + name: Yes Bank + - id: ZOB_DIRECT + name: Zoroastrian Co-operative Bank Limited + - id: DBS_DIRECT + name: digibank by DBS + key: issuer + type: select + name: Online Banking India + type: billdesk_online + - name: UPI + type: billdesk_upi + - details: + - items: + - id: DCW_DIRECT + name: DCB Cippy + - id: ICC_DIRECT + name: ICC Cash Card + - id: OXY_DIRECT + name: Oxigen Wallet + - id: PCH_DIRECT + name: Pay World Money + key: issuer + type: select + name: Wallets India + type: billdesk_wallet + - name: Blik + type: blik + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Boleto + type: boleto + - name: Boleto Bancario + type: boletobancario_santander + - name: Bradesco + type: bradesco + - name: Cash-Ticket + type: cashticket + - name: CashU + type: cashu + - name: CCAvenue + type: ccavenue + - name: Mula Checkout + type: cellulant + - name: Chasin Giftcard + type: chasingiftcard + - name: Clearpay + type: clearpay + - name: ClickandBuy + type: clickandbuy + - name: Paiement en 3 fois par Cartes Bancaires + type: cofinoga_3xcb + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: DANA + type: dana + - name: DineroMail + type: dineromail + - name: Online bank transfer. + type: directEbanking + - name: Direct Debit Brazil - Banco do Brazil + type: directdebit_BR_bancodobrasil + - name: Direct Debit Brazil - Bradesco + type: directdebit_BR_bradesco + - name: Direct Debit Brazil - Caixa Economica Federal + type: directdebit_BR_caixa + - name: Direct Debit Brazil - HSBC + type: directdebit_BR_hsbc + - name: Direct Debit Brazil - Itau + type: directdebit_BR_itau + - name: Direct Debit Brazil - Santander + type: directdebit_BR_santander + - name: BACS Direct Debit + type: directdebit_GB + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Alfamart + type: doku_alfamart + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BCA Bank Transfer + type: doku_bca_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BNI VA + type: doku_bni_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BRI VA + type: doku_bri_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: CIMB VA + type: doku_cimb_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Danamon VA + type: doku_danamon_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Indomaret + type: doku_indomaret + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Mandiri VA + type: doku_mandiri_va + - details: + - key: ovoId + type: text + name: OVO + type: doku_ovo + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Bank Transfer + type: doku_permata_lite_atm + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: DOKU wallet + type: doku_wallet + - details: + - items: + - id: '66' + name: Bank Nowy BFG S.A. + - id: '92' + name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" + - id: '11' + name: Bank transfer / postal + - id: '74' + name: "Banki Sp\xF3\u0142dzielcze" + - id: '73' + name: BLIK + - id: '90' + name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" + - id: '59' + name: CinkciarzPAY + - id: '87' + name: Credit Agricole PBL + - id: '83' + name: EnveloBank + - id: '76' + name: Getin Bank PBL + - id: '81' + name: Idea Cloud + - id: '7' + name: ING Corporate customers + - id: '93' + name: Kasa Stefczyka + - id: '44' + name: "Millennium - P\u0142atno\u015Bci Internetowe" + - id: '10' + name: Millennium Corporate customers + - id: '68' + name: mRaty + - id: '1' + name: mTransfer + - id: '91' + name: Nest Bank + - id: '80' + name: Noble Pay + - id: '50' + name: Pay Way Toyota Bank + - id: '45' + name: Pay with Alior Bank + - id: '36' + name: Pekao24Przelew + - id: '70' + name: Pocztowy24 + - id: '6' + name: Przelew24 + - id: '46' + name: "P\u0142ac\u0119 z Citi Handlowy" + - id: '38' + name: "P\u0142ac\u0119 z ING" + - id: '2' + name: "P\u0142ac\u0119 z Inteligo" + - id: '4' + name: "P\u0142ac\u0119 z iPKO" + - id: '75' + name: "P\u0142ac\u0119 z Plus Bank" + - id: '51' + name: "P\u0142a\u0107 z BO\u015A" + - id: '55' + name: Raty z Alior Bankiem PLN + - id: '89' + name: Santander + - id: '52' + name: SkyCash + key: issuer + type: select + name: Local Polish Payment Methods + type: dotpay + - name: Dragonpay Prepaid Credits + type: dragonpay_credits + - name: Online Banking + type: dragonpay_ebanking + - name: GCash + type: dragonpay_gcash + - name: Over The Counter Banks + type: dragonpay_otc_banking + - name: OTC non-Bank via Dragonpay + type: dragonpay_otc_non_banking + - name: Convenience Stores + type: dragonpay_otc_philippines + - name: 7/11 + type: dragonpay_seveneleven + - name: eagleeye_voucher + type: eagleeye_voucher + - name: Finnish E-Banking + type: ebanking_FI + - name: Pay-easy ATM + type: econtext_atm + - name: Online Banking + type: econtext_online + - name: 7-Eleven + type: econtext_seven_eleven + - name: Convenience Stores + type: econtext_stores + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Lastschrift (ELV) + type: elv + - details: + - items: + - id: '231' + name: POP Pankki + - id: '551' + name: "Komer\u010Dn\xED banka" + - id: '232' + name: Aktia + - id: '552' + name: Raiffeisen + - id: '233' + name: "S\xE4\xE4st\xF6pankki" + - id: '750' + name: Swedbank + - id: '211' + name: Nordea + - id: '553' + name: "\u010CSOB" + - id: '234' + name: S-Pankki + - id: '751' + name: SEB + - id: '554' + name: Moneta + - id: '235' + name: OmaSP + - id: '752' + name: Nordea + - id: '213' + name: Op-Pohjola + - id: '555' + name: UniCredit + - id: '753' + name: LHV + - id: '556' + name: Fio + - id: '557' + name: mBank + - id: '216' + name: Handelsbanken + - id: '558' + name: Air Bank + - id: '260' + name: "L\xE4nsf\xF6rs\xE4kringar" + - id: '240' + name: BankDeposit + - id: '265' + name: Sparbanken + - id: '640' + name: BankDeposit + - id: '200' + name: "\xC5landsbanken" + - id: '940' + name: Swedbank + - id: '500' + name: "\u010Cesk\xE1 spo\u0159itelna" + - id: '720' + name: Swedbank + - id: '941' + name: SEB + - id: '204' + name: Danske Bank + - id: '721' + name: SEB + - id: '942' + name: Citadele + - id: '205' + name: Handelsbanken + - id: '722' + name: DNB + - id: '943' + name: DNB + - id: '206' + name: Nordea + - id: '723' + name: "\u0160iauli\u0173 bankas" + - id: '207' + name: SEB + - id: '724' + name: Nordea + - id: '505' + name: "Komer\u010Dn\xED banka" + - id: '208' + name: Skandiabanken + - id: '209' + name: Swedbank + key: issuer + type: select + name: Bank Payment + type: entercash + - name: Nationale Entertainment Card + type: entertainmentcard + - details: + - items: + - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 + name: Dolomitenbank + - id: ee9fc487-ebe0-486c-8101-17dce5141a67 + name: Raiffeissen Bankengruppe + - id: 6765e225-a0dc-4481-9666-e26303d4f221 + name: Hypo Tirol Bank AG + - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc + name: Sparda Bank Wien + - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f + name: Schoellerbank AG + - id: e2e97aaa-de4c-4e18-9431-d99790773433 + name: Volksbank Gruppe + - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 + name: Immo-Bank + - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 + name: Bank Austria + - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 + name: Easybank AG + - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a + name: VR-BankBraunau + - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 + name: Volkskreditbank + - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 + name: Erste Bank und Sparkassen + - id: ba7199cc-f057-42f2-9856-2378abf21638 + name: BAWAG P.S.K. Gruppe + key: issuer + type: select + name: EPS + type: eps + - name: Expert Cadeaukaart + type: expertgiftcard + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 3x Oney + type: facilypay_3x + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 4x Oney + type: facilypay_4x + - name: Fashioncheque + type: fashioncheque + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: Fawry + type: fawry + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Fonq Giftcard + type: fonqgiftcard + - name: Gall & Gall + type: gallgall + - name: GCash + type: gcash + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - details: + - key: bic + type: text + name: GiroPay + type: giropay + - name: Givex + type: givex + - name: Globe GCash + type: globegcash + - name: Goldsmiths Card + type: goldsmithscard + - name: GoPay Wallet + type: gopay_wallet + - name: OVO + type: grabpay_ID + - name: GrabPay + type: grabpay_PH + - name: GrabPay + type: grabpay_SG + - name: Hallmark Card + type: hallmarkcard + - name: HDFC + type: hdfc + - name: Hunkemoller Member Card + type: hmclub + - name: Hunkemoller Lingerie Card + type: hmlingerie + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - name: igive + type: igive + - name: Korean Account Transfer (IniPay) + type: inicisIniPay_accounttransfer + - name: Korean Credit Cards (IniPay) + type: inicisIniPay_creditcard + - name: Korean Mobile Phone (IniPay) + type: inicisIniPay_mobilephone + - name: Korean Virtual Account (IniPay) + type: inicisIniPay_virtualaccount + - name: Korean Account Transfer (Mobile) + type: inicisMobile_accounttransfer + - name: Korean Credit Cards (Mobile) + type: inicisMobile_creditcard + - name: Korean Mobile Phone (Mobile) + type: inicisMobile_mobilephone + - name: Korean Virtual Account (Mobile) + type: inicisMobile_virtualaccount + - name: Korean Credit Cards + type: inicis_creditcard + - name: "Interac\xAE Online" + type: interac + - name: Instant EFT + type: ipay + - name: iPay88 + type: ipay88 + - name: isracard + type: isracard + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: KakaoPay + type: kakaopay + - name: Karen Millen Card + type: karenmillen + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Bank Transfer + type: kcp_banktransfer + - name: "Korea\u2013issued cards" + type: kcp_creditcard + - name: PayCo + type: kcp_payco + - name: Virtual Account via KCP + type: kcp_va + - name: Pay later with Klarna. + type: klarna + - name: Pay over time with Klarna. + type: klarna_account + - name: Klarna B2B + type: klarna_b2b + - name: Pay now with Klarna. + type: klarna_paynow + - name: Leisure Card + type: leisurecard + - name: China Credit Card + type: lianlianpay_creditcard + - name: China Debit Card + type: lianlianpay_debitcard + - details: + - key: telephoneNumber + type: tel + name: China Online Banking - Credit Card + type: lianlianpay_ebanking_credit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '4031000' + name: Bank of Beijing + - id: '01040000' + name: Bank of China + - id: '03020000' + name: China Citic Bank + - id: '01050000' + name: China Construction Bank + - id: '03030000' + name: China Everbright Bank + - id: 03080000 + name: China Merchants Bank + - id: '03050000' + name: China Minsheng Banking Group + - id: '03040000' + name: Hua Xia Bank Co + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03070000' + name: PingAn Bank + - id: '1000000' + name: Postal Savings Bank of China + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Debit Card + type: lianlianpay_ebanking_debit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '01050000' + name: China Construction Bank + - id: 03080000 + name: China Merchants Bank + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03100000' + name: Shanghai Pudong Development Bank + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Enterprise + type: lianlianpay_ebanking_enterprise + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - name: Love2Shop GiftCard + type: love2shop + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: mada + type: mada + - name: Mappin & Webb Card + type: mappinwebbcard + - name: MB WAY + type: mbway + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: Mercado Pago + type: mercadopago + - name: MobilePay + type: mobilepay + - name: AliPay via Razer Merchant Services + type: molpay_alipay + - name: 7-Eleven + type: molpay_cash + - name: CIMB Virtual Account + type: molpay_cimb_va + - name: Malaysia E-Banking via Razer Merchant Services + type: molpay_ebanking_MY + - details: + - items: + - id: vtcpay-vietinbank + name: Vietinbank + - id: vtcpay-bidv + name: BIDV + - id: vtcpay-agribank + name: Agribank + - id: vtcpay-mb + name: MB Bank + - id: vtcpay-sacombank + name: Sacombank + - id: vtcpay-dongabank + name: DongABank + - id: vtcpay-maritimebank + name: MaritimeBank + - id: vtcpay-vietcombank + name: Vietcombank + - id: vtcpay-acb + name: ACB + - id: vtcpay-techcombank + name: Techcombank + key: issuer + type: select + name: Vietnam E-Banking + type: molpay_ebanking_VN + - details: + - items: + - id: fpx_bimb + name: Bank Islam + - id: fpx_uob + name: UOB Bank + - id: fpx_cimbclicks + name: CIMB Clicks + - id: fpx_kfh + name: Kuwait Finance House + - id: fpx_rhb + name: RHB Now + - id: fpx_abmb + name: Alliance Bank + - id: fpx_amb + name: Am Online + - id: fpx_hsbc + name: HSBC + - id: fpx_abb + name: Affin Bank + - id: fpx_ocbc + name: OCBC Bank + - id: fpx_pbb + name: Public Bank + - id: fpx_scb + name: Standard Chartered Bank + - id: fpx_bsn + name: Bank Simpanan Nasional + - id: fpx_mb2u + name: Maybank2u + - id: fpx_hlb + name: Hong Leong Connect + - id: fpx_bmmb + name: Bank Muamalat + - id: fpx_bkrm + name: Bank Rakyat + key: issuer + type: select + name: Malaysia E-Banking + type: molpay_ebanking_fpx_MY + - name: eNETS Debit + type: molpay_enetsd + - name: epay + type: molpay_epay + - name: Esapay + type: molpay_esapay + - name: MyClear FPX + type: molpay_fpx + - name: Maybank2u + type: molpay_maybank2u + - name: Nganluong + type: molpay_nganluong + - name: Tesco Lotus + type: molpay_paysbuy + - name: MOLPoints + type: molpay_points + - name: RHB Now + type: molpay_rhb + - name: SAM by SingPost + type: molpay_singpost + - name: MOLWallet + type: molpay_wallet + - name: MoMo ATM + type: momo_atm + - name: Momo Wallet + type: momo_wallet + - name: Moneybookers + type: moneybookers + - name: Multibanco + type: multibanco + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: BankAxess + type: netaxept_bankaxess + - name: NETELLER + type: neteller + - name: Onebip + type: onebip + - name: One Two Three + type: onetwothree + - name: Local Polish Payment Methods + type: onlineBanking_PL + - details: + - items: + - id: '1' + name: Model Bank v2 + key: issuer + type: select + name: Online banking + type: openbanking_UK + - name: Oxxo + type: oxxo + - name: Pathe Giftcard + type: pathegiftcard + - name: PayBright + type: paybright + - name: PayMaya Wallet + type: paymaya_wallet + - name: PayPal + type: paypal + - name: Paysafecard + type: paysafecard + - name: Payshop + type: payshop + - name: PayD AMT via Paythru + type: paythru_amt + - name: EFT via Paythru + type: paythru_eft + - name: PayTM + type: paytm + - details: + - key: virtualPaymentAddress + type: text + name: PayU UPI + type: payu_IN_upi + - name: EFT Pro via PayU + type: payu_ZA_eftpro + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: pix + type: pix + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Podium Card + type: podiumcard + - name: POLi + type: poli + - name: PPS + type: pps + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Illicado Gift Card + type: prosodie_illicado + - name: PSE + type: pse + - details: + - items: + - id: '+7' + name: RU + - id: '+9955' + name: GE + - id: '+507' + name: PA + - id: '+44' + name: GB + - id: '+992' + name: TJ + - id: '+370' + name: LT + - id: '+972' + name: IL + - id: '+996' + name: KG + - id: '+380' + name: UA + - id: '+84' + name: VN + - id: '+90' + name: TR + - id: '+994' + name: AZ + - id: '+374' + name: AM + - id: '+371' + name: LV + - id: '+91' + name: IN + - id: '+66' + name: TH + - id: '+373' + name: MD + - id: '+1' + name: US + - id: '+81' + name: JP + - id: '+998' + name: UZ + - id: '+77' + name: KZ + - id: '+375' + name: BY + - id: '+372' + name: EE + - id: '+40' + name: RO + - id: '+82' + name: KR + key: qiwiwallet.telephoneNumberPrefix + type: select + - key: qiwiwallet.telephoneNumber + type: text + name: Qiwi Wallet + type: qiwiwallet + - name: RatePay Invoice + type: ratepay + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: SafetyPay + type: safetypay + - name: SafetyPay Cash + type: safetypay_cash + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: SEB Direktbetalning + type: sebdirectpayment + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: 7-Eleven + type: seveneleven + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: Swish + type: swish + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: TenPay + type: tenpay + - name: The Sting Giftcard + type: thestinggiftcard + - name: Trustly + type: trustly + - name: Online Banking by Trustpay + type: trustpay + - name: TWINT + type: twint + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - details: + - key: virtualPaymentAddress + type: text + name: UPI Collect + type: upi_collect + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: telephoneNumber + optional: true + type: tel + name: Vipps + type: vipps + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: VVV Giftcard + type: vvvgiftcard + - name: Webshop Giftcard + type: webshopgiftcard + - name: WeChat Pay + type: wechatpayMiniProgram + - name: WeChat Pay + type: wechatpayQR + - name: WeChat Pay + type: wechatpayWeb + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: WOS Card + type: woscard + - name: Alfa-Click + type: yandex_alfaclick + - name: Pay using bank card + type: yandex_bank_card + - name: Cash terminals + type: yandex_cash + - name: Pay using installments + type: yandex_installments + - name: YooMoney + type: yandex_money + - name: Promsvyazbank + type: yandex_promsvyazbank + - name: Sberbank Online + type: yandex_sberbank + - name: WebMoney + type: yandex_webmoney + - name: Your Gift + type: yourgift + - name: Zip + type: zip post-paymentMethods-filtered: summary: Get payment methods based on the country and amount value: @@ -7886,6 +9448,313 @@ components: amount: currency: EUR value: 1000 + post-paymentMethods-filtered-200: + summary: Example response for request 'filtered' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentMethods-include-oneclick: summary: Get payment methods including stored card details value: @@ -7895,6 +9764,313 @@ components: currency: EUR value: 1000 shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-paymentMethods-include-oneclick-200: + summary: Example response for request 'include-oneclick' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -7928,6 +10104,10 @@ components: shopperLocale: nl_NL merchantAccount: YOUR_MERCHANT_ACCOUNT sdkVersion: 1.7.0 + post-paymentSession-enableOneClick-200: + summary: Example response for request 'enableOneClick' + value: + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-paymentSession-ios: summary: Set up a payment session (iOS) value: @@ -7943,62 +10123,10 @@ components: shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-split: - summary: Split a payment between a sub-merchant and a platform account + post-paymentSession-web-200: + summary: Example response for request 'web' value: - amount: - currency: EUR - value: 6200 - additionalData: - split.api: '1' - split.nrOfItems: '2' - split.totalAmount: '6200' - split.currencyCode: EUR - split.item1.amount: '6000' - split.item1.type: MarketPlace - split.item1.account: '151272963' - split.item1.reference: '6124145' - split.item1.description: 'Porcelain Doll: Eliza (20cm)' - split.item2.amount: '200' - split.item2.type: Commission - split.item2.reference: '6124146' - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Android - token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK - returnUrl: app:// - countryCode: NL - shopperLocale: nl_NL - sessionValidity: '2017-04-06T13:09:13Z' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.3.0 - post-payments-applepay: - summary: Make an Apple Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: applepay - applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication value: @@ -8019,115 +10147,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields: - summary: Make a payment with 3D Secure 2 native authentication - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4212345678901237 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - holderName: John Smith - browserInfo: - userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 - Firefox/3.0 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct: - summary: Make a card payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedExpiryMonth: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedExpiryYear: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - storeDetails: true - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw: - summary: Tokenize card details for one-off payments - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - storeDetails: true - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay: - summary: Make a giropay payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: giropay - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-ideal: - summary: Make an iDEAL payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: ideal - issuer: '1121' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-klarna: summary: Make a Klarna payment value: @@ -8193,72 +10212,7 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-oneclick-securedfields: - summary: Make a one-off payment with a token and CVV (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - recurringDetailReference: '8416038790273850' - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-recurring: - summary: Make a card payment with a token - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - recurringDetailReference: '8315791039321763' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth post-payments-result-basic: summary: Verify payment results value: payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK - post-payments-sofort: - summary: Make a Sofort payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: directEbanking - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-split: - summary: Split a payment between a sub-merchant and a platform account - value: - paymentMethod: - type: scheme - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' diff --git a/yaml/CheckoutService-v41.yaml b/yaml/CheckoutService-v41.yaml index 3302c2c..7c37d8a 100644 --- a/yaml/CheckoutService-v41.yaml +++ b/yaml/CheckoutService-v41.yaml @@ -81,13 +81,21 @@ paths: $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-basic-200' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -124,6 +132,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -150,13 +161,21 @@ paths: $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-cancel-basic-200' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -193,6 +212,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -223,13 +245,21 @@ paths: $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-originKeys-basic-200' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -266,6 +296,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -295,19 +328,30 @@ paths: $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/CreatePaymentLinkRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentLinks-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '201': content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResource' description: Created - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -344,6 +388,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -367,13 +414,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -410,6 +464,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -441,13 +498,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -484,6 +548,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -521,13 +588,25 @@ paths: $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentMethods-basic-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + filtered-200: + $ref: '#/components/examples/post-paymentMethods-filtered-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -564,6 +643,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -592,13 +674,21 @@ paths: $ref: '#/components/examples/post-paymentMethods-balance-basic' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + plastix-200: + $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -629,12 +719,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -661,10 +751,6 @@ paths: content: application/json: examples: - split: - $ref: '#/components/examples/post-paymentSession-split' - web: - $ref: '#/components/examples/post-paymentSession-web' android: $ref: '#/components/examples/post-paymentSession-android' ios: @@ -673,19 +759,26 @@ paths: $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick-200: + $ref: '#/components/examples/post-paymentSession-enableOneClick-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -701,9 +794,6 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -716,12 +806,12 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -743,42 +833,18 @@ paths: content: application/json: examples: - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' - giropay: - $ref: '#/components/examples/post-payments-giropay' - card-3d-secure-securedfields: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' - enableOneClick-raw: - $ref: '#/components/examples/post-payments-enableOneClick-raw' - applepay: - $ref: '#/components/examples/post-payments-applepay' - ideal: - $ref: '#/components/examples/post-payments-ideal' - oneclick-securedfields: - $ref: '#/components/examples/post-payments-oneclick-securedfields' - recurring: - $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' - sofort: - $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' card-3d-secure-direct: $ref: '#/components/examples/post-payments-card-3d-secure-direct' klarna: $ref: '#/components/examples/post-payments-klarna' - split: - $ref: '#/components/examples/post-payments-split' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' schema: $ref: '#/components/schemas/PaymentRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -786,48 +852,39 @@ paths: schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -849,6 +906,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DetailsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -856,6 +915,9 @@ paths: schema: $ref: '#/components/schemas/PaymentDetailsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -883,6 +945,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -908,6 +973,8 @@ paths: $ref: '#/components/examples/post-payments-result-basic' schema: $ref: '#/components/schemas/PaymentVerificationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -915,6 +982,9 @@ paths: schema: $ref: '#/components/schemas/PaymentVerificationResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -945,12 +1015,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -3010,19 +3080,19 @@ components: type: string encryptedCardNumber: description: The encrypted card number. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryMonth: description: The encrypted card expiry month. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryYear: description: The encrypted card expiry year. - maxLength: 7000 + maxLength: 10000 type: string encryptedSecurityCode: description: The encrypted card verification code. - maxLength: 7000 + maxLength: 10000 type: string expiryMonth: description: The card expiry month. Only collect raw card data if you are @@ -3248,8 +3318,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -3467,53 +3543,20 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Success** \u2013 Indicates that the balance check was successful.\n\ + * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\ + \ have enough balance to pay the amount in the request, or that the currency\ + \ of the balance on the card did not match the currency of the requested\ + \ amount.\n* **Failed** \u2013 Indicates that the balance check failed." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success + - NotEnoughBalance + - Failed type: string required: - balance + - resultCode CheckoutCancelOrderRequest: properties: merchantAccount: @@ -3532,7 +3575,11 @@ components: description: A unique reference of the cancellation request. type: string resultCode: - description: The result of the cancellation request. + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Received** \u2013 Indicates the cancellation has successfully been\ + \ received by Adyen, and will be processed." + enum: + - Received type: string required: - pspReference @@ -3608,55 +3655,16 @@ components: description: The remaining amount in the order. $ref: '#/components/schemas/Amount' resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the order creation request.\n The value is always\ + \ **Success**." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success type: string required: - remainingAmount - expiresAt - orderData + - resultCode CheckoutOrder: properties: orderData: @@ -4893,6 +4901,10 @@ components: fraudResult: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' + merchantReference: + x-addedInVersion: 49 + description: The reference used during the /payments request. + type: string order: description: Contains updated information regarding the order in case order information was provided in the request. @@ -5525,8 +5537,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -6117,8 +6135,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -7385,11 +7409,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -7805,6 +7829,21 @@ components: BasicAuth: scheme: basic type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string examples: generic-400: summary: Response code 400. Bad request. @@ -7842,10 +7881,38 @@ components: message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' + get-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A patch-paymentLinks-linkId-basic: summary: Update the status of a payment link value: status: expired + patch-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: expired + url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -7854,6 +7921,17 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178914061985' + resultCode: Success + expiresAt: '2021-04-09T14:16:46Z' + orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== + reference: shopper-reference-ekvL83 + remainingAmount: + currency: EUR + value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -7861,6 +7939,11 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8816178914079738' + resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -7868,6 +7951,13 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com + post-originKeys-basic-200: + summary: Example response for request 'basic' + value: + originKeys: + https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw + https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc + https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -7894,6 +7984,15 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP + post-paymentLinks-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 1250 + expiresAt: '2021-04-09T14:17:31Z' + reference: shopper-reference-ekvL83 + url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -7911,10 +8010,1471 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix-200: + summary: Example response for request 'plastix' + value: + additionalData: + nonScheme.transactionLimit: '5000' + nonScheme.transactionLimitCcy: EUR + pspReference: 851617891188737F + resultCode: Success + balance: + currency: EUR + value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic-200: + summary: Example response for request 'basic' + value: + paymentMethods: + - details: + - details: + - key: ownerName + type: text + - key: bankLocationId + type: text + - key: bankAccountNumber + type: text + key: bankAccount + type: bankAccount + name: ACH Direct Debit + type: ach + - name: Adyen Voucher + type: adyen_test_voucher + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: Afterpay + type: afterpaytouch + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: AliPay + type: alipay + - name: AliPay HK + type: alipay_hk + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Credit Card via AsiaPay + type: asiapay + - name: China UnionPay + type: asiapay_unionpay + - name: Baby Gift Card + type: babygiftcard + - name: Baloto + type: baloto + - name: BancNet + type: bancnet + - name: Bank Transfer (BG) + type: bankTransfer_BG + - name: Bank Transfer (CH) + type: bankTransfer_CH + - name: Bank Transfer (DE) + type: bankTransfer_DE + - name: Bank Transfer (FI) + type: bankTransfer_FI + - name: Bank Transfer (GB) + type: bankTransfer_GB + - name: Bank Transfer (HU) + type: bankTransfer_HU + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bank Transfer (IE) + type: bankTransfer_IE + - name: Electronic Bank Transfer (MX) + type: bankTransfer_MX_linked + - name: Bank Transfer (MX) + type: bankTransfer_MX_offline + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Bank Transfer (PL) + type: bankTransfer_PL + - name: Bank Transfer (SE) + type: bankTransfer_SE + - name: Bank Transfer (US) + type: bankTransfer_US + - name: Payconiq by Bancontact + type: bcmc_mobile + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: 99Bill + type: bill99 + - details: + - items: + - id: AUB_DIRECT + name: AU Small Finance Bank + - id: ALB_DIRECT + name: 'Allahabad Bank ' + - id: APG_DIRECT + name: Andhra Pragathi Grameena Bank + - id: BDN_DIRECT + name: Bandhan bank + - id: BBK_DIRECT + name: Bank of Bahrain and Kuwait + - id: BBR_DIRECT + name: Bank of Baroda - Retail Banking + - id: BCB_DIRECT + name: 'Bassien Catholic Co-Operative Bank ' + - id: CNB_DIRECT + name: Canara Bank + - id: SYD_DIRECT + name: Canara Bank (e-Syndicate) + - id: CSB_DIRECT + name: Catholic Syrian Bank + - id: CBI_DIRECT + name: Central Bank of India + - id: CUB_DIRECT + name: City Union Bank + - id: COB_DIRECT + name: Cosmos Bank + - id: DEN_DIRECT + name: Dena Bank + - id: DBK_DIRECT + name: Deutsche Bank + - id: DCB_DIRECT + name: Development Credit Bank + - id: DLB_DIRECT + name: Dhanlakshmi Bank - Retail Net Banking + - id: ESF_DIRECT + name: ESAF Small Finance Bank + - id: EQB_DIRECT + name: Equitas Small Finance Bank + - id: FBK_DIRECT + name: Federal Bank + - id: FNC_DIRECT + name: Fincare Bank + - id: HDF_DIRECT + name: HDFC Bank + - id: ICI_DIRECT + name: 'ICICI Bank ' + - id: IDB_DIRECT + name: IDBI Bank - Retail Net Banking + - id: IDN_DIRECT + name: IDFC FIRST Bank + - id: INB_DIRECT + name: Indian Bank + - id: IOB_DIRECT + name: Indian Overseas Bank + - id: IDS_DIRECT + name: IndusInd Bank + - id: JKB_DIRECT + name: Jammu & Kashmir Bank + - id: JNB_DIRECT + name: Jana Small Finance Bank + - id: JSB_DIRECT + name: Janata Sahakari Bank Ltd Pune + - id: KJB_DIRECT + name: Kalyan Janata Sahakari Bank + - id: KBL_DIRECT + name: Karnataka Bank Ltd + - id: KVB_DIRECT + name: Karur Vysya Bank + - id: 162_DIRECT + name: Kotak Bank + - id: LVR_DIRECT + name: Laxmi Vilas Bank - Retail + - id: NKB_DIRECT + name: NKGSB Co-op Bank + - id: NEB_DIRECT + name: North East Small Finance Bank + - id: OBC_DIRECT + name: PNB (Erstwhile-Oriental Bank of Commerce) + - id: UNI_DIRECT + name: PNB (Erstwhile-United Bank of India) + - id: PMC_DIRECT + name: Punjab & Maharastra Co-op Bank + - id: PSB_DIRECT + name: Punjab & Sind Bank + - id: CPN_DIRECT + name: 'Punjab National Bank - Corporate ' + - id: PNB_DIRECT + name: Punjab National Bank - Retail Banking + - id: RBL_DIRECT + name: RBL Bank Limited + - id: SWB_DIRECT + name: Saraswat Bank + - id: SHB_DIRECT + name: Shivalik Mercantile Cooperative Bank Ltd + - id: SIB_DIRECT + name: South Indian Bank + - id: SCB_DIRECT + name: Standard Chartered Bank + - id: SBI_DIRECT + name: State Bank of India + - id: SRB_DIRECT + name: Suryoday Small Finance Bank + - id: TJB_DIRECT + name: TJSB Bank + - id: TNC_DIRECT + name: Tamil Nadu State Co-operative Bank + - id: TMB_DIRECT + name: Tamilnad Mercantile Bank Ltd + - id: TBB_DIRECT + name: Thane Bharat Sahakari Bank Ltd + - id: MSB_DIRECT + name: The Mehsana Urban Co Op Bank Ltd + - id: UCO_DIRECT + name: UCO Bank + - id: UBI_DIRECT + name: Union Bank of India + - id: ADB_DIRECT + name: Union Bank of India (Erstwhile Andhra Bank) + - id: CRP_DIRECT + name: Union Bank of India (Erstwhile Corporation Bank) + - id: VRB_DIRECT + name: Varachha Co-operative Bank Limited + - id: VJB_DIRECT + name: Vijaya Bank + - id: YBK_DIRECT + name: Yes Bank + - id: ZOB_DIRECT + name: Zoroastrian Co-operative Bank Limited + - id: DBS_DIRECT + name: digibank by DBS + key: issuer + type: select + name: Online Banking India + type: billdesk_online + - name: UPI + type: billdesk_upi + - details: + - items: + - id: DCW_DIRECT + name: DCB Cippy + - id: ICC_DIRECT + name: ICC Cash Card + - id: OXY_DIRECT + name: Oxigen Wallet + - id: PCH_DIRECT + name: Pay World Money + key: issuer + type: select + name: Wallets India + type: billdesk_wallet + - name: Blik + type: blik + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Boleto + type: boleto + - name: Boleto Bancario + type: boletobancario_santander + - name: Bradesco + type: bradesco + - name: Cash-Ticket + type: cashticket + - name: CashU + type: cashu + - name: CCAvenue + type: ccavenue + - name: Mula Checkout + type: cellulant + - name: Chasin Giftcard + type: chasingiftcard + - name: Clearpay + type: clearpay + - name: ClickandBuy + type: clickandbuy + - name: Paiement en 3 fois par Cartes Bancaires + type: cofinoga_3xcb + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: DANA + type: dana + - name: DineroMail + type: dineromail + - name: Online bank transfer. + type: directEbanking + - name: Direct Debit Brazil - Banco do Brazil + type: directdebit_BR_bancodobrasil + - name: Direct Debit Brazil - Bradesco + type: directdebit_BR_bradesco + - name: Direct Debit Brazil - Caixa Economica Federal + type: directdebit_BR_caixa + - name: Direct Debit Brazil - HSBC + type: directdebit_BR_hsbc + - name: Direct Debit Brazil - Itau + type: directdebit_BR_itau + - name: Direct Debit Brazil - Santander + type: directdebit_BR_santander + - name: BACS Direct Debit + type: directdebit_GB + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Alfamart + type: doku_alfamart + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BCA Bank Transfer + type: doku_bca_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BNI VA + type: doku_bni_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BRI VA + type: doku_bri_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: CIMB VA + type: doku_cimb_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Danamon VA + type: doku_danamon_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Indomaret + type: doku_indomaret + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Mandiri VA + type: doku_mandiri_va + - details: + - key: ovoId + type: text + name: OVO + type: doku_ovo + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Bank Transfer + type: doku_permata_lite_atm + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: DOKU wallet + type: doku_wallet + - details: + - items: + - id: '66' + name: Bank Nowy BFG S.A. + - id: '92' + name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" + - id: '11' + name: Bank transfer / postal + - id: '74' + name: "Banki Sp\xF3\u0142dzielcze" + - id: '73' + name: BLIK + - id: '90' + name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" + - id: '59' + name: CinkciarzPAY + - id: '87' + name: Credit Agricole PBL + - id: '83' + name: EnveloBank + - id: '76' + name: Getin Bank PBL + - id: '81' + name: Idea Cloud + - id: '7' + name: ING Corporate customers + - id: '93' + name: Kasa Stefczyka + - id: '44' + name: "Millennium - P\u0142atno\u015Bci Internetowe" + - id: '10' + name: Millennium Corporate customers + - id: '68' + name: mRaty + - id: '1' + name: mTransfer + - id: '91' + name: Nest Bank + - id: '80' + name: Noble Pay + - id: '50' + name: Pay Way Toyota Bank + - id: '45' + name: Pay with Alior Bank + - id: '36' + name: Pekao24Przelew + - id: '70' + name: Pocztowy24 + - id: '6' + name: Przelew24 + - id: '46' + name: "P\u0142ac\u0119 z Citi Handlowy" + - id: '38' + name: "P\u0142ac\u0119 z ING" + - id: '2' + name: "P\u0142ac\u0119 z Inteligo" + - id: '4' + name: "P\u0142ac\u0119 z iPKO" + - id: '75' + name: "P\u0142ac\u0119 z Plus Bank" + - id: '51' + name: "P\u0142a\u0107 z BO\u015A" + - id: '55' + name: Raty z Alior Bankiem PLN + - id: '89' + name: Santander + - id: '52' + name: SkyCash + key: issuer + type: select + name: Local Polish Payment Methods + type: dotpay + - name: Dragonpay Prepaid Credits + type: dragonpay_credits + - name: Online Banking + type: dragonpay_ebanking + - name: GCash + type: dragonpay_gcash + - name: Over The Counter Banks + type: dragonpay_otc_banking + - name: OTC non-Bank via Dragonpay + type: dragonpay_otc_non_banking + - name: Convenience Stores + type: dragonpay_otc_philippines + - name: 7/11 + type: dragonpay_seveneleven + - name: eagleeye_voucher + type: eagleeye_voucher + - name: Finnish E-Banking + type: ebanking_FI + - name: Pay-easy ATM + type: econtext_atm + - name: Online Banking + type: econtext_online + - name: 7-Eleven + type: econtext_seven_eleven + - name: Convenience Stores + type: econtext_stores + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Lastschrift (ELV) + type: elv + - details: + - items: + - id: '231' + name: POP Pankki + - id: '551' + name: "Komer\u010Dn\xED banka" + - id: '232' + name: Aktia + - id: '552' + name: Raiffeisen + - id: '233' + name: "S\xE4\xE4st\xF6pankki" + - id: '750' + name: Swedbank + - id: '211' + name: Nordea + - id: '553' + name: "\u010CSOB" + - id: '234' + name: S-Pankki + - id: '751' + name: SEB + - id: '554' + name: Moneta + - id: '235' + name: OmaSP + - id: '752' + name: Nordea + - id: '213' + name: Op-Pohjola + - id: '555' + name: UniCredit + - id: '753' + name: LHV + - id: '556' + name: Fio + - id: '557' + name: mBank + - id: '216' + name: Handelsbanken + - id: '558' + name: Air Bank + - id: '260' + name: "L\xE4nsf\xF6rs\xE4kringar" + - id: '240' + name: BankDeposit + - id: '265' + name: Sparbanken + - id: '640' + name: BankDeposit + - id: '200' + name: "\xC5landsbanken" + - id: '940' + name: Swedbank + - id: '500' + name: "\u010Cesk\xE1 spo\u0159itelna" + - id: '720' + name: Swedbank + - id: '941' + name: SEB + - id: '204' + name: Danske Bank + - id: '721' + name: SEB + - id: '942' + name: Citadele + - id: '205' + name: Handelsbanken + - id: '722' + name: DNB + - id: '943' + name: DNB + - id: '206' + name: Nordea + - id: '723' + name: "\u0160iauli\u0173 bankas" + - id: '207' + name: SEB + - id: '724' + name: Nordea + - id: '505' + name: "Komer\u010Dn\xED banka" + - id: '208' + name: Skandiabanken + - id: '209' + name: Swedbank + key: issuer + type: select + name: Bank Payment + type: entercash + - name: Nationale Entertainment Card + type: entertainmentcard + - details: + - items: + - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 + name: Dolomitenbank + - id: ee9fc487-ebe0-486c-8101-17dce5141a67 + name: Raiffeissen Bankengruppe + - id: 6765e225-a0dc-4481-9666-e26303d4f221 + name: Hypo Tirol Bank AG + - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc + name: Sparda Bank Wien + - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f + name: Schoellerbank AG + - id: e2e97aaa-de4c-4e18-9431-d99790773433 + name: Volksbank Gruppe + - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 + name: Immo-Bank + - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 + name: Bank Austria + - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 + name: Easybank AG + - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a + name: VR-BankBraunau + - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 + name: Volkskreditbank + - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 + name: Erste Bank und Sparkassen + - id: ba7199cc-f057-42f2-9856-2378abf21638 + name: BAWAG P.S.K. Gruppe + key: issuer + type: select + name: EPS + type: eps + - name: Expert Cadeaukaart + type: expertgiftcard + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 3x Oney + type: facilypay_3x + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 4x Oney + type: facilypay_4x + - name: Fashioncheque + type: fashioncheque + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: Fawry + type: fawry + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Fonq Giftcard + type: fonqgiftcard + - name: Gall & Gall + type: gallgall + - name: GCash + type: gcash + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - details: + - key: bic + type: text + name: GiroPay + type: giropay + - name: Givex + type: givex + - name: Globe GCash + type: globegcash + - name: Goldsmiths Card + type: goldsmithscard + - name: GoPay Wallet + type: gopay_wallet + - name: OVO + type: grabpay_ID + - name: GrabPay + type: grabpay_PH + - name: GrabPay + type: grabpay_SG + - name: Hallmark Card + type: hallmarkcard + - name: HDFC + type: hdfc + - name: Hunkemoller Member Card + type: hmclub + - name: Hunkemoller Lingerie Card + type: hmlingerie + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - name: igive + type: igive + - name: Korean Account Transfer (IniPay) + type: inicisIniPay_accounttransfer + - name: Korean Credit Cards (IniPay) + type: inicisIniPay_creditcard + - name: Korean Mobile Phone (IniPay) + type: inicisIniPay_mobilephone + - name: Korean Virtual Account (IniPay) + type: inicisIniPay_virtualaccount + - name: Korean Account Transfer (Mobile) + type: inicisMobile_accounttransfer + - name: Korean Credit Cards (Mobile) + type: inicisMobile_creditcard + - name: Korean Mobile Phone (Mobile) + type: inicisMobile_mobilephone + - name: Korean Virtual Account (Mobile) + type: inicisMobile_virtualaccount + - name: Korean Credit Cards + type: inicis_creditcard + - name: "Interac\xAE Online" + type: interac + - name: Instant EFT + type: ipay + - name: iPay88 + type: ipay88 + - name: isracard + type: isracard + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: KakaoPay + type: kakaopay + - name: Karen Millen Card + type: karenmillen + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Bank Transfer + type: kcp_banktransfer + - name: "Korea\u2013issued cards" + type: kcp_creditcard + - name: PayCo + type: kcp_payco + - name: Virtual Account via KCP + type: kcp_va + - name: Pay later with Klarna. + type: klarna + - name: Pay over time with Klarna. + type: klarna_account + - name: Klarna B2B + type: klarna_b2b + - name: Pay now with Klarna. + type: klarna_paynow + - name: Leisure Card + type: leisurecard + - name: China Credit Card + type: lianlianpay_creditcard + - name: China Debit Card + type: lianlianpay_debitcard + - details: + - key: telephoneNumber + type: tel + name: China Online Banking - Credit Card + type: lianlianpay_ebanking_credit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '4031000' + name: Bank of Beijing + - id: '01040000' + name: Bank of China + - id: '03020000' + name: China Citic Bank + - id: '01050000' + name: China Construction Bank + - id: '03030000' + name: China Everbright Bank + - id: 03080000 + name: China Merchants Bank + - id: '03050000' + name: China Minsheng Banking Group + - id: '03040000' + name: Hua Xia Bank Co + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03070000' + name: PingAn Bank + - id: '1000000' + name: Postal Savings Bank of China + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Debit Card + type: lianlianpay_ebanking_debit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '01050000' + name: China Construction Bank + - id: 03080000 + name: China Merchants Bank + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03100000' + name: Shanghai Pudong Development Bank + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Enterprise + type: lianlianpay_ebanking_enterprise + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - name: Love2Shop GiftCard + type: love2shop + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: mada + type: mada + - name: Mappin & Webb Card + type: mappinwebbcard + - name: MB WAY + type: mbway + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: Mercado Pago + type: mercadopago + - name: MobilePay + type: mobilepay + - name: AliPay via Razer Merchant Services + type: molpay_alipay + - name: 7-Eleven + type: molpay_cash + - name: CIMB Virtual Account + type: molpay_cimb_va + - name: Malaysia E-Banking via Razer Merchant Services + type: molpay_ebanking_MY + - details: + - items: + - id: vtcpay-vietinbank + name: Vietinbank + - id: vtcpay-bidv + name: BIDV + - id: vtcpay-agribank + name: Agribank + - id: vtcpay-mb + name: MB Bank + - id: vtcpay-sacombank + name: Sacombank + - id: vtcpay-dongabank + name: DongABank + - id: vtcpay-maritimebank + name: MaritimeBank + - id: vtcpay-vietcombank + name: Vietcombank + - id: vtcpay-acb + name: ACB + - id: vtcpay-techcombank + name: Techcombank + key: issuer + type: select + name: Vietnam E-Banking + type: molpay_ebanking_VN + - details: + - items: + - id: fpx_bimb + name: Bank Islam + - id: fpx_uob + name: UOB Bank + - id: fpx_cimbclicks + name: CIMB Clicks + - id: fpx_kfh + name: Kuwait Finance House + - id: fpx_rhb + name: RHB Now + - id: fpx_abmb + name: Alliance Bank + - id: fpx_amb + name: Am Online + - id: fpx_hsbc + name: HSBC + - id: fpx_abb + name: Affin Bank + - id: fpx_ocbc + name: OCBC Bank + - id: fpx_pbb + name: Public Bank + - id: fpx_scb + name: Standard Chartered Bank + - id: fpx_bsn + name: Bank Simpanan Nasional + - id: fpx_mb2u + name: Maybank2u + - id: fpx_hlb + name: Hong Leong Connect + - id: fpx_bmmb + name: Bank Muamalat + - id: fpx_bkrm + name: Bank Rakyat + key: issuer + type: select + name: Malaysia E-Banking + type: molpay_ebanking_fpx_MY + - name: eNETS Debit + type: molpay_enetsd + - name: epay + type: molpay_epay + - name: Esapay + type: molpay_esapay + - name: MyClear FPX + type: molpay_fpx + - name: Maybank2u + type: molpay_maybank2u + - name: Nganluong + type: molpay_nganluong + - name: Tesco Lotus + type: molpay_paysbuy + - name: MOLPoints + type: molpay_points + - name: RHB Now + type: molpay_rhb + - name: SAM by SingPost + type: molpay_singpost + - name: MOLWallet + type: molpay_wallet + - name: MoMo ATM + type: momo_atm + - name: Momo Wallet + type: momo_wallet + - name: Moneybookers + type: moneybookers + - name: Multibanco + type: multibanco + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: BankAxess + type: netaxept_bankaxess + - name: NETELLER + type: neteller + - name: Onebip + type: onebip + - name: One Two Three + type: onetwothree + - name: Local Polish Payment Methods + type: onlineBanking_PL + - details: + - items: + - id: '1' + name: Model Bank v2 + key: issuer + type: select + name: Online banking + type: openbanking_UK + - name: Oxxo + type: oxxo + - name: Pathe Giftcard + type: pathegiftcard + - name: PayBright + type: paybright + - name: PayMaya Wallet + type: paymaya_wallet + - name: PayPal + type: paypal + - name: Paysafecard + type: paysafecard + - name: Payshop + type: payshop + - name: PayD AMT via Paythru + type: paythru_amt + - name: EFT via Paythru + type: paythru_eft + - name: PayTM + type: paytm + - details: + - key: virtualPaymentAddress + type: text + name: PayU UPI + type: payu_IN_upi + - name: EFT Pro via PayU + type: payu_ZA_eftpro + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: pix + type: pix + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Podium Card + type: podiumcard + - name: POLi + type: poli + - name: PPS + type: pps + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Illicado Gift Card + type: prosodie_illicado + - name: PSE + type: pse + - details: + - items: + - id: '+7' + name: RU + - id: '+9955' + name: GE + - id: '+507' + name: PA + - id: '+44' + name: GB + - id: '+992' + name: TJ + - id: '+370' + name: LT + - id: '+972' + name: IL + - id: '+996' + name: KG + - id: '+380' + name: UA + - id: '+84' + name: VN + - id: '+90' + name: TR + - id: '+994' + name: AZ + - id: '+374' + name: AM + - id: '+371' + name: LV + - id: '+91' + name: IN + - id: '+66' + name: TH + - id: '+373' + name: MD + - id: '+1' + name: US + - id: '+81' + name: JP + - id: '+998' + name: UZ + - id: '+77' + name: KZ + - id: '+375' + name: BY + - id: '+372' + name: EE + - id: '+40' + name: RO + - id: '+82' + name: KR + key: qiwiwallet.telephoneNumberPrefix + type: select + - key: qiwiwallet.telephoneNumber + type: text + name: Qiwi Wallet + type: qiwiwallet + - name: RatePay Invoice + type: ratepay + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: SafetyPay + type: safetypay + - name: SafetyPay Cash + type: safetypay_cash + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: SEB Direktbetalning + type: sebdirectpayment + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: 7-Eleven + type: seveneleven + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: Swish + type: swish + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: TenPay + type: tenpay + - name: The Sting Giftcard + type: thestinggiftcard + - name: Trustly + type: trustly + - name: Online Banking by Trustpay + type: trustpay + - name: TWINT + type: twint + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - details: + - key: virtualPaymentAddress + type: text + name: UPI Collect + type: upi_collect + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: telephoneNumber + optional: true + type: tel + name: Vipps + type: vipps + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: VVV Giftcard + type: vvvgiftcard + - name: Webshop Giftcard + type: webshopgiftcard + - name: WeChat Pay + type: wechatpayMiniProgram + - name: WeChat Pay + type: wechatpayQR + - name: WeChat Pay + type: wechatpayWeb + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: WOS Card + type: woscard + - name: Alfa-Click + type: yandex_alfaclick + - name: Pay using bank card + type: yandex_bank_card + - name: Cash terminals + type: yandex_cash + - name: Pay using installments + type: yandex_installments + - name: YooMoney + type: yandex_money + - name: Promsvyazbank + type: yandex_promsvyazbank + - name: Sberbank Online + type: yandex_sberbank + - name: WebMoney + type: yandex_webmoney + - name: Your Gift + type: yourgift + - name: Zip + type: zip post-paymentMethods-filtered: summary: Get payment methods based on the country and amount value: @@ -7924,6 +9484,313 @@ components: amount: currency: EUR value: 1000 + post-paymentMethods-filtered-200: + summary: Example response for request 'filtered' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentMethods-include-oneclick: summary: Get payment methods including stored card details value: @@ -7933,6 +9800,313 @@ components: currency: EUR value: 1000 shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-paymentMethods-include-oneclick-200: + summary: Example response for request 'include-oneclick' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -7966,6 +10140,10 @@ components: shopperLocale: nl_NL merchantAccount: YOUR_MERCHANT_ACCOUNT sdkVersion: 1.7.0 + post-paymentSession-enableOneClick-200: + summary: Example response for request 'enableOneClick' + value: + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-paymentSession-ios: summary: Set up a payment session (iOS) value: @@ -7981,62 +10159,10 @@ components: shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-split: - summary: Split a payment between a sub-merchant and a platform account + post-paymentSession-web-200: + summary: Example response for request 'web' value: - amount: - currency: EUR - value: 6200 - additionalData: - split.api: '1' - split.nrOfItems: '2' - split.totalAmount: '6200' - split.currencyCode: EUR - split.item1.amount: '6000' - split.item1.type: MarketPlace - split.item1.account: '151272963' - split.item1.reference: '6124145' - split.item1.description: 'Porcelain Doll: Eliza (20cm)' - split.item2.amount: '200' - split.item2.type: Commission - split.item2.reference: '6124146' - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Android - token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK - returnUrl: app:// - countryCode: NL - shopperLocale: nl_NL - sessionValidity: '2017-04-06T13:09:13Z' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-payments-applepay: - summary: Make an Apple Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: applepay - applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -8097,127 +10223,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields: - summary: Make a payment with 3D Secure 2 native authentication - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4212345678901237 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - holderName: John Smith - browserInfo: - userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 - Firefox/3.0 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct: - summary: Make a card payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedExpiryMonth: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedExpiryYear: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - storeDetails: true - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw: - summary: Tokenize card details for one-off payments - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - storeDetails: true - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay: - summary: Make a giropay payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: giropay - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-googlepay: - summary: Make a Google Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: paywithgoogle - googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... - merchantAccount: YourMerchantAccount - post-payments-ideal: - summary: Make an iDEAL payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: ideal - issuer: '1121' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-klarna: summary: Make a Klarna payment value: @@ -8283,72 +10288,7 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-oneclick-securedfields: - summary: Make a one-off payment with a token and CVV (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - recurringDetailReference: '8416038790273850' - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-recurring: - summary: Make a card payment with a token - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - recurringDetailReference: '8315791039321763' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth post-payments-result-basic: summary: Verify payment results value: payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK - post-payments-sofort: - summary: Make a Sofort payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: directEbanking - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-split: - summary: Split a payment between a sub-merchant and a platform account - value: - paymentMethod: - type: scheme - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' diff --git a/yaml/CheckoutService-v46.yaml b/yaml/CheckoutService-v46.yaml index 5eadcf6..57fa8ba 100644 --- a/yaml/CheckoutService-v46.yaml +++ b/yaml/CheckoutService-v46.yaml @@ -81,13 +81,21 @@ paths: $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-basic-200' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -124,6 +132,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -150,13 +161,21 @@ paths: $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-cancel-basic-200' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -193,6 +212,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -223,13 +245,21 @@ paths: $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-originKeys-basic-200' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -266,6 +296,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -295,19 +328,30 @@ paths: $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/CreatePaymentLinkRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentLinks-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '201': content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResource' description: Created - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -344,6 +388,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -367,13 +414,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -410,6 +464,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -441,13 +498,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -484,6 +548,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -521,13 +588,25 @@ paths: $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentMethods-basic-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + filtered-200: + $ref: '#/components/examples/post-paymentMethods-filtered-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -564,6 +643,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -592,13 +674,21 @@ paths: $ref: '#/components/examples/post-paymentMethods-balance-basic' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + plastix-200: + $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -629,12 +719,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -661,10 +751,6 @@ paths: content: application/json: examples: - split: - $ref: '#/components/examples/post-paymentSession-split' - web: - $ref: '#/components/examples/post-paymentSession-web' android: $ref: '#/components/examples/post-paymentSession-android' ios: @@ -673,19 +759,26 @@ paths: $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick-200: + $ref: '#/components/examples/post-paymentSession-enableOneClick-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -701,9 +794,6 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -716,12 +806,12 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -743,42 +833,18 @@ paths: content: application/json: examples: - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' - giropay: - $ref: '#/components/examples/post-payments-giropay' - card-3d-secure-securedfields: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' - enableOneClick-raw: - $ref: '#/components/examples/post-payments-enableOneClick-raw' - applepay: - $ref: '#/components/examples/post-payments-applepay' - ideal: - $ref: '#/components/examples/post-payments-ideal' - oneclick-securedfields: - $ref: '#/components/examples/post-payments-oneclick-securedfields' - recurring: - $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' - sofort: - $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' card-3d-secure-direct: $ref: '#/components/examples/post-payments-card-3d-secure-direct' klarna: $ref: '#/components/examples/post-payments-klarna' - split: - $ref: '#/components/examples/post-payments-split' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' schema: $ref: '#/components/schemas/PaymentRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -786,48 +852,39 @@ paths: schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -849,6 +906,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DetailsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -856,6 +915,9 @@ paths: schema: $ref: '#/components/schemas/PaymentDetailsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -883,6 +945,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -908,6 +973,8 @@ paths: $ref: '#/components/examples/post-payments-result-basic' schema: $ref: '#/components/schemas/PaymentVerificationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -915,6 +982,9 @@ paths: schema: $ref: '#/components/schemas/PaymentVerificationResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -945,12 +1015,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -3010,19 +3080,19 @@ components: type: string encryptedCardNumber: description: The encrypted card number. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryMonth: description: The encrypted card expiry month. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryYear: description: The encrypted card expiry year. - maxLength: 7000 + maxLength: 10000 type: string encryptedSecurityCode: description: The encrypted card verification code. - maxLength: 7000 + maxLength: 10000 type: string expiryMonth: description: The card expiry month. Only collect raw card data if you are @@ -3248,8 +3318,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -3467,53 +3543,20 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Success** \u2013 Indicates that the balance check was successful.\n\ + * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\ + \ have enough balance to pay the amount in the request, or that the currency\ + \ of the balance on the card did not match the currency of the requested\ + \ amount.\n* **Failed** \u2013 Indicates that the balance check failed." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success + - NotEnoughBalance + - Failed type: string required: - balance + - resultCode CheckoutCancelOrderRequest: properties: merchantAccount: @@ -3532,7 +3575,11 @@ components: description: A unique reference of the cancellation request. type: string resultCode: - description: The result of the cancellation request. + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Received** \u2013 Indicates the cancellation has successfully been\ + \ received by Adyen, and will be processed." + enum: + - Received type: string required: - pspReference @@ -3608,55 +3655,16 @@ components: description: The remaining amount in the order. $ref: '#/components/schemas/Amount' resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the order creation request.\n The value is always\ + \ **Success**." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success type: string required: - remainingAmount - expiresAt - orderData + - resultCode CheckoutOrder: properties: orderData: @@ -5529,8 +5537,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -6121,8 +6135,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -7397,11 +7417,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -7817,6 +7837,21 @@ components: BasicAuth: scheme: basic type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string examples: generic-400: summary: Response code 400. Bad request. @@ -7854,10 +7889,38 @@ components: message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' + get-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A patch-paymentLinks-linkId-basic: summary: Update the status of a payment link value: status: expired + patch-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: expired + url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -7866,6 +7929,17 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178914061985' + resultCode: Success + expiresAt: '2021-04-09T14:16:46Z' + orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== + reference: shopper-reference-ekvL83 + remainingAmount: + currency: EUR + value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -7873,6 +7947,11 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8816178914079738' + resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -7880,6 +7959,13 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com + post-originKeys-basic-200: + summary: Example response for request 'basic' + value: + originKeys: + https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw + https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc + https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -7906,6 +7992,15 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP + post-paymentLinks-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 1250 + expiresAt: '2021-04-09T14:17:31Z' + reference: shopper-reference-ekvL83 + url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -7923,10 +8018,1471 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix-200: + summary: Example response for request 'plastix' + value: + additionalData: + nonScheme.transactionLimit: '5000' + nonScheme.transactionLimitCcy: EUR + pspReference: 851617891188737F + resultCode: Success + balance: + currency: EUR + value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic-200: + summary: Example response for request 'basic' + value: + paymentMethods: + - details: + - details: + - key: ownerName + type: text + - key: bankLocationId + type: text + - key: bankAccountNumber + type: text + key: bankAccount + type: bankAccount + name: ACH Direct Debit + type: ach + - name: Adyen Voucher + type: adyen_test_voucher + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: Afterpay + type: afterpaytouch + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: AliPay + type: alipay + - name: AliPay HK + type: alipay_hk + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Credit Card via AsiaPay + type: asiapay + - name: China UnionPay + type: asiapay_unionpay + - name: Baby Gift Card + type: babygiftcard + - name: Baloto + type: baloto + - name: BancNet + type: bancnet + - name: Bank Transfer (BG) + type: bankTransfer_BG + - name: Bank Transfer (CH) + type: bankTransfer_CH + - name: Bank Transfer (DE) + type: bankTransfer_DE + - name: Bank Transfer (FI) + type: bankTransfer_FI + - name: Bank Transfer (GB) + type: bankTransfer_GB + - name: Bank Transfer (HU) + type: bankTransfer_HU + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bank Transfer (IE) + type: bankTransfer_IE + - name: Electronic Bank Transfer (MX) + type: bankTransfer_MX_linked + - name: Bank Transfer (MX) + type: bankTransfer_MX_offline + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Bank Transfer (PL) + type: bankTransfer_PL + - name: Bank Transfer (SE) + type: bankTransfer_SE + - name: Bank Transfer (US) + type: bankTransfer_US + - name: Payconiq by Bancontact + type: bcmc_mobile + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: 99Bill + type: bill99 + - details: + - items: + - id: AUB_DIRECT + name: AU Small Finance Bank + - id: ALB_DIRECT + name: 'Allahabad Bank ' + - id: APG_DIRECT + name: Andhra Pragathi Grameena Bank + - id: BDN_DIRECT + name: Bandhan bank + - id: BBK_DIRECT + name: Bank of Bahrain and Kuwait + - id: BBR_DIRECT + name: Bank of Baroda - Retail Banking + - id: BCB_DIRECT + name: 'Bassien Catholic Co-Operative Bank ' + - id: CNB_DIRECT + name: Canara Bank + - id: SYD_DIRECT + name: Canara Bank (e-Syndicate) + - id: CSB_DIRECT + name: Catholic Syrian Bank + - id: CBI_DIRECT + name: Central Bank of India + - id: CUB_DIRECT + name: City Union Bank + - id: COB_DIRECT + name: Cosmos Bank + - id: DEN_DIRECT + name: Dena Bank + - id: DBK_DIRECT + name: Deutsche Bank + - id: DCB_DIRECT + name: Development Credit Bank + - id: DLB_DIRECT + name: Dhanlakshmi Bank - Retail Net Banking + - id: ESF_DIRECT + name: ESAF Small Finance Bank + - id: EQB_DIRECT + name: Equitas Small Finance Bank + - id: FBK_DIRECT + name: Federal Bank + - id: FNC_DIRECT + name: Fincare Bank + - id: HDF_DIRECT + name: HDFC Bank + - id: ICI_DIRECT + name: 'ICICI Bank ' + - id: IDB_DIRECT + name: IDBI Bank - Retail Net Banking + - id: IDN_DIRECT + name: IDFC FIRST Bank + - id: INB_DIRECT + name: Indian Bank + - id: IOB_DIRECT + name: Indian Overseas Bank + - id: IDS_DIRECT + name: IndusInd Bank + - id: JKB_DIRECT + name: Jammu & Kashmir Bank + - id: JNB_DIRECT + name: Jana Small Finance Bank + - id: JSB_DIRECT + name: Janata Sahakari Bank Ltd Pune + - id: KJB_DIRECT + name: Kalyan Janata Sahakari Bank + - id: KBL_DIRECT + name: Karnataka Bank Ltd + - id: KVB_DIRECT + name: Karur Vysya Bank + - id: 162_DIRECT + name: Kotak Bank + - id: LVR_DIRECT + name: Laxmi Vilas Bank - Retail + - id: NKB_DIRECT + name: NKGSB Co-op Bank + - id: NEB_DIRECT + name: North East Small Finance Bank + - id: OBC_DIRECT + name: PNB (Erstwhile-Oriental Bank of Commerce) + - id: UNI_DIRECT + name: PNB (Erstwhile-United Bank of India) + - id: PMC_DIRECT + name: Punjab & Maharastra Co-op Bank + - id: PSB_DIRECT + name: Punjab & Sind Bank + - id: CPN_DIRECT + name: 'Punjab National Bank - Corporate ' + - id: PNB_DIRECT + name: Punjab National Bank - Retail Banking + - id: RBL_DIRECT + name: RBL Bank Limited + - id: SWB_DIRECT + name: Saraswat Bank + - id: SHB_DIRECT + name: Shivalik Mercantile Cooperative Bank Ltd + - id: SIB_DIRECT + name: South Indian Bank + - id: SCB_DIRECT + name: Standard Chartered Bank + - id: SBI_DIRECT + name: State Bank of India + - id: SRB_DIRECT + name: Suryoday Small Finance Bank + - id: TJB_DIRECT + name: TJSB Bank + - id: TNC_DIRECT + name: Tamil Nadu State Co-operative Bank + - id: TMB_DIRECT + name: Tamilnad Mercantile Bank Ltd + - id: TBB_DIRECT + name: Thane Bharat Sahakari Bank Ltd + - id: MSB_DIRECT + name: The Mehsana Urban Co Op Bank Ltd + - id: UCO_DIRECT + name: UCO Bank + - id: UBI_DIRECT + name: Union Bank of India + - id: ADB_DIRECT + name: Union Bank of India (Erstwhile Andhra Bank) + - id: CRP_DIRECT + name: Union Bank of India (Erstwhile Corporation Bank) + - id: VRB_DIRECT + name: Varachha Co-operative Bank Limited + - id: VJB_DIRECT + name: Vijaya Bank + - id: YBK_DIRECT + name: Yes Bank + - id: ZOB_DIRECT + name: Zoroastrian Co-operative Bank Limited + - id: DBS_DIRECT + name: digibank by DBS + key: issuer + type: select + name: Online Banking India + type: billdesk_online + - name: UPI + type: billdesk_upi + - details: + - items: + - id: DCW_DIRECT + name: DCB Cippy + - id: ICC_DIRECT + name: ICC Cash Card + - id: OXY_DIRECT + name: Oxigen Wallet + - id: PCH_DIRECT + name: Pay World Money + key: issuer + type: select + name: Wallets India + type: billdesk_wallet + - name: Blik + type: blik + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Boleto + type: boleto + - name: Boleto Bancario + type: boletobancario_santander + - name: Bradesco + type: bradesco + - name: Cash-Ticket + type: cashticket + - name: CashU + type: cashu + - name: CCAvenue + type: ccavenue + - name: Mula Checkout + type: cellulant + - name: Chasin Giftcard + type: chasingiftcard + - name: Clearpay + type: clearpay + - name: ClickandBuy + type: clickandbuy + - name: Paiement en 3 fois par Cartes Bancaires + type: cofinoga_3xcb + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: DANA + type: dana + - name: DineroMail + type: dineromail + - name: Online bank transfer. + type: directEbanking + - name: Direct Debit Brazil - Banco do Brazil + type: directdebit_BR_bancodobrasil + - name: Direct Debit Brazil - Bradesco + type: directdebit_BR_bradesco + - name: Direct Debit Brazil - Caixa Economica Federal + type: directdebit_BR_caixa + - name: Direct Debit Brazil - HSBC + type: directdebit_BR_hsbc + - name: Direct Debit Brazil - Itau + type: directdebit_BR_itau + - name: Direct Debit Brazil - Santander + type: directdebit_BR_santander + - name: BACS Direct Debit + type: directdebit_GB + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Alfamart + type: doku_alfamart + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BCA Bank Transfer + type: doku_bca_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BNI VA + type: doku_bni_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BRI VA + type: doku_bri_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: CIMB VA + type: doku_cimb_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Danamon VA + type: doku_danamon_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Indomaret + type: doku_indomaret + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Mandiri VA + type: doku_mandiri_va + - details: + - key: ovoId + type: text + name: OVO + type: doku_ovo + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Bank Transfer + type: doku_permata_lite_atm + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: DOKU wallet + type: doku_wallet + - details: + - items: + - id: '66' + name: Bank Nowy BFG S.A. + - id: '92' + name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" + - id: '11' + name: Bank transfer / postal + - id: '74' + name: "Banki Sp\xF3\u0142dzielcze" + - id: '73' + name: BLIK + - id: '90' + name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" + - id: '59' + name: CinkciarzPAY + - id: '87' + name: Credit Agricole PBL + - id: '83' + name: EnveloBank + - id: '76' + name: Getin Bank PBL + - id: '81' + name: Idea Cloud + - id: '7' + name: ING Corporate customers + - id: '93' + name: Kasa Stefczyka + - id: '44' + name: "Millennium - P\u0142atno\u015Bci Internetowe" + - id: '10' + name: Millennium Corporate customers + - id: '68' + name: mRaty + - id: '1' + name: mTransfer + - id: '91' + name: Nest Bank + - id: '80' + name: Noble Pay + - id: '50' + name: Pay Way Toyota Bank + - id: '45' + name: Pay with Alior Bank + - id: '36' + name: Pekao24Przelew + - id: '70' + name: Pocztowy24 + - id: '6' + name: Przelew24 + - id: '46' + name: "P\u0142ac\u0119 z Citi Handlowy" + - id: '38' + name: "P\u0142ac\u0119 z ING" + - id: '2' + name: "P\u0142ac\u0119 z Inteligo" + - id: '4' + name: "P\u0142ac\u0119 z iPKO" + - id: '75' + name: "P\u0142ac\u0119 z Plus Bank" + - id: '51' + name: "P\u0142a\u0107 z BO\u015A" + - id: '55' + name: Raty z Alior Bankiem PLN + - id: '89' + name: Santander + - id: '52' + name: SkyCash + key: issuer + type: select + name: Local Polish Payment Methods + type: dotpay + - name: Dragonpay Prepaid Credits + type: dragonpay_credits + - name: Online Banking + type: dragonpay_ebanking + - name: GCash + type: dragonpay_gcash + - name: Over The Counter Banks + type: dragonpay_otc_banking + - name: OTC non-Bank via Dragonpay + type: dragonpay_otc_non_banking + - name: Convenience Stores + type: dragonpay_otc_philippines + - name: 7/11 + type: dragonpay_seveneleven + - name: eagleeye_voucher + type: eagleeye_voucher + - name: Finnish E-Banking + type: ebanking_FI + - name: Pay-easy ATM + type: econtext_atm + - name: Online Banking + type: econtext_online + - name: 7-Eleven + type: econtext_seven_eleven + - name: Convenience Stores + type: econtext_stores + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Lastschrift (ELV) + type: elv + - details: + - items: + - id: '231' + name: POP Pankki + - id: '551' + name: "Komer\u010Dn\xED banka" + - id: '232' + name: Aktia + - id: '552' + name: Raiffeisen + - id: '233' + name: "S\xE4\xE4st\xF6pankki" + - id: '750' + name: Swedbank + - id: '211' + name: Nordea + - id: '553' + name: "\u010CSOB" + - id: '234' + name: S-Pankki + - id: '751' + name: SEB + - id: '554' + name: Moneta + - id: '235' + name: OmaSP + - id: '752' + name: Nordea + - id: '213' + name: Op-Pohjola + - id: '555' + name: UniCredit + - id: '753' + name: LHV + - id: '556' + name: Fio + - id: '557' + name: mBank + - id: '216' + name: Handelsbanken + - id: '558' + name: Air Bank + - id: '260' + name: "L\xE4nsf\xF6rs\xE4kringar" + - id: '240' + name: BankDeposit + - id: '265' + name: Sparbanken + - id: '640' + name: BankDeposit + - id: '200' + name: "\xC5landsbanken" + - id: '940' + name: Swedbank + - id: '500' + name: "\u010Cesk\xE1 spo\u0159itelna" + - id: '720' + name: Swedbank + - id: '941' + name: SEB + - id: '204' + name: Danske Bank + - id: '721' + name: SEB + - id: '942' + name: Citadele + - id: '205' + name: Handelsbanken + - id: '722' + name: DNB + - id: '943' + name: DNB + - id: '206' + name: Nordea + - id: '723' + name: "\u0160iauli\u0173 bankas" + - id: '207' + name: SEB + - id: '724' + name: Nordea + - id: '505' + name: "Komer\u010Dn\xED banka" + - id: '208' + name: Skandiabanken + - id: '209' + name: Swedbank + key: issuer + type: select + name: Bank Payment + type: entercash + - name: Nationale Entertainment Card + type: entertainmentcard + - details: + - items: + - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 + name: Dolomitenbank + - id: ee9fc487-ebe0-486c-8101-17dce5141a67 + name: Raiffeissen Bankengruppe + - id: 6765e225-a0dc-4481-9666-e26303d4f221 + name: Hypo Tirol Bank AG + - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc + name: Sparda Bank Wien + - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f + name: Schoellerbank AG + - id: e2e97aaa-de4c-4e18-9431-d99790773433 + name: Volksbank Gruppe + - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 + name: Immo-Bank + - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 + name: Bank Austria + - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 + name: Easybank AG + - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a + name: VR-BankBraunau + - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 + name: Volkskreditbank + - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 + name: Erste Bank und Sparkassen + - id: ba7199cc-f057-42f2-9856-2378abf21638 + name: BAWAG P.S.K. Gruppe + key: issuer + type: select + name: EPS + type: eps + - name: Expert Cadeaukaart + type: expertgiftcard + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 3x Oney + type: facilypay_3x + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 4x Oney + type: facilypay_4x + - name: Fashioncheque + type: fashioncheque + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: Fawry + type: fawry + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Fonq Giftcard + type: fonqgiftcard + - name: Gall & Gall + type: gallgall + - name: GCash + type: gcash + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - details: + - key: bic + type: text + name: GiroPay + type: giropay + - name: Givex + type: givex + - name: Globe GCash + type: globegcash + - name: Goldsmiths Card + type: goldsmithscard + - name: GoPay Wallet + type: gopay_wallet + - name: OVO + type: grabpay_ID + - name: GrabPay + type: grabpay_PH + - name: GrabPay + type: grabpay_SG + - name: Hallmark Card + type: hallmarkcard + - name: HDFC + type: hdfc + - name: Hunkemoller Member Card + type: hmclub + - name: Hunkemoller Lingerie Card + type: hmlingerie + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - name: igive + type: igive + - name: Korean Account Transfer (IniPay) + type: inicisIniPay_accounttransfer + - name: Korean Credit Cards (IniPay) + type: inicisIniPay_creditcard + - name: Korean Mobile Phone (IniPay) + type: inicisIniPay_mobilephone + - name: Korean Virtual Account (IniPay) + type: inicisIniPay_virtualaccount + - name: Korean Account Transfer (Mobile) + type: inicisMobile_accounttransfer + - name: Korean Credit Cards (Mobile) + type: inicisMobile_creditcard + - name: Korean Mobile Phone (Mobile) + type: inicisMobile_mobilephone + - name: Korean Virtual Account (Mobile) + type: inicisMobile_virtualaccount + - name: Korean Credit Cards + type: inicis_creditcard + - name: "Interac\xAE Online" + type: interac + - name: Instant EFT + type: ipay + - name: iPay88 + type: ipay88 + - name: isracard + type: isracard + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: KakaoPay + type: kakaopay + - name: Karen Millen Card + type: karenmillen + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Bank Transfer + type: kcp_banktransfer + - name: "Korea\u2013issued cards" + type: kcp_creditcard + - name: PayCo + type: kcp_payco + - name: Virtual Account via KCP + type: kcp_va + - name: Pay later with Klarna. + type: klarna + - name: Pay over time with Klarna. + type: klarna_account + - name: Klarna B2B + type: klarna_b2b + - name: Pay now with Klarna. + type: klarna_paynow + - name: Leisure Card + type: leisurecard + - name: China Credit Card + type: lianlianpay_creditcard + - name: China Debit Card + type: lianlianpay_debitcard + - details: + - key: telephoneNumber + type: tel + name: China Online Banking - Credit Card + type: lianlianpay_ebanking_credit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '4031000' + name: Bank of Beijing + - id: '01040000' + name: Bank of China + - id: '03020000' + name: China Citic Bank + - id: '01050000' + name: China Construction Bank + - id: '03030000' + name: China Everbright Bank + - id: 03080000 + name: China Merchants Bank + - id: '03050000' + name: China Minsheng Banking Group + - id: '03040000' + name: Hua Xia Bank Co + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03070000' + name: PingAn Bank + - id: '1000000' + name: Postal Savings Bank of China + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Debit Card + type: lianlianpay_ebanking_debit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '01050000' + name: China Construction Bank + - id: 03080000 + name: China Merchants Bank + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03100000' + name: Shanghai Pudong Development Bank + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Enterprise + type: lianlianpay_ebanking_enterprise + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - name: Love2Shop GiftCard + type: love2shop + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: mada + type: mada + - name: Mappin & Webb Card + type: mappinwebbcard + - name: MB WAY + type: mbway + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: Mercado Pago + type: mercadopago + - name: MobilePay + type: mobilepay + - name: AliPay via Razer Merchant Services + type: molpay_alipay + - name: 7-Eleven + type: molpay_cash + - name: CIMB Virtual Account + type: molpay_cimb_va + - name: Malaysia E-Banking via Razer Merchant Services + type: molpay_ebanking_MY + - details: + - items: + - id: vtcpay-vietinbank + name: Vietinbank + - id: vtcpay-bidv + name: BIDV + - id: vtcpay-agribank + name: Agribank + - id: vtcpay-mb + name: MB Bank + - id: vtcpay-sacombank + name: Sacombank + - id: vtcpay-dongabank + name: DongABank + - id: vtcpay-maritimebank + name: MaritimeBank + - id: vtcpay-vietcombank + name: Vietcombank + - id: vtcpay-acb + name: ACB + - id: vtcpay-techcombank + name: Techcombank + key: issuer + type: select + name: Vietnam E-Banking + type: molpay_ebanking_VN + - details: + - items: + - id: fpx_bimb + name: Bank Islam + - id: fpx_uob + name: UOB Bank + - id: fpx_cimbclicks + name: CIMB Clicks + - id: fpx_kfh + name: Kuwait Finance House + - id: fpx_rhb + name: RHB Now + - id: fpx_abmb + name: Alliance Bank + - id: fpx_amb + name: Am Online + - id: fpx_hsbc + name: HSBC + - id: fpx_abb + name: Affin Bank + - id: fpx_ocbc + name: OCBC Bank + - id: fpx_pbb + name: Public Bank + - id: fpx_scb + name: Standard Chartered Bank + - id: fpx_bsn + name: Bank Simpanan Nasional + - id: fpx_mb2u + name: Maybank2u + - id: fpx_hlb + name: Hong Leong Connect + - id: fpx_bmmb + name: Bank Muamalat + - id: fpx_bkrm + name: Bank Rakyat + key: issuer + type: select + name: Malaysia E-Banking + type: molpay_ebanking_fpx_MY + - name: eNETS Debit + type: molpay_enetsd + - name: epay + type: molpay_epay + - name: Esapay + type: molpay_esapay + - name: MyClear FPX + type: molpay_fpx + - name: Maybank2u + type: molpay_maybank2u + - name: Nganluong + type: molpay_nganluong + - name: Tesco Lotus + type: molpay_paysbuy + - name: MOLPoints + type: molpay_points + - name: RHB Now + type: molpay_rhb + - name: SAM by SingPost + type: molpay_singpost + - name: MOLWallet + type: molpay_wallet + - name: MoMo ATM + type: momo_atm + - name: Momo Wallet + type: momo_wallet + - name: Moneybookers + type: moneybookers + - name: Multibanco + type: multibanco + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: BankAxess + type: netaxept_bankaxess + - name: NETELLER + type: neteller + - name: Onebip + type: onebip + - name: One Two Three + type: onetwothree + - name: Local Polish Payment Methods + type: onlineBanking_PL + - details: + - items: + - id: '1' + name: Model Bank v2 + key: issuer + type: select + name: Online banking + type: openbanking_UK + - name: Oxxo + type: oxxo + - name: Pathe Giftcard + type: pathegiftcard + - name: PayBright + type: paybright + - name: PayMaya Wallet + type: paymaya_wallet + - name: PayPal + type: paypal + - name: Paysafecard + type: paysafecard + - name: Payshop + type: payshop + - name: PayD AMT via Paythru + type: paythru_amt + - name: EFT via Paythru + type: paythru_eft + - name: PayTM + type: paytm + - details: + - key: virtualPaymentAddress + type: text + name: PayU UPI + type: payu_IN_upi + - name: EFT Pro via PayU + type: payu_ZA_eftpro + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: pix + type: pix + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Podium Card + type: podiumcard + - name: POLi + type: poli + - name: PPS + type: pps + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Illicado Gift Card + type: prosodie_illicado + - name: PSE + type: pse + - details: + - items: + - id: '+7' + name: RU + - id: '+9955' + name: GE + - id: '+507' + name: PA + - id: '+44' + name: GB + - id: '+992' + name: TJ + - id: '+370' + name: LT + - id: '+972' + name: IL + - id: '+996' + name: KG + - id: '+380' + name: UA + - id: '+84' + name: VN + - id: '+90' + name: TR + - id: '+994' + name: AZ + - id: '+374' + name: AM + - id: '+371' + name: LV + - id: '+91' + name: IN + - id: '+66' + name: TH + - id: '+373' + name: MD + - id: '+1' + name: US + - id: '+81' + name: JP + - id: '+998' + name: UZ + - id: '+77' + name: KZ + - id: '+375' + name: BY + - id: '+372' + name: EE + - id: '+40' + name: RO + - id: '+82' + name: KR + key: qiwiwallet.telephoneNumberPrefix + type: select + - key: qiwiwallet.telephoneNumber + type: text + name: Qiwi Wallet + type: qiwiwallet + - name: RatePay Invoice + type: ratepay + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: SafetyPay + type: safetypay + - name: SafetyPay Cash + type: safetypay_cash + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: SEB Direktbetalning + type: sebdirectpayment + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: 7-Eleven + type: seveneleven + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: Swish + type: swish + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: TenPay + type: tenpay + - name: The Sting Giftcard + type: thestinggiftcard + - name: Trustly + type: trustly + - name: Online Banking by Trustpay + type: trustpay + - name: TWINT + type: twint + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - details: + - key: virtualPaymentAddress + type: text + name: UPI Collect + type: upi_collect + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: telephoneNumber + optional: true + type: tel + name: Vipps + type: vipps + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: VVV Giftcard + type: vvvgiftcard + - name: Webshop Giftcard + type: webshopgiftcard + - name: WeChat Pay + type: wechatpayMiniProgram + - name: WeChat Pay + type: wechatpayQR + - name: WeChat Pay + type: wechatpayWeb + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: WOS Card + type: woscard + - name: Alfa-Click + type: yandex_alfaclick + - name: Pay using bank card + type: yandex_bank_card + - name: Cash terminals + type: yandex_cash + - name: Pay using installments + type: yandex_installments + - name: YooMoney + type: yandex_money + - name: Promsvyazbank + type: yandex_promsvyazbank + - name: Sberbank Online + type: yandex_sberbank + - name: WebMoney + type: yandex_webmoney + - name: Your Gift + type: yourgift + - name: Zip + type: zip post-paymentMethods-filtered: summary: Get payment methods based on the country and amount value: @@ -7936,6 +9492,313 @@ components: amount: currency: EUR value: 1000 + post-paymentMethods-filtered-200: + summary: Example response for request 'filtered' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentMethods-include-oneclick: summary: Get payment methods including stored card details value: @@ -7945,6 +9808,313 @@ components: currency: EUR value: 1000 shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-paymentMethods-include-oneclick-200: + summary: Example response for request 'include-oneclick' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -7978,6 +10148,10 @@ components: shopperLocale: nl_NL merchantAccount: YOUR_MERCHANT_ACCOUNT sdkVersion: 1.7.0 + post-paymentSession-enableOneClick-200: + summary: Example response for request 'enableOneClick' + value: + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-paymentSession-ios: summary: Set up a payment session (iOS) value: @@ -7993,62 +10167,10 @@ components: shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-split: - summary: Split a payment between a sub-merchant and a platform account + post-paymentSession-web-200: + summary: Example response for request 'web' value: - amount: - currency: EUR - value: 6200 - additionalData: - split.api: '1' - split.nrOfItems: '2' - split.totalAmount: '6200' - split.currencyCode: EUR - split.item1.amount: '6000' - split.item1.type: MarketPlace - split.item1.account: '151272963' - split.item1.reference: '6124145' - split.item1.description: 'Porcelain Doll: Eliza (20cm)' - split.item2.amount: '200' - split.item2.type: Commission - split.item2.reference: '6124146' - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Android - token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK - returnUrl: app:// - countryCode: NL - shopperLocale: nl_NL - sessionValidity: '2017-04-06T13:09:13Z' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-payments-applepay: - summary: Make an Apple Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: applepay - applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -8110,127 +10232,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields: - summary: Make a payment with 3D Secure 2 native authentication - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4212345678901237 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - holderName: John Smith - browserInfo: - userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 - Firefox/3.0 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct: - summary: Make a card payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedExpiryMonth: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedExpiryYear: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - storeDetails: true - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw: - summary: Tokenize card details for one-off payments - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - storeDetails: true - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay: - summary: Make a giropay payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: giropay - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-googlepay: - summary: Make a Google Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: paywithgoogle - googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... - merchantAccount: YourMerchantAccount - post-payments-ideal: - summary: Make an iDEAL payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: ideal - issuer: '1121' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-klarna: summary: Make a Klarna payment value: @@ -8296,72 +10297,7 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-oneclick-securedfields: - summary: Make a one-off payment with a token and CVV (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - recurringDetailReference: '8416038790273850' - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-recurring: - summary: Make a card payment with a token - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - recurringDetailReference: '8315791039321763' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth post-payments-result-basic: summary: Verify payment results value: payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK - post-payments-sofort: - summary: Make a Sofort payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: directEbanking - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-split: - summary: Split a payment between a sub-merchant and a platform account - value: - paymentMethod: - type: scheme - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' diff --git a/yaml/CheckoutService-v49.yaml b/yaml/CheckoutService-v49.yaml index 362f163..256aba4 100644 --- a/yaml/CheckoutService-v49.yaml +++ b/yaml/CheckoutService-v49.yaml @@ -81,13 +81,21 @@ paths: $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-basic-200' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -124,6 +132,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -150,13 +161,21 @@ paths: $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-cancel-basic-200' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -193,6 +212,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -223,13 +245,21 @@ paths: $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-originKeys-basic-200' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -266,6 +296,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -295,19 +328,30 @@ paths: $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/CreatePaymentLinkRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentLinks-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '201': content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResource' description: Created - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -344,6 +388,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -367,13 +414,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -410,6 +464,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -441,13 +498,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -484,6 +548,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -521,13 +588,25 @@ paths: $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentMethods-basic-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + filtered-200: + $ref: '#/components/examples/post-paymentMethods-filtered-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -564,6 +643,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -592,13 +674,21 @@ paths: $ref: '#/components/examples/post-paymentMethods-balance-basic' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + plastix-200: + $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -629,12 +719,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -661,10 +751,6 @@ paths: content: application/json: examples: - split: - $ref: '#/components/examples/post-paymentSession-split' - web: - $ref: '#/components/examples/post-paymentSession-web' android: $ref: '#/components/examples/post-paymentSession-android' ios: @@ -673,19 +759,26 @@ paths: $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick-200: + $ref: '#/components/examples/post-paymentSession-enableOneClick-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -701,9 +794,6 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -716,12 +806,12 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -743,42 +833,18 @@ paths: content: application/json: examples: - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' - giropay: - $ref: '#/components/examples/post-payments-giropay' - card-3d-secure-securedfields: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' - enableOneClick-raw: - $ref: '#/components/examples/post-payments-enableOneClick-raw' - applepay: - $ref: '#/components/examples/post-payments-applepay' - ideal: - $ref: '#/components/examples/post-payments-ideal' - oneclick-securedfields: - $ref: '#/components/examples/post-payments-oneclick-securedfields' - recurring: - $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' - sofort: - $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' card-3d-secure-direct: $ref: '#/components/examples/post-payments-card-3d-secure-direct' klarna: $ref: '#/components/examples/post-payments-klarna' - split: - $ref: '#/components/examples/post-payments-split' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' schema: $ref: '#/components/schemas/PaymentRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -786,48 +852,39 @@ paths: schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -849,6 +906,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DetailsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -856,6 +915,9 @@ paths: schema: $ref: '#/components/schemas/PaymentDetailsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -883,6 +945,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -908,6 +973,8 @@ paths: $ref: '#/components/examples/post-payments-result-basic' schema: $ref: '#/components/schemas/PaymentVerificationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -915,6 +982,9 @@ paths: schema: $ref: '#/components/schemas/PaymentVerificationResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -945,12 +1015,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -3050,19 +3120,19 @@ components: type: string encryptedCardNumber: description: The encrypted card number. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryMonth: description: The encrypted card expiry month. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryYear: description: The encrypted card expiry year. - maxLength: 7000 + maxLength: 10000 type: string encryptedSecurityCode: description: The encrypted card verification code. - maxLength: 7000 + maxLength: 10000 type: string expiryMonth: description: The card expiry month. Only collect raw card data if you are @@ -3316,8 +3386,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -3535,53 +3611,20 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Success** \u2013 Indicates that the balance check was successful.\n\ + * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\ + \ have enough balance to pay the amount in the request, or that the currency\ + \ of the balance on the card did not match the currency of the requested\ + \ amount.\n* **Failed** \u2013 Indicates that the balance check failed." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success + - NotEnoughBalance + - Failed type: string required: - balance + - resultCode CheckoutBankTransferAction: additionalProperties: false properties: @@ -3638,7 +3681,11 @@ components: description: A unique reference of the cancellation request. type: string resultCode: - description: The result of the cancellation request. + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Received** \u2013 Indicates the cancellation has successfully been\ + \ received by Adyen, and will be processed." + enum: + - Received type: string required: - pspReference @@ -3714,55 +3761,16 @@ components: description: The remaining amount in the order. $ref: '#/components/schemas/Amount' resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the order creation request.\n The value is always\ + \ **Success**." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success type: string required: - remainingAmount - expiresAt - orderData + - resultCode CheckoutDonationAction: additionalProperties: false properties: @@ -5280,8 +5288,10 @@ components: properties: action: x-addedInVersion: 49 - description: Action to be taken for completing the payment. - $ref: '#/components/schemas/CheckoutThreeDS2ChallengeAction' + description: Action to be taken for completing the payment. When returned, + only the 3D Secure action is needed in most cases. + oneOf: + - $ref: '#/components/schemas/CheckoutRedirectAction' additionalData: additionalProperties: type: string @@ -5969,8 +5979,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -6596,8 +6612,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -7907,11 +7929,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -8438,6 +8460,21 @@ components: BasicAuth: scheme: basic type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string examples: generic-400: summary: Response code 400. Bad request. @@ -8475,10 +8512,38 @@ components: message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' + get-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A patch-paymentLinks-linkId-basic: summary: Update the status of a payment link value: status: expired + patch-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: expired + url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -8487,6 +8552,17 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178914061985' + resultCode: Success + expiresAt: '2021-04-09T14:16:46Z' + orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== + reference: shopper-reference-ekvL83 + remainingAmount: + currency: EUR + value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -8494,6 +8570,11 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8816178914079738' + resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -8501,6 +8582,13 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com + post-originKeys-basic-200: + summary: Example response for request 'basic' + value: + originKeys: + https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw + https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc + https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -8527,6 +8615,15 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP + post-paymentLinks-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 1250 + expiresAt: '2021-04-09T14:17:31Z' + reference: shopper-reference-ekvL83 + url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -8544,10 +8641,1471 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix-200: + summary: Example response for request 'plastix' + value: + additionalData: + nonScheme.transactionLimit: '5000' + nonScheme.transactionLimitCcy: EUR + pspReference: 851617891188737F + resultCode: Success + balance: + currency: EUR + value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic-200: + summary: Example response for request 'basic' + value: + paymentMethods: + - details: + - details: + - key: ownerName + type: text + - key: bankLocationId + type: text + - key: bankAccountNumber + type: text + key: bankAccount + type: bankAccount + name: ACH Direct Debit + type: ach + - name: Adyen Voucher + type: adyen_test_voucher + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: Afterpay + type: afterpaytouch + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: AliPay + type: alipay + - name: AliPay HK + type: alipay_hk + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Credit Card via AsiaPay + type: asiapay + - name: China UnionPay + type: asiapay_unionpay + - name: Baby Gift Card + type: babygiftcard + - name: Baloto + type: baloto + - name: BancNet + type: bancnet + - name: Bank Transfer (BG) + type: bankTransfer_BG + - name: Bank Transfer (CH) + type: bankTransfer_CH + - name: Bank Transfer (DE) + type: bankTransfer_DE + - name: Bank Transfer (FI) + type: bankTransfer_FI + - name: Bank Transfer (GB) + type: bankTransfer_GB + - name: Bank Transfer (HU) + type: bankTransfer_HU + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bank Transfer (IE) + type: bankTransfer_IE + - name: Electronic Bank Transfer (MX) + type: bankTransfer_MX_linked + - name: Bank Transfer (MX) + type: bankTransfer_MX_offline + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Bank Transfer (PL) + type: bankTransfer_PL + - name: Bank Transfer (SE) + type: bankTransfer_SE + - name: Bank Transfer (US) + type: bankTransfer_US + - name: Payconiq by Bancontact + type: bcmc_mobile + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: 99Bill + type: bill99 + - details: + - items: + - id: AUB_DIRECT + name: AU Small Finance Bank + - id: ALB_DIRECT + name: 'Allahabad Bank ' + - id: APG_DIRECT + name: Andhra Pragathi Grameena Bank + - id: BDN_DIRECT + name: Bandhan bank + - id: BBK_DIRECT + name: Bank of Bahrain and Kuwait + - id: BBR_DIRECT + name: Bank of Baroda - Retail Banking + - id: BCB_DIRECT + name: 'Bassien Catholic Co-Operative Bank ' + - id: CNB_DIRECT + name: Canara Bank + - id: SYD_DIRECT + name: Canara Bank (e-Syndicate) + - id: CSB_DIRECT + name: Catholic Syrian Bank + - id: CBI_DIRECT + name: Central Bank of India + - id: CUB_DIRECT + name: City Union Bank + - id: COB_DIRECT + name: Cosmos Bank + - id: DEN_DIRECT + name: Dena Bank + - id: DBK_DIRECT + name: Deutsche Bank + - id: DCB_DIRECT + name: Development Credit Bank + - id: DLB_DIRECT + name: Dhanlakshmi Bank - Retail Net Banking + - id: ESF_DIRECT + name: ESAF Small Finance Bank + - id: EQB_DIRECT + name: Equitas Small Finance Bank + - id: FBK_DIRECT + name: Federal Bank + - id: FNC_DIRECT + name: Fincare Bank + - id: HDF_DIRECT + name: HDFC Bank + - id: ICI_DIRECT + name: 'ICICI Bank ' + - id: IDB_DIRECT + name: IDBI Bank - Retail Net Banking + - id: IDN_DIRECT + name: IDFC FIRST Bank + - id: INB_DIRECT + name: Indian Bank + - id: IOB_DIRECT + name: Indian Overseas Bank + - id: IDS_DIRECT + name: IndusInd Bank + - id: JKB_DIRECT + name: Jammu & Kashmir Bank + - id: JNB_DIRECT + name: Jana Small Finance Bank + - id: JSB_DIRECT + name: Janata Sahakari Bank Ltd Pune + - id: KJB_DIRECT + name: Kalyan Janata Sahakari Bank + - id: KBL_DIRECT + name: Karnataka Bank Ltd + - id: KVB_DIRECT + name: Karur Vysya Bank + - id: 162_DIRECT + name: Kotak Bank + - id: LVR_DIRECT + name: Laxmi Vilas Bank - Retail + - id: NKB_DIRECT + name: NKGSB Co-op Bank + - id: NEB_DIRECT + name: North East Small Finance Bank + - id: OBC_DIRECT + name: PNB (Erstwhile-Oriental Bank of Commerce) + - id: UNI_DIRECT + name: PNB (Erstwhile-United Bank of India) + - id: PMC_DIRECT + name: Punjab & Maharastra Co-op Bank + - id: PSB_DIRECT + name: Punjab & Sind Bank + - id: CPN_DIRECT + name: 'Punjab National Bank - Corporate ' + - id: PNB_DIRECT + name: Punjab National Bank - Retail Banking + - id: RBL_DIRECT + name: RBL Bank Limited + - id: SWB_DIRECT + name: Saraswat Bank + - id: SHB_DIRECT + name: Shivalik Mercantile Cooperative Bank Ltd + - id: SIB_DIRECT + name: South Indian Bank + - id: SCB_DIRECT + name: Standard Chartered Bank + - id: SBI_DIRECT + name: State Bank of India + - id: SRB_DIRECT + name: Suryoday Small Finance Bank + - id: TJB_DIRECT + name: TJSB Bank + - id: TNC_DIRECT + name: Tamil Nadu State Co-operative Bank + - id: TMB_DIRECT + name: Tamilnad Mercantile Bank Ltd + - id: TBB_DIRECT + name: Thane Bharat Sahakari Bank Ltd + - id: MSB_DIRECT + name: The Mehsana Urban Co Op Bank Ltd + - id: UCO_DIRECT + name: UCO Bank + - id: UBI_DIRECT + name: Union Bank of India + - id: ADB_DIRECT + name: Union Bank of India (Erstwhile Andhra Bank) + - id: CRP_DIRECT + name: Union Bank of India (Erstwhile Corporation Bank) + - id: VRB_DIRECT + name: Varachha Co-operative Bank Limited + - id: VJB_DIRECT + name: Vijaya Bank + - id: YBK_DIRECT + name: Yes Bank + - id: ZOB_DIRECT + name: Zoroastrian Co-operative Bank Limited + - id: DBS_DIRECT + name: digibank by DBS + key: issuer + type: select + name: Online Banking India + type: billdesk_online + - name: UPI + type: billdesk_upi + - details: + - items: + - id: DCW_DIRECT + name: DCB Cippy + - id: ICC_DIRECT + name: ICC Cash Card + - id: OXY_DIRECT + name: Oxigen Wallet + - id: PCH_DIRECT + name: Pay World Money + key: issuer + type: select + name: Wallets India + type: billdesk_wallet + - name: Blik + type: blik + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Boleto + type: boleto + - name: Boleto Bancario + type: boletobancario_santander + - name: Bradesco + type: bradesco + - name: Cash-Ticket + type: cashticket + - name: CashU + type: cashu + - name: CCAvenue + type: ccavenue + - name: Mula Checkout + type: cellulant + - name: Chasin Giftcard + type: chasingiftcard + - name: Clearpay + type: clearpay + - name: ClickandBuy + type: clickandbuy + - name: Paiement en 3 fois par Cartes Bancaires + type: cofinoga_3xcb + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: DANA + type: dana + - name: DineroMail + type: dineromail + - name: Online bank transfer. + type: directEbanking + - name: Direct Debit Brazil - Banco do Brazil + type: directdebit_BR_bancodobrasil + - name: Direct Debit Brazil - Bradesco + type: directdebit_BR_bradesco + - name: Direct Debit Brazil - Caixa Economica Federal + type: directdebit_BR_caixa + - name: Direct Debit Brazil - HSBC + type: directdebit_BR_hsbc + - name: Direct Debit Brazil - Itau + type: directdebit_BR_itau + - name: Direct Debit Brazil - Santander + type: directdebit_BR_santander + - name: BACS Direct Debit + type: directdebit_GB + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Alfamart + type: doku_alfamart + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BCA Bank Transfer + type: doku_bca_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BNI VA + type: doku_bni_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BRI VA + type: doku_bri_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: CIMB VA + type: doku_cimb_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Danamon VA + type: doku_danamon_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Indomaret + type: doku_indomaret + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Mandiri VA + type: doku_mandiri_va + - details: + - key: ovoId + type: text + name: OVO + type: doku_ovo + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Bank Transfer + type: doku_permata_lite_atm + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: DOKU wallet + type: doku_wallet + - details: + - items: + - id: '66' + name: Bank Nowy BFG S.A. + - id: '92' + name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" + - id: '11' + name: Bank transfer / postal + - id: '74' + name: "Banki Sp\xF3\u0142dzielcze" + - id: '73' + name: BLIK + - id: '90' + name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" + - id: '59' + name: CinkciarzPAY + - id: '87' + name: Credit Agricole PBL + - id: '83' + name: EnveloBank + - id: '76' + name: Getin Bank PBL + - id: '81' + name: Idea Cloud + - id: '7' + name: ING Corporate customers + - id: '93' + name: Kasa Stefczyka + - id: '44' + name: "Millennium - P\u0142atno\u015Bci Internetowe" + - id: '10' + name: Millennium Corporate customers + - id: '68' + name: mRaty + - id: '1' + name: mTransfer + - id: '91' + name: Nest Bank + - id: '80' + name: Noble Pay + - id: '50' + name: Pay Way Toyota Bank + - id: '45' + name: Pay with Alior Bank + - id: '36' + name: Pekao24Przelew + - id: '70' + name: Pocztowy24 + - id: '6' + name: Przelew24 + - id: '46' + name: "P\u0142ac\u0119 z Citi Handlowy" + - id: '38' + name: "P\u0142ac\u0119 z ING" + - id: '2' + name: "P\u0142ac\u0119 z Inteligo" + - id: '4' + name: "P\u0142ac\u0119 z iPKO" + - id: '75' + name: "P\u0142ac\u0119 z Plus Bank" + - id: '51' + name: "P\u0142a\u0107 z BO\u015A" + - id: '55' + name: Raty z Alior Bankiem PLN + - id: '89' + name: Santander + - id: '52' + name: SkyCash + key: issuer + type: select + name: Local Polish Payment Methods + type: dotpay + - name: Dragonpay Prepaid Credits + type: dragonpay_credits + - name: Online Banking + type: dragonpay_ebanking + - name: GCash + type: dragonpay_gcash + - name: Over The Counter Banks + type: dragonpay_otc_banking + - name: OTC non-Bank via Dragonpay + type: dragonpay_otc_non_banking + - name: Convenience Stores + type: dragonpay_otc_philippines + - name: 7/11 + type: dragonpay_seveneleven + - name: eagleeye_voucher + type: eagleeye_voucher + - name: Finnish E-Banking + type: ebanking_FI + - name: Pay-easy ATM + type: econtext_atm + - name: Online Banking + type: econtext_online + - name: 7-Eleven + type: econtext_seven_eleven + - name: Convenience Stores + type: econtext_stores + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Lastschrift (ELV) + type: elv + - details: + - items: + - id: '231' + name: POP Pankki + - id: '551' + name: "Komer\u010Dn\xED banka" + - id: '232' + name: Aktia + - id: '552' + name: Raiffeisen + - id: '233' + name: "S\xE4\xE4st\xF6pankki" + - id: '750' + name: Swedbank + - id: '211' + name: Nordea + - id: '553' + name: "\u010CSOB" + - id: '234' + name: S-Pankki + - id: '751' + name: SEB + - id: '554' + name: Moneta + - id: '235' + name: OmaSP + - id: '752' + name: Nordea + - id: '213' + name: Op-Pohjola + - id: '555' + name: UniCredit + - id: '753' + name: LHV + - id: '556' + name: Fio + - id: '557' + name: mBank + - id: '216' + name: Handelsbanken + - id: '558' + name: Air Bank + - id: '260' + name: "L\xE4nsf\xF6rs\xE4kringar" + - id: '240' + name: BankDeposit + - id: '265' + name: Sparbanken + - id: '640' + name: BankDeposit + - id: '200' + name: "\xC5landsbanken" + - id: '940' + name: Swedbank + - id: '500' + name: "\u010Cesk\xE1 spo\u0159itelna" + - id: '720' + name: Swedbank + - id: '941' + name: SEB + - id: '204' + name: Danske Bank + - id: '721' + name: SEB + - id: '942' + name: Citadele + - id: '205' + name: Handelsbanken + - id: '722' + name: DNB + - id: '943' + name: DNB + - id: '206' + name: Nordea + - id: '723' + name: "\u0160iauli\u0173 bankas" + - id: '207' + name: SEB + - id: '724' + name: Nordea + - id: '505' + name: "Komer\u010Dn\xED banka" + - id: '208' + name: Skandiabanken + - id: '209' + name: Swedbank + key: issuer + type: select + name: Bank Payment + type: entercash + - name: Nationale Entertainment Card + type: entertainmentcard + - details: + - items: + - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 + name: Dolomitenbank + - id: ee9fc487-ebe0-486c-8101-17dce5141a67 + name: Raiffeissen Bankengruppe + - id: 6765e225-a0dc-4481-9666-e26303d4f221 + name: Hypo Tirol Bank AG + - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc + name: Sparda Bank Wien + - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f + name: Schoellerbank AG + - id: e2e97aaa-de4c-4e18-9431-d99790773433 + name: Volksbank Gruppe + - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 + name: Immo-Bank + - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 + name: Bank Austria + - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 + name: Easybank AG + - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a + name: VR-BankBraunau + - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 + name: Volkskreditbank + - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 + name: Erste Bank und Sparkassen + - id: ba7199cc-f057-42f2-9856-2378abf21638 + name: BAWAG P.S.K. Gruppe + key: issuer + type: select + name: EPS + type: eps + - name: Expert Cadeaukaart + type: expertgiftcard + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 3x Oney + type: facilypay_3x + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 4x Oney + type: facilypay_4x + - name: Fashioncheque + type: fashioncheque + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: Fawry + type: fawry + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Fonq Giftcard + type: fonqgiftcard + - name: Gall & Gall + type: gallgall + - name: GCash + type: gcash + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - details: + - key: bic + type: text + name: GiroPay + type: giropay + - name: Givex + type: givex + - name: Globe GCash + type: globegcash + - name: Goldsmiths Card + type: goldsmithscard + - name: GoPay Wallet + type: gopay_wallet + - name: OVO + type: grabpay_ID + - name: GrabPay + type: grabpay_PH + - name: GrabPay + type: grabpay_SG + - name: Hallmark Card + type: hallmarkcard + - name: HDFC + type: hdfc + - name: Hunkemoller Member Card + type: hmclub + - name: Hunkemoller Lingerie Card + type: hmlingerie + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - name: igive + type: igive + - name: Korean Account Transfer (IniPay) + type: inicisIniPay_accounttransfer + - name: Korean Credit Cards (IniPay) + type: inicisIniPay_creditcard + - name: Korean Mobile Phone (IniPay) + type: inicisIniPay_mobilephone + - name: Korean Virtual Account (IniPay) + type: inicisIniPay_virtualaccount + - name: Korean Account Transfer (Mobile) + type: inicisMobile_accounttransfer + - name: Korean Credit Cards (Mobile) + type: inicisMobile_creditcard + - name: Korean Mobile Phone (Mobile) + type: inicisMobile_mobilephone + - name: Korean Virtual Account (Mobile) + type: inicisMobile_virtualaccount + - name: Korean Credit Cards + type: inicis_creditcard + - name: "Interac\xAE Online" + type: interac + - name: Instant EFT + type: ipay + - name: iPay88 + type: ipay88 + - name: isracard + type: isracard + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: KakaoPay + type: kakaopay + - name: Karen Millen Card + type: karenmillen + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Bank Transfer + type: kcp_banktransfer + - name: "Korea\u2013issued cards" + type: kcp_creditcard + - name: PayCo + type: kcp_payco + - name: Virtual Account via KCP + type: kcp_va + - name: Pay later with Klarna. + type: klarna + - name: Pay over time with Klarna. + type: klarna_account + - name: Klarna B2B + type: klarna_b2b + - name: Pay now with Klarna. + type: klarna_paynow + - name: Leisure Card + type: leisurecard + - name: China Credit Card + type: lianlianpay_creditcard + - name: China Debit Card + type: lianlianpay_debitcard + - details: + - key: telephoneNumber + type: tel + name: China Online Banking - Credit Card + type: lianlianpay_ebanking_credit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '4031000' + name: Bank of Beijing + - id: '01040000' + name: Bank of China + - id: '03020000' + name: China Citic Bank + - id: '01050000' + name: China Construction Bank + - id: '03030000' + name: China Everbright Bank + - id: 03080000 + name: China Merchants Bank + - id: '03050000' + name: China Minsheng Banking Group + - id: '03040000' + name: Hua Xia Bank Co + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03070000' + name: PingAn Bank + - id: '1000000' + name: Postal Savings Bank of China + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Debit Card + type: lianlianpay_ebanking_debit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '01050000' + name: China Construction Bank + - id: 03080000 + name: China Merchants Bank + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03100000' + name: Shanghai Pudong Development Bank + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Enterprise + type: lianlianpay_ebanking_enterprise + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - name: Love2Shop GiftCard + type: love2shop + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: mada + type: mada + - name: Mappin & Webb Card + type: mappinwebbcard + - name: MB WAY + type: mbway + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: Mercado Pago + type: mercadopago + - name: MobilePay + type: mobilepay + - name: AliPay via Razer Merchant Services + type: molpay_alipay + - name: 7-Eleven + type: molpay_cash + - name: CIMB Virtual Account + type: molpay_cimb_va + - name: Malaysia E-Banking via Razer Merchant Services + type: molpay_ebanking_MY + - details: + - items: + - id: vtcpay-vietinbank + name: Vietinbank + - id: vtcpay-bidv + name: BIDV + - id: vtcpay-agribank + name: Agribank + - id: vtcpay-mb + name: MB Bank + - id: vtcpay-sacombank + name: Sacombank + - id: vtcpay-dongabank + name: DongABank + - id: vtcpay-maritimebank + name: MaritimeBank + - id: vtcpay-vietcombank + name: Vietcombank + - id: vtcpay-acb + name: ACB + - id: vtcpay-techcombank + name: Techcombank + key: issuer + type: select + name: Vietnam E-Banking + type: molpay_ebanking_VN + - details: + - items: + - id: fpx_bimb + name: Bank Islam + - id: fpx_uob + name: UOB Bank + - id: fpx_cimbclicks + name: CIMB Clicks + - id: fpx_kfh + name: Kuwait Finance House + - id: fpx_rhb + name: RHB Now + - id: fpx_abmb + name: Alliance Bank + - id: fpx_amb + name: Am Online + - id: fpx_hsbc + name: HSBC + - id: fpx_abb + name: Affin Bank + - id: fpx_ocbc + name: OCBC Bank + - id: fpx_pbb + name: Public Bank + - id: fpx_scb + name: Standard Chartered Bank + - id: fpx_bsn + name: Bank Simpanan Nasional + - id: fpx_mb2u + name: Maybank2u + - id: fpx_hlb + name: Hong Leong Connect + - id: fpx_bmmb + name: Bank Muamalat + - id: fpx_bkrm + name: Bank Rakyat + key: issuer + type: select + name: Malaysia E-Banking + type: molpay_ebanking_fpx_MY + - name: eNETS Debit + type: molpay_enetsd + - name: epay + type: molpay_epay + - name: Esapay + type: molpay_esapay + - name: MyClear FPX + type: molpay_fpx + - name: Maybank2u + type: molpay_maybank2u + - name: Nganluong + type: molpay_nganluong + - name: Tesco Lotus + type: molpay_paysbuy + - name: MOLPoints + type: molpay_points + - name: RHB Now + type: molpay_rhb + - name: SAM by SingPost + type: molpay_singpost + - name: MOLWallet + type: molpay_wallet + - name: MoMo ATM + type: momo_atm + - name: Momo Wallet + type: momo_wallet + - name: Moneybookers + type: moneybookers + - name: Multibanco + type: multibanco + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: BankAxess + type: netaxept_bankaxess + - name: NETELLER + type: neteller + - name: Onebip + type: onebip + - name: One Two Three + type: onetwothree + - name: Local Polish Payment Methods + type: onlineBanking_PL + - details: + - items: + - id: '1' + name: Model Bank v2 + key: issuer + type: select + name: Online banking + type: openbanking_UK + - name: Oxxo + type: oxxo + - name: Pathe Giftcard + type: pathegiftcard + - name: PayBright + type: paybright + - name: PayMaya Wallet + type: paymaya_wallet + - name: PayPal + type: paypal + - name: Paysafecard + type: paysafecard + - name: Payshop + type: payshop + - name: PayD AMT via Paythru + type: paythru_amt + - name: EFT via Paythru + type: paythru_eft + - name: PayTM + type: paytm + - details: + - key: virtualPaymentAddress + type: text + name: PayU UPI + type: payu_IN_upi + - name: EFT Pro via PayU + type: payu_ZA_eftpro + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: pix + type: pix + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Podium Card + type: podiumcard + - name: POLi + type: poli + - name: PPS + type: pps + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Illicado Gift Card + type: prosodie_illicado + - name: PSE + type: pse + - details: + - items: + - id: '+7' + name: RU + - id: '+9955' + name: GE + - id: '+507' + name: PA + - id: '+44' + name: GB + - id: '+992' + name: TJ + - id: '+370' + name: LT + - id: '+972' + name: IL + - id: '+996' + name: KG + - id: '+380' + name: UA + - id: '+84' + name: VN + - id: '+90' + name: TR + - id: '+994' + name: AZ + - id: '+374' + name: AM + - id: '+371' + name: LV + - id: '+91' + name: IN + - id: '+66' + name: TH + - id: '+373' + name: MD + - id: '+1' + name: US + - id: '+81' + name: JP + - id: '+998' + name: UZ + - id: '+77' + name: KZ + - id: '+375' + name: BY + - id: '+372' + name: EE + - id: '+40' + name: RO + - id: '+82' + name: KR + key: qiwiwallet.telephoneNumberPrefix + type: select + - key: qiwiwallet.telephoneNumber + type: text + name: Qiwi Wallet + type: qiwiwallet + - name: RatePay Invoice + type: ratepay + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: SafetyPay + type: safetypay + - name: SafetyPay Cash + type: safetypay_cash + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: SEB Direktbetalning + type: sebdirectpayment + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: 7-Eleven + type: seveneleven + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: Swish + type: swish + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: TenPay + type: tenpay + - name: The Sting Giftcard + type: thestinggiftcard + - name: Trustly + type: trustly + - name: Online Banking by Trustpay + type: trustpay + - name: TWINT + type: twint + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - details: + - key: virtualPaymentAddress + type: text + name: UPI Collect + type: upi_collect + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: telephoneNumber + optional: true + type: tel + name: Vipps + type: vipps + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: VVV Giftcard + type: vvvgiftcard + - name: Webshop Giftcard + type: webshopgiftcard + - name: WeChat Pay + type: wechatpayMiniProgram + - name: WeChat Pay + type: wechatpayQR + - name: WeChat Pay + type: wechatpayWeb + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: WOS Card + type: woscard + - name: Alfa-Click + type: yandex_alfaclick + - name: Pay using bank card + type: yandex_bank_card + - name: Cash terminals + type: yandex_cash + - name: Pay using installments + type: yandex_installments + - name: YooMoney + type: yandex_money + - name: Promsvyazbank + type: yandex_promsvyazbank + - name: Sberbank Online + type: yandex_sberbank + - name: WebMoney + type: yandex_webmoney + - name: Your Gift + type: yourgift + - name: Zip + type: zip post-paymentMethods-filtered: summary: Get payment methods based on the country and amount value: @@ -8557,6 +10115,313 @@ components: amount: currency: EUR value: 1000 + post-paymentMethods-filtered-200: + summary: Example response for request 'filtered' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentMethods-include-oneclick: summary: Get payment methods including stored card details value: @@ -8566,6 +10431,313 @@ components: currency: EUR value: 1000 shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-paymentMethods-include-oneclick-200: + summary: Example response for request 'include-oneclick' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -8599,6 +10771,10 @@ components: shopperLocale: nl_NL merchantAccount: YOUR_MERCHANT_ACCOUNT sdkVersion: 1.7.0 + post-paymentSession-enableOneClick-200: + summary: Example response for request 'enableOneClick' + value: + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-paymentSession-ios: summary: Set up a payment session (iOS) value: @@ -8614,62 +10790,10 @@ components: shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-split: - summary: Split a payment between a sub-merchant and a platform account + post-paymentSession-web-200: + summary: Example response for request 'web' value: - amount: - currency: EUR - value: 6200 - additionalData: - split.api: '1' - split.nrOfItems: '2' - split.totalAmount: '6200' - split.currencyCode: EUR - split.item1.amount: '6000' - split.item1.type: MarketPlace - split.item1.account: '151272963' - split.item1.reference: '6124145' - split.item1.description: 'Porcelain Doll: Eliza (20cm)' - split.item2.amount: '200' - split.item2.type: Commission - split.item2.reference: '6124146' - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Android - token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK - returnUrl: app:// - countryCode: NL - shopperLocale: nl_NL - sessionValidity: '2017-04-06T13:09:13Z' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-payments-applepay: - summary: Make an Apple Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: applepay - applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -8731,127 +10855,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields: - summary: Make a payment with 3D Secure 2 native authentication - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4212345678901237 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - holderName: John Smith - browserInfo: - userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 - Firefox/3.0 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct: - summary: Make a card payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedExpiryMonth: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedExpiryYear: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - storeDetails: true - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw: - summary: Tokenize card details for one-off payments - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - storeDetails: true - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay: - summary: Make a giropay payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: giropay - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-googlepay: - summary: Make a Google Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: paywithgoogle - googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... - merchantAccount: YourMerchantAccount - post-payments-ideal: - summary: Make an iDEAL payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: ideal - issuer: '1121' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-klarna: summary: Make a Klarna payment value: @@ -8917,73 +10920,7 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-oneclick-securedfields: - summary: Make a one-off payment with a token and CVV (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - recurringDetailReference: '8416038790273850' - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-recurring: - summary: Make a card payment with a token - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - storedPaymentMethodId: '8316038796685850' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: Subscription post-payments-result-basic: summary: Verify payment results value: payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK - post-payments-sofort: - summary: Make a Sofort payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: directEbanking - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-split: - summary: Split a payment between a sub-merchant and a platform account - value: - paymentMethod: - type: scheme - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' diff --git a/yaml/CheckoutService-v50.yaml b/yaml/CheckoutService-v50.yaml index 1538b68..7228595 100644 --- a/yaml/CheckoutService-v50.yaml +++ b/yaml/CheckoutService-v50.yaml @@ -81,13 +81,21 @@ paths: $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-basic-200' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -124,6 +132,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -150,13 +161,21 @@ paths: $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-cancel-basic-200' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -193,6 +212,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -223,13 +245,21 @@ paths: $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-originKeys-basic-200' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -266,6 +296,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -295,19 +328,30 @@ paths: $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/CreatePaymentLinkRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentLinks-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '201': content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResource' description: Created - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -344,6 +388,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -367,13 +414,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -410,6 +464,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -441,13 +498,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -484,6 +548,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -521,13 +588,25 @@ paths: $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentMethods-basic-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + filtered-200: + $ref: '#/components/examples/post-paymentMethods-filtered-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -564,6 +643,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -592,13 +674,21 @@ paths: $ref: '#/components/examples/post-paymentMethods-balance-basic' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + plastix-200: + $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -629,12 +719,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -661,10 +751,6 @@ paths: content: application/json: examples: - split: - $ref: '#/components/examples/post-paymentSession-split' - web: - $ref: '#/components/examples/post-paymentSession-web' android: $ref: '#/components/examples/post-paymentSession-android' ios: @@ -673,19 +759,26 @@ paths: $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick-200: + $ref: '#/components/examples/post-paymentSession-enableOneClick-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -701,9 +794,6 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -716,12 +806,12 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -743,44 +833,18 @@ paths: content: application/json: examples: - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' - giropay: - $ref: '#/components/examples/post-payments-giropay' - card-3d-secure-securedfields: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' - enableOneClick-raw: - $ref: '#/components/examples/post-payments-enableOneClick-raw' - applepay: - $ref: '#/components/examples/post-payments-applepay' - ideal: - $ref: '#/components/examples/post-payments-ideal' - oneclick-securedfields: - $ref: '#/components/examples/post-payments-oneclick-securedfields' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' - recurring: - $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' - sofort: - $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' card-3d-secure-direct: $ref: '#/components/examples/post-payments-card-3d-secure-direct' klarna: $ref: '#/components/examples/post-payments-klarna' - split: - $ref: '#/components/examples/post-payments-split' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' schema: $ref: '#/components/schemas/PaymentRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -788,48 +852,39 @@ paths: schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -851,6 +906,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DetailsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -858,6 +915,9 @@ paths: schema: $ref: '#/components/schemas/PaymentDetailsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -885,6 +945,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -910,6 +973,8 @@ paths: $ref: '#/components/examples/post-payments-result-basic' schema: $ref: '#/components/schemas/PaymentVerificationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -917,6 +982,9 @@ paths: schema: $ref: '#/components/schemas/PaymentVerificationResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -947,12 +1015,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -3069,19 +3137,19 @@ components: type: string encryptedCardNumber: description: The encrypted card number. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryMonth: description: The encrypted card expiry month. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryYear: description: The encrypted card expiry year. - maxLength: 7000 + maxLength: 10000 type: string encryptedSecurityCode: description: The encrypted card verification code. - maxLength: 7000 + maxLength: 10000 type: string expiryMonth: description: The card expiry month. Only collect raw card data if you are @@ -3335,8 +3403,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -3560,53 +3634,20 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Success** \u2013 Indicates that the balance check was successful.\n\ + * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\ + \ have enough balance to pay the amount in the request, or that the currency\ + \ of the balance on the card did not match the currency of the requested\ + \ amount.\n* **Failed** \u2013 Indicates that the balance check failed." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success + - NotEnoughBalance + - Failed type: string required: - balance + - resultCode CheckoutBankTransferAction: additionalProperties: false properties: @@ -3663,7 +3704,11 @@ components: description: A unique reference of the cancellation request. type: string resultCode: - description: The result of the cancellation request. + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Received** \u2013 Indicates the cancellation has successfully been\ + \ received by Adyen, and will be processed." + enum: + - Received type: string required: - pspReference @@ -3739,55 +3784,16 @@ components: description: The remaining amount in the order. $ref: '#/components/schemas/Amount' resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the order creation request.\n The value is always\ + \ **Success**." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success type: string required: - remainingAmount - expiresAt - orderData + - resultCode CheckoutDonationAction: additionalProperties: false properties: @@ -5310,8 +5316,10 @@ components: properties: action: x-addedInVersion: 49 - description: Action to be taken for completing the payment. - $ref: '#/components/schemas/CheckoutThreeDS2ChallengeAction' + description: Action to be taken for completing the payment. When returned, + only the 3D Secure action is needed in most cases. + oneOf: + - $ref: '#/components/schemas/CheckoutRedirectAction' additionalData: additionalProperties: type: string @@ -6004,8 +6012,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -6637,8 +6651,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -7954,11 +7974,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -8503,6 +8523,21 @@ components: BasicAuth: scheme: basic type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string examples: generic-400: summary: Response code 400. Bad request. @@ -8540,10 +8575,38 @@ components: message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' + get-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A patch-paymentLinks-linkId-basic: summary: Update the status of a payment link value: status: expired + patch-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: expired + url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -8552,6 +8615,17 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178914061985' + resultCode: Success + expiresAt: '2021-04-09T14:16:46Z' + orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== + reference: shopper-reference-ekvL83 + remainingAmount: + currency: EUR + value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -8559,6 +8633,11 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8816178914079738' + resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -8566,6 +8645,13 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com + post-originKeys-basic-200: + summary: Example response for request 'basic' + value: + originKeys: + https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw + https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc + https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -8592,6 +8678,15 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP + post-paymentLinks-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 1250 + expiresAt: '2021-04-09T14:17:31Z' + reference: shopper-reference-ekvL83 + url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -8609,10 +8704,1471 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix-200: + summary: Example response for request 'plastix' + value: + additionalData: + nonScheme.transactionLimit: '5000' + nonScheme.transactionLimitCcy: EUR + pspReference: 851617891188737F + resultCode: Success + balance: + currency: EUR + value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic-200: + summary: Example response for request 'basic' + value: + paymentMethods: + - details: + - details: + - key: ownerName + type: text + - key: bankLocationId + type: text + - key: bankAccountNumber + type: text + key: bankAccount + type: bankAccount + name: ACH Direct Debit + type: ach + - name: Adyen Voucher + type: adyen_test_voucher + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: Afterpay + type: afterpaytouch + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: AliPay + type: alipay + - name: AliPay HK + type: alipay_hk + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Credit Card via AsiaPay + type: asiapay + - name: China UnionPay + type: asiapay_unionpay + - name: Baby Gift Card + type: babygiftcard + - name: Baloto + type: baloto + - name: BancNet + type: bancnet + - name: Bank Transfer (BG) + type: bankTransfer_BG + - name: Bank Transfer (CH) + type: bankTransfer_CH + - name: Bank Transfer (DE) + type: bankTransfer_DE + - name: Bank Transfer (FI) + type: bankTransfer_FI + - name: Bank Transfer (GB) + type: bankTransfer_GB + - name: Bank Transfer (HU) + type: bankTransfer_HU + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bank Transfer (IE) + type: bankTransfer_IE + - name: Electronic Bank Transfer (MX) + type: bankTransfer_MX_linked + - name: Bank Transfer (MX) + type: bankTransfer_MX_offline + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Bank Transfer (PL) + type: bankTransfer_PL + - name: Bank Transfer (SE) + type: bankTransfer_SE + - name: Bank Transfer (US) + type: bankTransfer_US + - name: Payconiq by Bancontact + type: bcmc_mobile + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: 99Bill + type: bill99 + - details: + - items: + - id: AUB_DIRECT + name: AU Small Finance Bank + - id: ALB_DIRECT + name: 'Allahabad Bank ' + - id: APG_DIRECT + name: Andhra Pragathi Grameena Bank + - id: BDN_DIRECT + name: Bandhan bank + - id: BBK_DIRECT + name: Bank of Bahrain and Kuwait + - id: BBR_DIRECT + name: Bank of Baroda - Retail Banking + - id: BCB_DIRECT + name: 'Bassien Catholic Co-Operative Bank ' + - id: CNB_DIRECT + name: Canara Bank + - id: SYD_DIRECT + name: Canara Bank (e-Syndicate) + - id: CSB_DIRECT + name: Catholic Syrian Bank + - id: CBI_DIRECT + name: Central Bank of India + - id: CUB_DIRECT + name: City Union Bank + - id: COB_DIRECT + name: Cosmos Bank + - id: DEN_DIRECT + name: Dena Bank + - id: DBK_DIRECT + name: Deutsche Bank + - id: DCB_DIRECT + name: Development Credit Bank + - id: DLB_DIRECT + name: Dhanlakshmi Bank - Retail Net Banking + - id: ESF_DIRECT + name: ESAF Small Finance Bank + - id: EQB_DIRECT + name: Equitas Small Finance Bank + - id: FBK_DIRECT + name: Federal Bank + - id: FNC_DIRECT + name: Fincare Bank + - id: HDF_DIRECT + name: HDFC Bank + - id: ICI_DIRECT + name: 'ICICI Bank ' + - id: IDB_DIRECT + name: IDBI Bank - Retail Net Banking + - id: IDN_DIRECT + name: IDFC FIRST Bank + - id: INB_DIRECT + name: Indian Bank + - id: IOB_DIRECT + name: Indian Overseas Bank + - id: IDS_DIRECT + name: IndusInd Bank + - id: JKB_DIRECT + name: Jammu & Kashmir Bank + - id: JNB_DIRECT + name: Jana Small Finance Bank + - id: JSB_DIRECT + name: Janata Sahakari Bank Ltd Pune + - id: KJB_DIRECT + name: Kalyan Janata Sahakari Bank + - id: KBL_DIRECT + name: Karnataka Bank Ltd + - id: KVB_DIRECT + name: Karur Vysya Bank + - id: 162_DIRECT + name: Kotak Bank + - id: LVR_DIRECT + name: Laxmi Vilas Bank - Retail + - id: NKB_DIRECT + name: NKGSB Co-op Bank + - id: NEB_DIRECT + name: North East Small Finance Bank + - id: OBC_DIRECT + name: PNB (Erstwhile-Oriental Bank of Commerce) + - id: UNI_DIRECT + name: PNB (Erstwhile-United Bank of India) + - id: PMC_DIRECT + name: Punjab & Maharastra Co-op Bank + - id: PSB_DIRECT + name: Punjab & Sind Bank + - id: CPN_DIRECT + name: 'Punjab National Bank - Corporate ' + - id: PNB_DIRECT + name: Punjab National Bank - Retail Banking + - id: RBL_DIRECT + name: RBL Bank Limited + - id: SWB_DIRECT + name: Saraswat Bank + - id: SHB_DIRECT + name: Shivalik Mercantile Cooperative Bank Ltd + - id: SIB_DIRECT + name: South Indian Bank + - id: SCB_DIRECT + name: Standard Chartered Bank + - id: SBI_DIRECT + name: State Bank of India + - id: SRB_DIRECT + name: Suryoday Small Finance Bank + - id: TJB_DIRECT + name: TJSB Bank + - id: TNC_DIRECT + name: Tamil Nadu State Co-operative Bank + - id: TMB_DIRECT + name: Tamilnad Mercantile Bank Ltd + - id: TBB_DIRECT + name: Thane Bharat Sahakari Bank Ltd + - id: MSB_DIRECT + name: The Mehsana Urban Co Op Bank Ltd + - id: UCO_DIRECT + name: UCO Bank + - id: UBI_DIRECT + name: Union Bank of India + - id: ADB_DIRECT + name: Union Bank of India (Erstwhile Andhra Bank) + - id: CRP_DIRECT + name: Union Bank of India (Erstwhile Corporation Bank) + - id: VRB_DIRECT + name: Varachha Co-operative Bank Limited + - id: VJB_DIRECT + name: Vijaya Bank + - id: YBK_DIRECT + name: Yes Bank + - id: ZOB_DIRECT + name: Zoroastrian Co-operative Bank Limited + - id: DBS_DIRECT + name: digibank by DBS + key: issuer + type: select + name: Online Banking India + type: billdesk_online + - name: UPI + type: billdesk_upi + - details: + - items: + - id: DCW_DIRECT + name: DCB Cippy + - id: ICC_DIRECT + name: ICC Cash Card + - id: OXY_DIRECT + name: Oxigen Wallet + - id: PCH_DIRECT + name: Pay World Money + key: issuer + type: select + name: Wallets India + type: billdesk_wallet + - name: Blik + type: blik + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Boleto + type: boleto + - name: Boleto Bancario + type: boletobancario_santander + - name: Bradesco + type: bradesco + - name: Cash-Ticket + type: cashticket + - name: CashU + type: cashu + - name: CCAvenue + type: ccavenue + - name: Mula Checkout + type: cellulant + - name: Chasin Giftcard + type: chasingiftcard + - name: Clearpay + type: clearpay + - name: ClickandBuy + type: clickandbuy + - name: Paiement en 3 fois par Cartes Bancaires + type: cofinoga_3xcb + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: DANA + type: dana + - name: DineroMail + type: dineromail + - name: Online bank transfer. + type: directEbanking + - name: Direct Debit Brazil - Banco do Brazil + type: directdebit_BR_bancodobrasil + - name: Direct Debit Brazil - Bradesco + type: directdebit_BR_bradesco + - name: Direct Debit Brazil - Caixa Economica Federal + type: directdebit_BR_caixa + - name: Direct Debit Brazil - HSBC + type: directdebit_BR_hsbc + - name: Direct Debit Brazil - Itau + type: directdebit_BR_itau + - name: Direct Debit Brazil - Santander + type: directdebit_BR_santander + - name: BACS Direct Debit + type: directdebit_GB + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Alfamart + type: doku_alfamart + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BCA Bank Transfer + type: doku_bca_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BNI VA + type: doku_bni_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BRI VA + type: doku_bri_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: CIMB VA + type: doku_cimb_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Danamon VA + type: doku_danamon_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Indomaret + type: doku_indomaret + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Mandiri VA + type: doku_mandiri_va + - details: + - key: ovoId + type: text + name: OVO + type: doku_ovo + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Bank Transfer + type: doku_permata_lite_atm + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: DOKU wallet + type: doku_wallet + - details: + - items: + - id: '66' + name: Bank Nowy BFG S.A. + - id: '92' + name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" + - id: '11' + name: Bank transfer / postal + - id: '74' + name: "Banki Sp\xF3\u0142dzielcze" + - id: '73' + name: BLIK + - id: '90' + name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" + - id: '59' + name: CinkciarzPAY + - id: '87' + name: Credit Agricole PBL + - id: '83' + name: EnveloBank + - id: '76' + name: Getin Bank PBL + - id: '81' + name: Idea Cloud + - id: '7' + name: ING Corporate customers + - id: '93' + name: Kasa Stefczyka + - id: '44' + name: "Millennium - P\u0142atno\u015Bci Internetowe" + - id: '10' + name: Millennium Corporate customers + - id: '68' + name: mRaty + - id: '1' + name: mTransfer + - id: '91' + name: Nest Bank + - id: '80' + name: Noble Pay + - id: '50' + name: Pay Way Toyota Bank + - id: '45' + name: Pay with Alior Bank + - id: '36' + name: Pekao24Przelew + - id: '70' + name: Pocztowy24 + - id: '6' + name: Przelew24 + - id: '46' + name: "P\u0142ac\u0119 z Citi Handlowy" + - id: '38' + name: "P\u0142ac\u0119 z ING" + - id: '2' + name: "P\u0142ac\u0119 z Inteligo" + - id: '4' + name: "P\u0142ac\u0119 z iPKO" + - id: '75' + name: "P\u0142ac\u0119 z Plus Bank" + - id: '51' + name: "P\u0142a\u0107 z BO\u015A" + - id: '55' + name: Raty z Alior Bankiem PLN + - id: '89' + name: Santander + - id: '52' + name: SkyCash + key: issuer + type: select + name: Local Polish Payment Methods + type: dotpay + - name: Dragonpay Prepaid Credits + type: dragonpay_credits + - name: Online Banking + type: dragonpay_ebanking + - name: GCash + type: dragonpay_gcash + - name: Over The Counter Banks + type: dragonpay_otc_banking + - name: OTC non-Bank via Dragonpay + type: dragonpay_otc_non_banking + - name: Convenience Stores + type: dragonpay_otc_philippines + - name: 7/11 + type: dragonpay_seveneleven + - name: eagleeye_voucher + type: eagleeye_voucher + - name: Finnish E-Banking + type: ebanking_FI + - name: Pay-easy ATM + type: econtext_atm + - name: Online Banking + type: econtext_online + - name: 7-Eleven + type: econtext_seven_eleven + - name: Convenience Stores + type: econtext_stores + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Lastschrift (ELV) + type: elv + - details: + - items: + - id: '231' + name: POP Pankki + - id: '551' + name: "Komer\u010Dn\xED banka" + - id: '232' + name: Aktia + - id: '552' + name: Raiffeisen + - id: '233' + name: "S\xE4\xE4st\xF6pankki" + - id: '750' + name: Swedbank + - id: '211' + name: Nordea + - id: '553' + name: "\u010CSOB" + - id: '234' + name: S-Pankki + - id: '751' + name: SEB + - id: '554' + name: Moneta + - id: '235' + name: OmaSP + - id: '752' + name: Nordea + - id: '213' + name: Op-Pohjola + - id: '555' + name: UniCredit + - id: '753' + name: LHV + - id: '556' + name: Fio + - id: '557' + name: mBank + - id: '216' + name: Handelsbanken + - id: '558' + name: Air Bank + - id: '260' + name: "L\xE4nsf\xF6rs\xE4kringar" + - id: '240' + name: BankDeposit + - id: '265' + name: Sparbanken + - id: '640' + name: BankDeposit + - id: '200' + name: "\xC5landsbanken" + - id: '940' + name: Swedbank + - id: '500' + name: "\u010Cesk\xE1 spo\u0159itelna" + - id: '720' + name: Swedbank + - id: '941' + name: SEB + - id: '204' + name: Danske Bank + - id: '721' + name: SEB + - id: '942' + name: Citadele + - id: '205' + name: Handelsbanken + - id: '722' + name: DNB + - id: '943' + name: DNB + - id: '206' + name: Nordea + - id: '723' + name: "\u0160iauli\u0173 bankas" + - id: '207' + name: SEB + - id: '724' + name: Nordea + - id: '505' + name: "Komer\u010Dn\xED banka" + - id: '208' + name: Skandiabanken + - id: '209' + name: Swedbank + key: issuer + type: select + name: Bank Payment + type: entercash + - name: Nationale Entertainment Card + type: entertainmentcard + - details: + - items: + - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 + name: Dolomitenbank + - id: ee9fc487-ebe0-486c-8101-17dce5141a67 + name: Raiffeissen Bankengruppe + - id: 6765e225-a0dc-4481-9666-e26303d4f221 + name: Hypo Tirol Bank AG + - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc + name: Sparda Bank Wien + - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f + name: Schoellerbank AG + - id: e2e97aaa-de4c-4e18-9431-d99790773433 + name: Volksbank Gruppe + - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 + name: Immo-Bank + - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 + name: Bank Austria + - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 + name: Easybank AG + - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a + name: VR-BankBraunau + - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 + name: Volkskreditbank + - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 + name: Erste Bank und Sparkassen + - id: ba7199cc-f057-42f2-9856-2378abf21638 + name: BAWAG P.S.K. Gruppe + key: issuer + type: select + name: EPS + type: eps + - name: Expert Cadeaukaart + type: expertgiftcard + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 3x Oney + type: facilypay_3x + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 4x Oney + type: facilypay_4x + - name: Fashioncheque + type: fashioncheque + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: Fawry + type: fawry + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Fonq Giftcard + type: fonqgiftcard + - name: Gall & Gall + type: gallgall + - name: GCash + type: gcash + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - details: + - key: bic + type: text + name: GiroPay + type: giropay + - name: Givex + type: givex + - name: Globe GCash + type: globegcash + - name: Goldsmiths Card + type: goldsmithscard + - name: GoPay Wallet + type: gopay_wallet + - name: OVO + type: grabpay_ID + - name: GrabPay + type: grabpay_PH + - name: GrabPay + type: grabpay_SG + - name: Hallmark Card + type: hallmarkcard + - name: HDFC + type: hdfc + - name: Hunkemoller Member Card + type: hmclub + - name: Hunkemoller Lingerie Card + type: hmlingerie + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - name: igive + type: igive + - name: Korean Account Transfer (IniPay) + type: inicisIniPay_accounttransfer + - name: Korean Credit Cards (IniPay) + type: inicisIniPay_creditcard + - name: Korean Mobile Phone (IniPay) + type: inicisIniPay_mobilephone + - name: Korean Virtual Account (IniPay) + type: inicisIniPay_virtualaccount + - name: Korean Account Transfer (Mobile) + type: inicisMobile_accounttransfer + - name: Korean Credit Cards (Mobile) + type: inicisMobile_creditcard + - name: Korean Mobile Phone (Mobile) + type: inicisMobile_mobilephone + - name: Korean Virtual Account (Mobile) + type: inicisMobile_virtualaccount + - name: Korean Credit Cards + type: inicis_creditcard + - name: "Interac\xAE Online" + type: interac + - name: Instant EFT + type: ipay + - name: iPay88 + type: ipay88 + - name: isracard + type: isracard + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: KakaoPay + type: kakaopay + - name: Karen Millen Card + type: karenmillen + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Bank Transfer + type: kcp_banktransfer + - name: "Korea\u2013issued cards" + type: kcp_creditcard + - name: PayCo + type: kcp_payco + - name: Virtual Account via KCP + type: kcp_va + - name: Pay later with Klarna. + type: klarna + - name: Pay over time with Klarna. + type: klarna_account + - name: Klarna B2B + type: klarna_b2b + - name: Pay now with Klarna. + type: klarna_paynow + - name: Leisure Card + type: leisurecard + - name: China Credit Card + type: lianlianpay_creditcard + - name: China Debit Card + type: lianlianpay_debitcard + - details: + - key: telephoneNumber + type: tel + name: China Online Banking - Credit Card + type: lianlianpay_ebanking_credit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '4031000' + name: Bank of Beijing + - id: '01040000' + name: Bank of China + - id: '03020000' + name: China Citic Bank + - id: '01050000' + name: China Construction Bank + - id: '03030000' + name: China Everbright Bank + - id: 03080000 + name: China Merchants Bank + - id: '03050000' + name: China Minsheng Banking Group + - id: '03040000' + name: Hua Xia Bank Co + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03070000' + name: PingAn Bank + - id: '1000000' + name: Postal Savings Bank of China + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Debit Card + type: lianlianpay_ebanking_debit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '01050000' + name: China Construction Bank + - id: 03080000 + name: China Merchants Bank + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03100000' + name: Shanghai Pudong Development Bank + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Enterprise + type: lianlianpay_ebanking_enterprise + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - name: Love2Shop GiftCard + type: love2shop + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: mada + type: mada + - name: Mappin & Webb Card + type: mappinwebbcard + - name: MB WAY + type: mbway + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: Mercado Pago + type: mercadopago + - name: MobilePay + type: mobilepay + - name: AliPay via Razer Merchant Services + type: molpay_alipay + - name: 7-Eleven + type: molpay_cash + - name: CIMB Virtual Account + type: molpay_cimb_va + - name: Malaysia E-Banking via Razer Merchant Services + type: molpay_ebanking_MY + - details: + - items: + - id: vtcpay-vietinbank + name: Vietinbank + - id: vtcpay-bidv + name: BIDV + - id: vtcpay-agribank + name: Agribank + - id: vtcpay-mb + name: MB Bank + - id: vtcpay-sacombank + name: Sacombank + - id: vtcpay-dongabank + name: DongABank + - id: vtcpay-maritimebank + name: MaritimeBank + - id: vtcpay-vietcombank + name: Vietcombank + - id: vtcpay-acb + name: ACB + - id: vtcpay-techcombank + name: Techcombank + key: issuer + type: select + name: Vietnam E-Banking + type: molpay_ebanking_VN + - details: + - items: + - id: fpx_bimb + name: Bank Islam + - id: fpx_uob + name: UOB Bank + - id: fpx_cimbclicks + name: CIMB Clicks + - id: fpx_kfh + name: Kuwait Finance House + - id: fpx_rhb + name: RHB Now + - id: fpx_abmb + name: Alliance Bank + - id: fpx_amb + name: Am Online + - id: fpx_hsbc + name: HSBC + - id: fpx_abb + name: Affin Bank + - id: fpx_ocbc + name: OCBC Bank + - id: fpx_pbb + name: Public Bank + - id: fpx_scb + name: Standard Chartered Bank + - id: fpx_bsn + name: Bank Simpanan Nasional + - id: fpx_mb2u + name: Maybank2u + - id: fpx_hlb + name: Hong Leong Connect + - id: fpx_bmmb + name: Bank Muamalat + - id: fpx_bkrm + name: Bank Rakyat + key: issuer + type: select + name: Malaysia E-Banking + type: molpay_ebanking_fpx_MY + - name: eNETS Debit + type: molpay_enetsd + - name: epay + type: molpay_epay + - name: Esapay + type: molpay_esapay + - name: MyClear FPX + type: molpay_fpx + - name: Maybank2u + type: molpay_maybank2u + - name: Nganluong + type: molpay_nganluong + - name: Tesco Lotus + type: molpay_paysbuy + - name: MOLPoints + type: molpay_points + - name: RHB Now + type: molpay_rhb + - name: SAM by SingPost + type: molpay_singpost + - name: MOLWallet + type: molpay_wallet + - name: MoMo ATM + type: momo_atm + - name: Momo Wallet + type: momo_wallet + - name: Moneybookers + type: moneybookers + - name: Multibanco + type: multibanco + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: BankAxess + type: netaxept_bankaxess + - name: NETELLER + type: neteller + - name: Onebip + type: onebip + - name: One Two Three + type: onetwothree + - name: Local Polish Payment Methods + type: onlineBanking_PL + - details: + - items: + - id: '1' + name: Model Bank v2 + key: issuer + type: select + name: Online banking + type: openbanking_UK + - name: Oxxo + type: oxxo + - name: Pathe Giftcard + type: pathegiftcard + - name: PayBright + type: paybright + - name: PayMaya Wallet + type: paymaya_wallet + - name: PayPal + type: paypal + - name: Paysafecard + type: paysafecard + - name: Payshop + type: payshop + - name: PayD AMT via Paythru + type: paythru_amt + - name: EFT via Paythru + type: paythru_eft + - name: PayTM + type: paytm + - details: + - key: virtualPaymentAddress + type: text + name: PayU UPI + type: payu_IN_upi + - name: EFT Pro via PayU + type: payu_ZA_eftpro + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: pix + type: pix + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Podium Card + type: podiumcard + - name: POLi + type: poli + - name: PPS + type: pps + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Illicado Gift Card + type: prosodie_illicado + - name: PSE + type: pse + - details: + - items: + - id: '+7' + name: RU + - id: '+9955' + name: GE + - id: '+507' + name: PA + - id: '+44' + name: GB + - id: '+992' + name: TJ + - id: '+370' + name: LT + - id: '+972' + name: IL + - id: '+996' + name: KG + - id: '+380' + name: UA + - id: '+84' + name: VN + - id: '+90' + name: TR + - id: '+994' + name: AZ + - id: '+374' + name: AM + - id: '+371' + name: LV + - id: '+91' + name: IN + - id: '+66' + name: TH + - id: '+373' + name: MD + - id: '+1' + name: US + - id: '+81' + name: JP + - id: '+998' + name: UZ + - id: '+77' + name: KZ + - id: '+375' + name: BY + - id: '+372' + name: EE + - id: '+40' + name: RO + - id: '+82' + name: KR + key: qiwiwallet.telephoneNumberPrefix + type: select + - key: qiwiwallet.telephoneNumber + type: text + name: Qiwi Wallet + type: qiwiwallet + - name: RatePay Invoice + type: ratepay + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: SafetyPay + type: safetypay + - name: SafetyPay Cash + type: safetypay_cash + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: SEB Direktbetalning + type: sebdirectpayment + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: 7-Eleven + type: seveneleven + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: Swish + type: swish + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: TenPay + type: tenpay + - name: The Sting Giftcard + type: thestinggiftcard + - name: Trustly + type: trustly + - name: Online Banking by Trustpay + type: trustpay + - name: TWINT + type: twint + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - details: + - key: virtualPaymentAddress + type: text + name: UPI Collect + type: upi_collect + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: telephoneNumber + optional: true + type: tel + name: Vipps + type: vipps + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: VVV Giftcard + type: vvvgiftcard + - name: Webshop Giftcard + type: webshopgiftcard + - name: WeChat Pay + type: wechatpayMiniProgram + - name: WeChat Pay + type: wechatpayQR + - name: WeChat Pay + type: wechatpayWeb + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: WOS Card + type: woscard + - name: Alfa-Click + type: yandex_alfaclick + - name: Pay using bank card + type: yandex_bank_card + - name: Cash terminals + type: yandex_cash + - name: Pay using installments + type: yandex_installments + - name: YooMoney + type: yandex_money + - name: Promsvyazbank + type: yandex_promsvyazbank + - name: Sberbank Online + type: yandex_sberbank + - name: WebMoney + type: yandex_webmoney + - name: Your Gift + type: yourgift + - name: Zip + type: zip post-paymentMethods-filtered: summary: Get payment methods based on the country and amount value: @@ -8622,6 +10178,313 @@ components: amount: currency: EUR value: 1000 + post-paymentMethods-filtered-200: + summary: Example response for request 'filtered' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentMethods-include-oneclick: summary: Get payment methods including stored card details value: @@ -8631,6 +10494,313 @@ components: currency: EUR value: 1000 shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-paymentMethods-include-oneclick-200: + summary: Example response for request 'include-oneclick' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -8664,6 +10834,10 @@ components: shopperLocale: nl_NL merchantAccount: YOUR_MERCHANT_ACCOUNT sdkVersion: 1.7.0 + post-paymentSession-enableOneClick-200: + summary: Example response for request 'enableOneClick' + value: + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-paymentSession-ios: summary: Set up a payment session (iOS) value: @@ -8679,62 +10853,10 @@ components: shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-split: - summary: Split a payment between a sub-merchant and a platform account + post-paymentSession-web-200: + summary: Example response for request 'web' value: - amount: - currency: EUR - value: 6200 - additionalData: - split.api: '1' - split.nrOfItems: '2' - split.totalAmount: '6200' - split.currencyCode: EUR - split.item1.amount: '6000' - split.item1.type: MarketPlace - split.item1.account: '151272963' - split.item1.reference: '6124145' - split.item1.description: 'Porcelain Doll: Eliza (20cm)' - split.item2.amount: '200' - split.item2.type: Commission - split.item2.reference: '6124146' - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Android - token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK - returnUrl: app:// - countryCode: NL - shopperLocale: nl_NL - sessionValidity: '2017-04-06T13:09:13Z' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-payments-applepay: - summary: Make an Apple Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: applepay - applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -8796,131 +10918,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields: - summary: Make a payment with 3D Secure 2 native authentication - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4212345678901237 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - holderName: John Smith - browserInfo: - userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 - Firefox/3.0 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct: - summary: Make a card payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedExpiryMonth: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedExpiryYear: adyenjs_0_1_18$MT6ppy0FAMVMLH... - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw: - summary: Tokenize card details for one-off payments - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay: - summary: Make a giropay payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: giropay - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-googlepay: - summary: Make a Google Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: paywithgoogle - googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... - merchantAccount: YourMerchantAccount - post-payments-ideal: - summary: Make an iDEAL payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: ideal - issuer: '1121' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-klarna: summary: Make a Klarna payment value: @@ -8986,95 +10983,7 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-oneclick-securedfields: - summary: Make a one-off payment with a token and CVV (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - storedPaymentMethodId: '8416038790273850' - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: CardOnFile - post-payments-recurring: - summary: Make a card payment with a token - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - storedPaymentMethodId: '8316038796685850' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: Subscription post-payments-result-basic: summary: Verify payment results value: payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK - post-payments-sofort: - summary: Make a Sofort payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: directEbanking - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-split: - summary: Split a payment between a sub-merchant and a platform account - value: - paymentMethod: - type: scheme - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' - post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription diff --git a/yaml/CheckoutService-v51.yaml b/yaml/CheckoutService-v51.yaml index 501abb0..82e77cd 100644 --- a/yaml/CheckoutService-v51.yaml +++ b/yaml/CheckoutService-v51.yaml @@ -81,13 +81,21 @@ paths: $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-basic-200' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -124,6 +132,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -150,13 +161,21 @@ paths: $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-cancel-basic-200' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -193,6 +212,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -223,13 +245,21 @@ paths: $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-originKeys-basic-200' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -266,6 +296,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -295,19 +328,30 @@ paths: $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/CreatePaymentLinkRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentLinks-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '201': content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResource' description: Created - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -344,6 +388,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -367,13 +414,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -410,6 +464,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -441,13 +498,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -484,6 +548,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -521,13 +588,25 @@ paths: $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentMethods-basic-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + filtered-200: + $ref: '#/components/examples/post-paymentMethods-filtered-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -564,6 +643,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -592,13 +674,21 @@ paths: $ref: '#/components/examples/post-paymentMethods-balance-basic' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + plastix-200: + $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -629,12 +719,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -661,10 +751,6 @@ paths: content: application/json: examples: - split: - $ref: '#/components/examples/post-paymentSession-split' - web: - $ref: '#/components/examples/post-paymentSession-web' android: $ref: '#/components/examples/post-paymentSession-android' ios: @@ -673,19 +759,26 @@ paths: $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick-200: + $ref: '#/components/examples/post-paymentSession-enableOneClick-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -701,9 +794,6 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -716,12 +806,12 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -743,44 +833,18 @@ paths: content: application/json: examples: - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' - giropay: - $ref: '#/components/examples/post-payments-giropay' - card-3d-secure-securedfields: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' - enableOneClick-raw: - $ref: '#/components/examples/post-payments-enableOneClick-raw' - applepay: - $ref: '#/components/examples/post-payments-applepay' - ideal: - $ref: '#/components/examples/post-payments-ideal' - oneclick-securedfields: - $ref: '#/components/examples/post-payments-oneclick-securedfields' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' - recurring: - $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' - sofort: - $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' card-3d-secure-direct: $ref: '#/components/examples/post-payments-card-3d-secure-direct' klarna: $ref: '#/components/examples/post-payments-klarna' - split: - $ref: '#/components/examples/post-payments-split' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' schema: $ref: '#/components/schemas/PaymentRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -788,48 +852,39 @@ paths: schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -851,6 +906,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DetailsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -858,6 +915,9 @@ paths: schema: $ref: '#/components/schemas/PaymentDetailsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -885,6 +945,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -910,6 +973,8 @@ paths: $ref: '#/components/examples/post-payments-result-basic' schema: $ref: '#/components/schemas/PaymentVerificationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -917,6 +982,9 @@ paths: schema: $ref: '#/components/schemas/PaymentVerificationResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -947,12 +1015,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -3069,19 +3137,19 @@ components: type: string encryptedCardNumber: description: The encrypted card number. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryMonth: description: The encrypted card expiry month. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryYear: description: The encrypted card expiry year. - maxLength: 7000 + maxLength: 10000 type: string encryptedSecurityCode: description: The encrypted card verification code. - maxLength: 7000 + maxLength: 10000 type: string expiryMonth: description: The card expiry month. Only collect raw card data if you are @@ -3341,8 +3409,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -3566,53 +3640,20 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Success** \u2013 Indicates that the balance check was successful.\n\ + * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\ + \ have enough balance to pay the amount in the request, or that the currency\ + \ of the balance on the card did not match the currency of the requested\ + \ amount.\n* **Failed** \u2013 Indicates that the balance check failed." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success + - NotEnoughBalance + - Failed type: string required: - balance + - resultCode CheckoutBankTransferAction: additionalProperties: false properties: @@ -3669,7 +3710,11 @@ components: description: A unique reference of the cancellation request. type: string resultCode: - description: The result of the cancellation request. + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Received** \u2013 Indicates the cancellation has successfully been\ + \ received by Adyen, and will be processed." + enum: + - Received type: string required: - pspReference @@ -3745,55 +3790,16 @@ components: description: The remaining amount in the order. $ref: '#/components/schemas/Amount' resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the order creation request.\n The value is always\ + \ **Success**." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success type: string required: - remainingAmount - expiresAt - orderData + - resultCode CheckoutDonationAction: additionalProperties: false properties: @@ -5316,8 +5322,10 @@ components: properties: action: x-addedInVersion: 49 - description: Action to be taken for completing the payment. - $ref: '#/components/schemas/CheckoutThreeDS2ChallengeAction' + description: Action to be taken for completing the payment. When returned, + only the 3D Secure action is needed in most cases. + oneOf: + - $ref: '#/components/schemas/CheckoutRedirectAction' additionalData: additionalProperties: type: string @@ -6028,8 +6036,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -6667,8 +6681,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -7984,11 +8004,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -8533,6 +8553,21 @@ components: BasicAuth: scheme: basic type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string examples: generic-400: summary: Response code 400. Bad request. @@ -8570,10 +8605,38 @@ components: message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' + get-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A patch-paymentLinks-linkId-basic: summary: Update the status of a payment link value: status: expired + patch-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: expired + url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -8582,6 +8645,17 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178914061985' + resultCode: Success + expiresAt: '2021-04-09T14:16:46Z' + orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== + reference: shopper-reference-ekvL83 + remainingAmount: + currency: EUR + value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -8589,6 +8663,11 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8816178914079738' + resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -8596,6 +8675,13 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com + post-originKeys-basic-200: + summary: Example response for request 'basic' + value: + originKeys: + https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw + https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc + https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -8622,6 +8708,15 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP + post-paymentLinks-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 1250 + expiresAt: '2021-04-09T14:17:31Z' + reference: shopper-reference-ekvL83 + url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -8639,10 +8734,1471 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix-200: + summary: Example response for request 'plastix' + value: + additionalData: + nonScheme.transactionLimit: '5000' + nonScheme.transactionLimitCcy: EUR + pspReference: 851617891188737F + resultCode: Success + balance: + currency: EUR + value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic-200: + summary: Example response for request 'basic' + value: + paymentMethods: + - details: + - details: + - key: ownerName + type: text + - key: bankLocationId + type: text + - key: bankAccountNumber + type: text + key: bankAccount + type: bankAccount + name: ACH Direct Debit + type: ach + - name: Adyen Voucher + type: adyen_test_voucher + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: Afterpay + type: afterpaytouch + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: AliPay + type: alipay + - name: AliPay HK + type: alipay_hk + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Credit Card via AsiaPay + type: asiapay + - name: China UnionPay + type: asiapay_unionpay + - name: Baby Gift Card + type: babygiftcard + - name: Baloto + type: baloto + - name: BancNet + type: bancnet + - name: Bank Transfer (BG) + type: bankTransfer_BG + - name: Bank Transfer (CH) + type: bankTransfer_CH + - name: Bank Transfer (DE) + type: bankTransfer_DE + - name: Bank Transfer (FI) + type: bankTransfer_FI + - name: Bank Transfer (GB) + type: bankTransfer_GB + - name: Bank Transfer (HU) + type: bankTransfer_HU + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bank Transfer (IE) + type: bankTransfer_IE + - name: Electronic Bank Transfer (MX) + type: bankTransfer_MX_linked + - name: Bank Transfer (MX) + type: bankTransfer_MX_offline + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Bank Transfer (PL) + type: bankTransfer_PL + - name: Bank Transfer (SE) + type: bankTransfer_SE + - name: Bank Transfer (US) + type: bankTransfer_US + - name: Payconiq by Bancontact + type: bcmc_mobile + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: 99Bill + type: bill99 + - details: + - items: + - id: AUB_DIRECT + name: AU Small Finance Bank + - id: ALB_DIRECT + name: 'Allahabad Bank ' + - id: APG_DIRECT + name: Andhra Pragathi Grameena Bank + - id: BDN_DIRECT + name: Bandhan bank + - id: BBK_DIRECT + name: Bank of Bahrain and Kuwait + - id: BBR_DIRECT + name: Bank of Baroda - Retail Banking + - id: BCB_DIRECT + name: 'Bassien Catholic Co-Operative Bank ' + - id: CNB_DIRECT + name: Canara Bank + - id: SYD_DIRECT + name: Canara Bank (e-Syndicate) + - id: CSB_DIRECT + name: Catholic Syrian Bank + - id: CBI_DIRECT + name: Central Bank of India + - id: CUB_DIRECT + name: City Union Bank + - id: COB_DIRECT + name: Cosmos Bank + - id: DEN_DIRECT + name: Dena Bank + - id: DBK_DIRECT + name: Deutsche Bank + - id: DCB_DIRECT + name: Development Credit Bank + - id: DLB_DIRECT + name: Dhanlakshmi Bank - Retail Net Banking + - id: ESF_DIRECT + name: ESAF Small Finance Bank + - id: EQB_DIRECT + name: Equitas Small Finance Bank + - id: FBK_DIRECT + name: Federal Bank + - id: FNC_DIRECT + name: Fincare Bank + - id: HDF_DIRECT + name: HDFC Bank + - id: ICI_DIRECT + name: 'ICICI Bank ' + - id: IDB_DIRECT + name: IDBI Bank - Retail Net Banking + - id: IDN_DIRECT + name: IDFC FIRST Bank + - id: INB_DIRECT + name: Indian Bank + - id: IOB_DIRECT + name: Indian Overseas Bank + - id: IDS_DIRECT + name: IndusInd Bank + - id: JKB_DIRECT + name: Jammu & Kashmir Bank + - id: JNB_DIRECT + name: Jana Small Finance Bank + - id: JSB_DIRECT + name: Janata Sahakari Bank Ltd Pune + - id: KJB_DIRECT + name: Kalyan Janata Sahakari Bank + - id: KBL_DIRECT + name: Karnataka Bank Ltd + - id: KVB_DIRECT + name: Karur Vysya Bank + - id: 162_DIRECT + name: Kotak Bank + - id: LVR_DIRECT + name: Laxmi Vilas Bank - Retail + - id: NKB_DIRECT + name: NKGSB Co-op Bank + - id: NEB_DIRECT + name: North East Small Finance Bank + - id: OBC_DIRECT + name: PNB (Erstwhile-Oriental Bank of Commerce) + - id: UNI_DIRECT + name: PNB (Erstwhile-United Bank of India) + - id: PMC_DIRECT + name: Punjab & Maharastra Co-op Bank + - id: PSB_DIRECT + name: Punjab & Sind Bank + - id: CPN_DIRECT + name: 'Punjab National Bank - Corporate ' + - id: PNB_DIRECT + name: Punjab National Bank - Retail Banking + - id: RBL_DIRECT + name: RBL Bank Limited + - id: SWB_DIRECT + name: Saraswat Bank + - id: SHB_DIRECT + name: Shivalik Mercantile Cooperative Bank Ltd + - id: SIB_DIRECT + name: South Indian Bank + - id: SCB_DIRECT + name: Standard Chartered Bank + - id: SBI_DIRECT + name: State Bank of India + - id: SRB_DIRECT + name: Suryoday Small Finance Bank + - id: TJB_DIRECT + name: TJSB Bank + - id: TNC_DIRECT + name: Tamil Nadu State Co-operative Bank + - id: TMB_DIRECT + name: Tamilnad Mercantile Bank Ltd + - id: TBB_DIRECT + name: Thane Bharat Sahakari Bank Ltd + - id: MSB_DIRECT + name: The Mehsana Urban Co Op Bank Ltd + - id: UCO_DIRECT + name: UCO Bank + - id: UBI_DIRECT + name: Union Bank of India + - id: ADB_DIRECT + name: Union Bank of India (Erstwhile Andhra Bank) + - id: CRP_DIRECT + name: Union Bank of India (Erstwhile Corporation Bank) + - id: VRB_DIRECT + name: Varachha Co-operative Bank Limited + - id: VJB_DIRECT + name: Vijaya Bank + - id: YBK_DIRECT + name: Yes Bank + - id: ZOB_DIRECT + name: Zoroastrian Co-operative Bank Limited + - id: DBS_DIRECT + name: digibank by DBS + key: issuer + type: select + name: Online Banking India + type: billdesk_online + - name: UPI + type: billdesk_upi + - details: + - items: + - id: DCW_DIRECT + name: DCB Cippy + - id: ICC_DIRECT + name: ICC Cash Card + - id: OXY_DIRECT + name: Oxigen Wallet + - id: PCH_DIRECT + name: Pay World Money + key: issuer + type: select + name: Wallets India + type: billdesk_wallet + - name: Blik + type: blik + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Boleto + type: boleto + - name: Boleto Bancario + type: boletobancario_santander + - name: Bradesco + type: bradesco + - name: Cash-Ticket + type: cashticket + - name: CashU + type: cashu + - name: CCAvenue + type: ccavenue + - name: Mula Checkout + type: cellulant + - name: Chasin Giftcard + type: chasingiftcard + - name: Clearpay + type: clearpay + - name: ClickandBuy + type: clickandbuy + - name: Paiement en 3 fois par Cartes Bancaires + type: cofinoga_3xcb + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: DANA + type: dana + - name: DineroMail + type: dineromail + - name: Online bank transfer. + type: directEbanking + - name: Direct Debit Brazil - Banco do Brazil + type: directdebit_BR_bancodobrasil + - name: Direct Debit Brazil - Bradesco + type: directdebit_BR_bradesco + - name: Direct Debit Brazil - Caixa Economica Federal + type: directdebit_BR_caixa + - name: Direct Debit Brazil - HSBC + type: directdebit_BR_hsbc + - name: Direct Debit Brazil - Itau + type: directdebit_BR_itau + - name: Direct Debit Brazil - Santander + type: directdebit_BR_santander + - name: BACS Direct Debit + type: directdebit_GB + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Alfamart + type: doku_alfamart + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BCA Bank Transfer + type: doku_bca_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BNI VA + type: doku_bni_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BRI VA + type: doku_bri_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: CIMB VA + type: doku_cimb_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Danamon VA + type: doku_danamon_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Indomaret + type: doku_indomaret + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Mandiri VA + type: doku_mandiri_va + - details: + - key: ovoId + type: text + name: OVO + type: doku_ovo + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Bank Transfer + type: doku_permata_lite_atm + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: DOKU wallet + type: doku_wallet + - details: + - items: + - id: '66' + name: Bank Nowy BFG S.A. + - id: '92' + name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" + - id: '11' + name: Bank transfer / postal + - id: '74' + name: "Banki Sp\xF3\u0142dzielcze" + - id: '73' + name: BLIK + - id: '90' + name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" + - id: '59' + name: CinkciarzPAY + - id: '87' + name: Credit Agricole PBL + - id: '83' + name: EnveloBank + - id: '76' + name: Getin Bank PBL + - id: '81' + name: Idea Cloud + - id: '7' + name: ING Corporate customers + - id: '93' + name: Kasa Stefczyka + - id: '44' + name: "Millennium - P\u0142atno\u015Bci Internetowe" + - id: '10' + name: Millennium Corporate customers + - id: '68' + name: mRaty + - id: '1' + name: mTransfer + - id: '91' + name: Nest Bank + - id: '80' + name: Noble Pay + - id: '50' + name: Pay Way Toyota Bank + - id: '45' + name: Pay with Alior Bank + - id: '36' + name: Pekao24Przelew + - id: '70' + name: Pocztowy24 + - id: '6' + name: Przelew24 + - id: '46' + name: "P\u0142ac\u0119 z Citi Handlowy" + - id: '38' + name: "P\u0142ac\u0119 z ING" + - id: '2' + name: "P\u0142ac\u0119 z Inteligo" + - id: '4' + name: "P\u0142ac\u0119 z iPKO" + - id: '75' + name: "P\u0142ac\u0119 z Plus Bank" + - id: '51' + name: "P\u0142a\u0107 z BO\u015A" + - id: '55' + name: Raty z Alior Bankiem PLN + - id: '89' + name: Santander + - id: '52' + name: SkyCash + key: issuer + type: select + name: Local Polish Payment Methods + type: dotpay + - name: Dragonpay Prepaid Credits + type: dragonpay_credits + - name: Online Banking + type: dragonpay_ebanking + - name: GCash + type: dragonpay_gcash + - name: Over The Counter Banks + type: dragonpay_otc_banking + - name: OTC non-Bank via Dragonpay + type: dragonpay_otc_non_banking + - name: Convenience Stores + type: dragonpay_otc_philippines + - name: 7/11 + type: dragonpay_seveneleven + - name: eagleeye_voucher + type: eagleeye_voucher + - name: Finnish E-Banking + type: ebanking_FI + - name: Pay-easy ATM + type: econtext_atm + - name: Online Banking + type: econtext_online + - name: 7-Eleven + type: econtext_seven_eleven + - name: Convenience Stores + type: econtext_stores + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Lastschrift (ELV) + type: elv + - details: + - items: + - id: '231' + name: POP Pankki + - id: '551' + name: "Komer\u010Dn\xED banka" + - id: '232' + name: Aktia + - id: '552' + name: Raiffeisen + - id: '233' + name: "S\xE4\xE4st\xF6pankki" + - id: '750' + name: Swedbank + - id: '211' + name: Nordea + - id: '553' + name: "\u010CSOB" + - id: '234' + name: S-Pankki + - id: '751' + name: SEB + - id: '554' + name: Moneta + - id: '235' + name: OmaSP + - id: '752' + name: Nordea + - id: '213' + name: Op-Pohjola + - id: '555' + name: UniCredit + - id: '753' + name: LHV + - id: '556' + name: Fio + - id: '557' + name: mBank + - id: '216' + name: Handelsbanken + - id: '558' + name: Air Bank + - id: '260' + name: "L\xE4nsf\xF6rs\xE4kringar" + - id: '240' + name: BankDeposit + - id: '265' + name: Sparbanken + - id: '640' + name: BankDeposit + - id: '200' + name: "\xC5landsbanken" + - id: '940' + name: Swedbank + - id: '500' + name: "\u010Cesk\xE1 spo\u0159itelna" + - id: '720' + name: Swedbank + - id: '941' + name: SEB + - id: '204' + name: Danske Bank + - id: '721' + name: SEB + - id: '942' + name: Citadele + - id: '205' + name: Handelsbanken + - id: '722' + name: DNB + - id: '943' + name: DNB + - id: '206' + name: Nordea + - id: '723' + name: "\u0160iauli\u0173 bankas" + - id: '207' + name: SEB + - id: '724' + name: Nordea + - id: '505' + name: "Komer\u010Dn\xED banka" + - id: '208' + name: Skandiabanken + - id: '209' + name: Swedbank + key: issuer + type: select + name: Bank Payment + type: entercash + - name: Nationale Entertainment Card + type: entertainmentcard + - details: + - items: + - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 + name: Dolomitenbank + - id: ee9fc487-ebe0-486c-8101-17dce5141a67 + name: Raiffeissen Bankengruppe + - id: 6765e225-a0dc-4481-9666-e26303d4f221 + name: Hypo Tirol Bank AG + - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc + name: Sparda Bank Wien + - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f + name: Schoellerbank AG + - id: e2e97aaa-de4c-4e18-9431-d99790773433 + name: Volksbank Gruppe + - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 + name: Immo-Bank + - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 + name: Bank Austria + - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 + name: Easybank AG + - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a + name: VR-BankBraunau + - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 + name: Volkskreditbank + - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 + name: Erste Bank und Sparkassen + - id: ba7199cc-f057-42f2-9856-2378abf21638 + name: BAWAG P.S.K. Gruppe + key: issuer + type: select + name: EPS + type: eps + - name: Expert Cadeaukaart + type: expertgiftcard + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 3x Oney + type: facilypay_3x + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 4x Oney + type: facilypay_4x + - name: Fashioncheque + type: fashioncheque + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: Fawry + type: fawry + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Fonq Giftcard + type: fonqgiftcard + - name: Gall & Gall + type: gallgall + - name: GCash + type: gcash + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - details: + - key: bic + type: text + name: GiroPay + type: giropay + - name: Givex + type: givex + - name: Globe GCash + type: globegcash + - name: Goldsmiths Card + type: goldsmithscard + - name: GoPay Wallet + type: gopay_wallet + - name: OVO + type: grabpay_ID + - name: GrabPay + type: grabpay_PH + - name: GrabPay + type: grabpay_SG + - name: Hallmark Card + type: hallmarkcard + - name: HDFC + type: hdfc + - name: Hunkemoller Member Card + type: hmclub + - name: Hunkemoller Lingerie Card + type: hmlingerie + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - name: igive + type: igive + - name: Korean Account Transfer (IniPay) + type: inicisIniPay_accounttransfer + - name: Korean Credit Cards (IniPay) + type: inicisIniPay_creditcard + - name: Korean Mobile Phone (IniPay) + type: inicisIniPay_mobilephone + - name: Korean Virtual Account (IniPay) + type: inicisIniPay_virtualaccount + - name: Korean Account Transfer (Mobile) + type: inicisMobile_accounttransfer + - name: Korean Credit Cards (Mobile) + type: inicisMobile_creditcard + - name: Korean Mobile Phone (Mobile) + type: inicisMobile_mobilephone + - name: Korean Virtual Account (Mobile) + type: inicisMobile_virtualaccount + - name: Korean Credit Cards + type: inicis_creditcard + - name: "Interac\xAE Online" + type: interac + - name: Instant EFT + type: ipay + - name: iPay88 + type: ipay88 + - name: isracard + type: isracard + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: KakaoPay + type: kakaopay + - name: Karen Millen Card + type: karenmillen + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Bank Transfer + type: kcp_banktransfer + - name: "Korea\u2013issued cards" + type: kcp_creditcard + - name: PayCo + type: kcp_payco + - name: Virtual Account via KCP + type: kcp_va + - name: Pay later with Klarna. + type: klarna + - name: Pay over time with Klarna. + type: klarna_account + - name: Klarna B2B + type: klarna_b2b + - name: Pay now with Klarna. + type: klarna_paynow + - name: Leisure Card + type: leisurecard + - name: China Credit Card + type: lianlianpay_creditcard + - name: China Debit Card + type: lianlianpay_debitcard + - details: + - key: telephoneNumber + type: tel + name: China Online Banking - Credit Card + type: lianlianpay_ebanking_credit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '4031000' + name: Bank of Beijing + - id: '01040000' + name: Bank of China + - id: '03020000' + name: China Citic Bank + - id: '01050000' + name: China Construction Bank + - id: '03030000' + name: China Everbright Bank + - id: 03080000 + name: China Merchants Bank + - id: '03050000' + name: China Minsheng Banking Group + - id: '03040000' + name: Hua Xia Bank Co + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03070000' + name: PingAn Bank + - id: '1000000' + name: Postal Savings Bank of China + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Debit Card + type: lianlianpay_ebanking_debit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '01050000' + name: China Construction Bank + - id: 03080000 + name: China Merchants Bank + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03100000' + name: Shanghai Pudong Development Bank + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Enterprise + type: lianlianpay_ebanking_enterprise + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - name: Love2Shop GiftCard + type: love2shop + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: mada + type: mada + - name: Mappin & Webb Card + type: mappinwebbcard + - name: MB WAY + type: mbway + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: Mercado Pago + type: mercadopago + - name: MobilePay + type: mobilepay + - name: AliPay via Razer Merchant Services + type: molpay_alipay + - name: 7-Eleven + type: molpay_cash + - name: CIMB Virtual Account + type: molpay_cimb_va + - name: Malaysia E-Banking via Razer Merchant Services + type: molpay_ebanking_MY + - details: + - items: + - id: vtcpay-vietinbank + name: Vietinbank + - id: vtcpay-bidv + name: BIDV + - id: vtcpay-agribank + name: Agribank + - id: vtcpay-mb + name: MB Bank + - id: vtcpay-sacombank + name: Sacombank + - id: vtcpay-dongabank + name: DongABank + - id: vtcpay-maritimebank + name: MaritimeBank + - id: vtcpay-vietcombank + name: Vietcombank + - id: vtcpay-acb + name: ACB + - id: vtcpay-techcombank + name: Techcombank + key: issuer + type: select + name: Vietnam E-Banking + type: molpay_ebanking_VN + - details: + - items: + - id: fpx_bimb + name: Bank Islam + - id: fpx_uob + name: UOB Bank + - id: fpx_cimbclicks + name: CIMB Clicks + - id: fpx_kfh + name: Kuwait Finance House + - id: fpx_rhb + name: RHB Now + - id: fpx_abmb + name: Alliance Bank + - id: fpx_amb + name: Am Online + - id: fpx_hsbc + name: HSBC + - id: fpx_abb + name: Affin Bank + - id: fpx_ocbc + name: OCBC Bank + - id: fpx_pbb + name: Public Bank + - id: fpx_scb + name: Standard Chartered Bank + - id: fpx_bsn + name: Bank Simpanan Nasional + - id: fpx_mb2u + name: Maybank2u + - id: fpx_hlb + name: Hong Leong Connect + - id: fpx_bmmb + name: Bank Muamalat + - id: fpx_bkrm + name: Bank Rakyat + key: issuer + type: select + name: Malaysia E-Banking + type: molpay_ebanking_fpx_MY + - name: eNETS Debit + type: molpay_enetsd + - name: epay + type: molpay_epay + - name: Esapay + type: molpay_esapay + - name: MyClear FPX + type: molpay_fpx + - name: Maybank2u + type: molpay_maybank2u + - name: Nganluong + type: molpay_nganluong + - name: Tesco Lotus + type: molpay_paysbuy + - name: MOLPoints + type: molpay_points + - name: RHB Now + type: molpay_rhb + - name: SAM by SingPost + type: molpay_singpost + - name: MOLWallet + type: molpay_wallet + - name: MoMo ATM + type: momo_atm + - name: Momo Wallet + type: momo_wallet + - name: Moneybookers + type: moneybookers + - name: Multibanco + type: multibanco + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: BankAxess + type: netaxept_bankaxess + - name: NETELLER + type: neteller + - name: Onebip + type: onebip + - name: One Two Three + type: onetwothree + - name: Local Polish Payment Methods + type: onlineBanking_PL + - details: + - items: + - id: '1' + name: Model Bank v2 + key: issuer + type: select + name: Online banking + type: openbanking_UK + - name: Oxxo + type: oxxo + - name: Pathe Giftcard + type: pathegiftcard + - name: PayBright + type: paybright + - name: PayMaya Wallet + type: paymaya_wallet + - name: PayPal + type: paypal + - name: Paysafecard + type: paysafecard + - name: Payshop + type: payshop + - name: PayD AMT via Paythru + type: paythru_amt + - name: EFT via Paythru + type: paythru_eft + - name: PayTM + type: paytm + - details: + - key: virtualPaymentAddress + type: text + name: PayU UPI + type: payu_IN_upi + - name: EFT Pro via PayU + type: payu_ZA_eftpro + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: pix + type: pix + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Podium Card + type: podiumcard + - name: POLi + type: poli + - name: PPS + type: pps + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Illicado Gift Card + type: prosodie_illicado + - name: PSE + type: pse + - details: + - items: + - id: '+7' + name: RU + - id: '+9955' + name: GE + - id: '+507' + name: PA + - id: '+44' + name: GB + - id: '+992' + name: TJ + - id: '+370' + name: LT + - id: '+972' + name: IL + - id: '+996' + name: KG + - id: '+380' + name: UA + - id: '+84' + name: VN + - id: '+90' + name: TR + - id: '+994' + name: AZ + - id: '+374' + name: AM + - id: '+371' + name: LV + - id: '+91' + name: IN + - id: '+66' + name: TH + - id: '+373' + name: MD + - id: '+1' + name: US + - id: '+81' + name: JP + - id: '+998' + name: UZ + - id: '+77' + name: KZ + - id: '+375' + name: BY + - id: '+372' + name: EE + - id: '+40' + name: RO + - id: '+82' + name: KR + key: qiwiwallet.telephoneNumberPrefix + type: select + - key: qiwiwallet.telephoneNumber + type: text + name: Qiwi Wallet + type: qiwiwallet + - name: RatePay Invoice + type: ratepay + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: SafetyPay + type: safetypay + - name: SafetyPay Cash + type: safetypay_cash + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: SEB Direktbetalning + type: sebdirectpayment + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: 7-Eleven + type: seveneleven + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: Swish + type: swish + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: TenPay + type: tenpay + - name: The Sting Giftcard + type: thestinggiftcard + - name: Trustly + type: trustly + - name: Online Banking by Trustpay + type: trustpay + - name: TWINT + type: twint + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - details: + - key: virtualPaymentAddress + type: text + name: UPI Collect + type: upi_collect + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: telephoneNumber + optional: true + type: tel + name: Vipps + type: vipps + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: VVV Giftcard + type: vvvgiftcard + - name: Webshop Giftcard + type: webshopgiftcard + - name: WeChat Pay + type: wechatpayMiniProgram + - name: WeChat Pay + type: wechatpayQR + - name: WeChat Pay + type: wechatpayWeb + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: WOS Card + type: woscard + - name: Alfa-Click + type: yandex_alfaclick + - name: Pay using bank card + type: yandex_bank_card + - name: Cash terminals + type: yandex_cash + - name: Pay using installments + type: yandex_installments + - name: YooMoney + type: yandex_money + - name: Promsvyazbank + type: yandex_promsvyazbank + - name: Sberbank Online + type: yandex_sberbank + - name: WebMoney + type: yandex_webmoney + - name: Your Gift + type: yourgift + - name: Zip + type: zip post-paymentMethods-filtered: summary: Get payment methods based on the country and amount value: @@ -8652,6 +10208,313 @@ components: amount: currency: EUR value: 1000 + post-paymentMethods-filtered-200: + summary: Example response for request 'filtered' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentMethods-include-oneclick: summary: Get payment methods including stored card details value: @@ -8661,6 +10524,313 @@ components: currency: EUR value: 1000 shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-paymentMethods-include-oneclick-200: + summary: Example response for request 'include-oneclick' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -8694,6 +10864,10 @@ components: shopperLocale: nl_NL merchantAccount: YOUR_MERCHANT_ACCOUNT sdkVersion: 1.7.0 + post-paymentSession-enableOneClick-200: + summary: Example response for request 'enableOneClick' + value: + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-paymentSession-ios: summary: Set up a payment session (iOS) value: @@ -8709,62 +10883,10 @@ components: shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-split: - summary: Split a payment between a sub-merchant and a platform account + post-paymentSession-web-200: + summary: Example response for request 'web' value: - amount: - currency: EUR - value: 6200 - additionalData: - split.api: '1' - split.nrOfItems: '2' - split.totalAmount: '6200' - split.currencyCode: EUR - split.item1.amount: '6000' - split.item1.type: MarketPlace - split.item1.account: '151272963' - split.item1.reference: '6124145' - split.item1.description: 'Porcelain Doll: Eliza (20cm)' - split.item2.amount: '200' - split.item2.type: Commission - split.item2.reference: '6124146' - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Android - token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK - returnUrl: app:// - countryCode: NL - shopperLocale: nl_NL - sessionValidity: '2017-04-06T13:09:13Z' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-payments-applepay: - summary: Make an Apple Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: applepay - applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -8826,131 +10948,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields: - summary: Make a payment with 3D Secure 2 native authentication - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4212345678901237 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - holderName: John Smith - browserInfo: - userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 - Firefox/3.0 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct: - summary: Make a card payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw: - summary: Tokenize card details for one-off payments - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - storePaymentMethod: true - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay: - summary: Make a giropay payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: giropay - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-googlepay: - summary: Make a Google Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: paywithgoogle - googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... - merchantAccount: YourMerchantAccount - post-payments-ideal: - summary: Make an iDEAL payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: ideal - issuer: '1121' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-klarna: summary: Make a Klarna payment value: @@ -9016,95 +11013,7 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-oneclick-securedfields: - summary: Make a one-off payment with a token and CVV (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - storedPaymentMethodId: '8416038790273850' - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: CardOnFile - post-payments-recurring: - summary: Make a card payment with a token - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - storedPaymentMethodId: '8316038796685850' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: Subscription post-payments-result-basic: summary: Verify payment results value: payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK - post-payments-sofort: - summary: Make a Sofort payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: directEbanking - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-split: - summary: Split a payment between a sub-merchant and a platform account - value: - paymentMethod: - type: scheme - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' - post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT diff --git a/yaml/CheckoutService-v52.yaml b/yaml/CheckoutService-v52.yaml index b49bdbf..33db36c 100644 --- a/yaml/CheckoutService-v52.yaml +++ b/yaml/CheckoutService-v52.yaml @@ -81,13 +81,21 @@ paths: $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-basic-200' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -124,6 +132,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -150,13 +161,21 @@ paths: $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-cancel-basic-200' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -193,6 +212,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -223,13 +245,21 @@ paths: $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-originKeys-basic-200' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -266,6 +296,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -295,19 +328,30 @@ paths: $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/CreatePaymentLinkRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentLinks-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '201': content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResource' description: Created - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -344,6 +388,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -367,13 +414,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -410,6 +464,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -441,13 +498,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -484,6 +548,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -521,13 +588,25 @@ paths: $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentMethods-basic-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + filtered-200: + $ref: '#/components/examples/post-paymentMethods-filtered-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -564,6 +643,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -592,13 +674,21 @@ paths: $ref: '#/components/examples/post-paymentMethods-balance-basic' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + plastix-200: + $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -629,12 +719,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -661,10 +751,6 @@ paths: content: application/json: examples: - split: - $ref: '#/components/examples/post-paymentSession-split' - web: - $ref: '#/components/examples/post-paymentSession-web' android: $ref: '#/components/examples/post-paymentSession-android' ios: @@ -673,19 +759,26 @@ paths: $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick-200: + $ref: '#/components/examples/post-paymentSession-enableOneClick-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -701,9 +794,6 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -716,12 +806,12 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -743,44 +833,18 @@ paths: content: application/json: examples: - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' - giropay: - $ref: '#/components/examples/post-payments-giropay' - card-3d-secure-securedfields: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' - enableOneClick-raw: - $ref: '#/components/examples/post-payments-enableOneClick-raw' - applepay: - $ref: '#/components/examples/post-payments-applepay' - ideal: - $ref: '#/components/examples/post-payments-ideal' - oneclick-securedfields: - $ref: '#/components/examples/post-payments-oneclick-securedfields' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' - recurring: - $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' - sofort: - $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' card-3d-secure-direct: $ref: '#/components/examples/post-payments-card-3d-secure-direct' klarna: $ref: '#/components/examples/post-payments-klarna' - split: - $ref: '#/components/examples/post-payments-split' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' schema: $ref: '#/components/schemas/PaymentRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -788,48 +852,39 @@ paths: schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -851,6 +906,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DetailsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -858,6 +915,9 @@ paths: schema: $ref: '#/components/schemas/PaymentDetailsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -885,6 +945,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -910,6 +973,8 @@ paths: $ref: '#/components/examples/post-payments-result-basic' schema: $ref: '#/components/schemas/PaymentVerificationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -917,6 +982,9 @@ paths: schema: $ref: '#/components/schemas/PaymentVerificationResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -947,12 +1015,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -3069,19 +3137,19 @@ components: type: string encryptedCardNumber: description: The encrypted card number. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryMonth: description: The encrypted card expiry month. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryYear: description: The encrypted card expiry year. - maxLength: 7000 + maxLength: 10000 type: string encryptedSecurityCode: description: The encrypted card verification code. - maxLength: 7000 + maxLength: 10000 type: string expiryMonth: description: The card expiry month. Only collect raw card data if you are @@ -3341,8 +3409,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -3566,53 +3640,20 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Success** \u2013 Indicates that the balance check was successful.\n\ + * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\ + \ have enough balance to pay the amount in the request, or that the currency\ + \ of the balance on the card did not match the currency of the requested\ + \ amount.\n* **Failed** \u2013 Indicates that the balance check failed." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success + - NotEnoughBalance + - Failed type: string required: - balance + - resultCode CheckoutBankTransferAction: additionalProperties: false properties: @@ -3669,7 +3710,11 @@ components: description: A unique reference of the cancellation request. type: string resultCode: - description: The result of the cancellation request. + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Received** \u2013 Indicates the cancellation has successfully been\ + \ received by Adyen, and will be processed." + enum: + - Received type: string required: - pspReference @@ -3745,55 +3790,16 @@ components: description: The remaining amount in the order. $ref: '#/components/schemas/Amount' resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the order creation request.\n The value is always\ + \ **Success**." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success type: string required: - remainingAmount - expiresAt - orderData + - resultCode CheckoutDonationAction: additionalProperties: false properties: @@ -5316,8 +5322,10 @@ components: properties: action: x-addedInVersion: 49 - description: Action to be taken for completing the payment. - $ref: '#/components/schemas/CheckoutThreeDS2ChallengeAction' + description: Action to be taken for completing the payment. When returned, + only the 3D Secure action is needed in most cases. + oneOf: + - $ref: '#/components/schemas/CheckoutRedirectAction' additionalData: additionalProperties: type: string @@ -6032,8 +6040,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -6675,8 +6689,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -7992,11 +8012,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -8541,6 +8561,21 @@ components: BasicAuth: scheme: basic type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string examples: generic-400: summary: Response code 400. Bad request. @@ -8578,10 +8613,38 @@ components: message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' + get-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A patch-paymentLinks-linkId-basic: summary: Update the status of a payment link value: status: expired + patch-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: expired + url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -8590,6 +8653,17 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178914061985' + resultCode: Success + expiresAt: '2021-04-09T14:16:46Z' + orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== + reference: shopper-reference-ekvL83 + remainingAmount: + currency: EUR + value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -8597,6 +8671,11 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8816178914079738' + resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -8604,6 +8683,13 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com + post-originKeys-basic-200: + summary: Example response for request 'basic' + value: + originKeys: + https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw + https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc + https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -8630,6 +8716,15 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP + post-paymentLinks-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 1250 + expiresAt: '2021-04-09T14:17:31Z' + reference: shopper-reference-ekvL83 + url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -8647,10 +8742,1471 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix-200: + summary: Example response for request 'plastix' + value: + additionalData: + nonScheme.transactionLimit: '5000' + nonScheme.transactionLimitCcy: EUR + pspReference: 851617891188737F + resultCode: Success + balance: + currency: EUR + value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic-200: + summary: Example response for request 'basic' + value: + paymentMethods: + - details: + - details: + - key: ownerName + type: text + - key: bankLocationId + type: text + - key: bankAccountNumber + type: text + key: bankAccount + type: bankAccount + name: ACH Direct Debit + type: ach + - name: Adyen Voucher + type: adyen_test_voucher + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: Afterpay + type: afterpaytouch + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: AliPay + type: alipay + - name: AliPay HK + type: alipay_hk + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Credit Card via AsiaPay + type: asiapay + - name: China UnionPay + type: asiapay_unionpay + - name: Baby Gift Card + type: babygiftcard + - name: Baloto + type: baloto + - name: BancNet + type: bancnet + - name: Bank Transfer (BG) + type: bankTransfer_BG + - name: Bank Transfer (CH) + type: bankTransfer_CH + - name: Bank Transfer (DE) + type: bankTransfer_DE + - name: Bank Transfer (FI) + type: bankTransfer_FI + - name: Bank Transfer (GB) + type: bankTransfer_GB + - name: Bank Transfer (HU) + type: bankTransfer_HU + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bank Transfer (IE) + type: bankTransfer_IE + - name: Electronic Bank Transfer (MX) + type: bankTransfer_MX_linked + - name: Bank Transfer (MX) + type: bankTransfer_MX_offline + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Bank Transfer (PL) + type: bankTransfer_PL + - name: Bank Transfer (SE) + type: bankTransfer_SE + - name: Bank Transfer (US) + type: bankTransfer_US + - name: Payconiq by Bancontact + type: bcmc_mobile + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: 99Bill + type: bill99 + - details: + - items: + - id: AUB_DIRECT + name: AU Small Finance Bank + - id: ALB_DIRECT + name: 'Allahabad Bank ' + - id: APG_DIRECT + name: Andhra Pragathi Grameena Bank + - id: BDN_DIRECT + name: Bandhan bank + - id: BBK_DIRECT + name: Bank of Bahrain and Kuwait + - id: BBR_DIRECT + name: Bank of Baroda - Retail Banking + - id: BCB_DIRECT + name: 'Bassien Catholic Co-Operative Bank ' + - id: CNB_DIRECT + name: Canara Bank + - id: SYD_DIRECT + name: Canara Bank (e-Syndicate) + - id: CSB_DIRECT + name: Catholic Syrian Bank + - id: CBI_DIRECT + name: Central Bank of India + - id: CUB_DIRECT + name: City Union Bank + - id: COB_DIRECT + name: Cosmos Bank + - id: DEN_DIRECT + name: Dena Bank + - id: DBK_DIRECT + name: Deutsche Bank + - id: DCB_DIRECT + name: Development Credit Bank + - id: DLB_DIRECT + name: Dhanlakshmi Bank - Retail Net Banking + - id: ESF_DIRECT + name: ESAF Small Finance Bank + - id: EQB_DIRECT + name: Equitas Small Finance Bank + - id: FBK_DIRECT + name: Federal Bank + - id: FNC_DIRECT + name: Fincare Bank + - id: HDF_DIRECT + name: HDFC Bank + - id: ICI_DIRECT + name: 'ICICI Bank ' + - id: IDB_DIRECT + name: IDBI Bank - Retail Net Banking + - id: IDN_DIRECT + name: IDFC FIRST Bank + - id: INB_DIRECT + name: Indian Bank + - id: IOB_DIRECT + name: Indian Overseas Bank + - id: IDS_DIRECT + name: IndusInd Bank + - id: JKB_DIRECT + name: Jammu & Kashmir Bank + - id: JNB_DIRECT + name: Jana Small Finance Bank + - id: JSB_DIRECT + name: Janata Sahakari Bank Ltd Pune + - id: KJB_DIRECT + name: Kalyan Janata Sahakari Bank + - id: KBL_DIRECT + name: Karnataka Bank Ltd + - id: KVB_DIRECT + name: Karur Vysya Bank + - id: 162_DIRECT + name: Kotak Bank + - id: LVR_DIRECT + name: Laxmi Vilas Bank - Retail + - id: NKB_DIRECT + name: NKGSB Co-op Bank + - id: NEB_DIRECT + name: North East Small Finance Bank + - id: OBC_DIRECT + name: PNB (Erstwhile-Oriental Bank of Commerce) + - id: UNI_DIRECT + name: PNB (Erstwhile-United Bank of India) + - id: PMC_DIRECT + name: Punjab & Maharastra Co-op Bank + - id: PSB_DIRECT + name: Punjab & Sind Bank + - id: CPN_DIRECT + name: 'Punjab National Bank - Corporate ' + - id: PNB_DIRECT + name: Punjab National Bank - Retail Banking + - id: RBL_DIRECT + name: RBL Bank Limited + - id: SWB_DIRECT + name: Saraswat Bank + - id: SHB_DIRECT + name: Shivalik Mercantile Cooperative Bank Ltd + - id: SIB_DIRECT + name: South Indian Bank + - id: SCB_DIRECT + name: Standard Chartered Bank + - id: SBI_DIRECT + name: State Bank of India + - id: SRB_DIRECT + name: Suryoday Small Finance Bank + - id: TJB_DIRECT + name: TJSB Bank + - id: TNC_DIRECT + name: Tamil Nadu State Co-operative Bank + - id: TMB_DIRECT + name: Tamilnad Mercantile Bank Ltd + - id: TBB_DIRECT + name: Thane Bharat Sahakari Bank Ltd + - id: MSB_DIRECT + name: The Mehsana Urban Co Op Bank Ltd + - id: UCO_DIRECT + name: UCO Bank + - id: UBI_DIRECT + name: Union Bank of India + - id: ADB_DIRECT + name: Union Bank of India (Erstwhile Andhra Bank) + - id: CRP_DIRECT + name: Union Bank of India (Erstwhile Corporation Bank) + - id: VRB_DIRECT + name: Varachha Co-operative Bank Limited + - id: VJB_DIRECT + name: Vijaya Bank + - id: YBK_DIRECT + name: Yes Bank + - id: ZOB_DIRECT + name: Zoroastrian Co-operative Bank Limited + - id: DBS_DIRECT + name: digibank by DBS + key: issuer + type: select + name: Online Banking India + type: billdesk_online + - name: UPI + type: billdesk_upi + - details: + - items: + - id: DCW_DIRECT + name: DCB Cippy + - id: ICC_DIRECT + name: ICC Cash Card + - id: OXY_DIRECT + name: Oxigen Wallet + - id: PCH_DIRECT + name: Pay World Money + key: issuer + type: select + name: Wallets India + type: billdesk_wallet + - name: Blik + type: blik + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Boleto + type: boleto + - name: Boleto Bancario + type: boletobancario_santander + - name: Bradesco + type: bradesco + - name: Cash-Ticket + type: cashticket + - name: CashU + type: cashu + - name: CCAvenue + type: ccavenue + - name: Mula Checkout + type: cellulant + - name: Chasin Giftcard + type: chasingiftcard + - name: Clearpay + type: clearpay + - name: ClickandBuy + type: clickandbuy + - name: Paiement en 3 fois par Cartes Bancaires + type: cofinoga_3xcb + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: DANA + type: dana + - name: DineroMail + type: dineromail + - name: Online bank transfer. + type: directEbanking + - name: Direct Debit Brazil - Banco do Brazil + type: directdebit_BR_bancodobrasil + - name: Direct Debit Brazil - Bradesco + type: directdebit_BR_bradesco + - name: Direct Debit Brazil - Caixa Economica Federal + type: directdebit_BR_caixa + - name: Direct Debit Brazil - HSBC + type: directdebit_BR_hsbc + - name: Direct Debit Brazil - Itau + type: directdebit_BR_itau + - name: Direct Debit Brazil - Santander + type: directdebit_BR_santander + - name: BACS Direct Debit + type: directdebit_GB + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Alfamart + type: doku_alfamart + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BCA Bank Transfer + type: doku_bca_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BNI VA + type: doku_bni_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BRI VA + type: doku_bri_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: CIMB VA + type: doku_cimb_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Danamon VA + type: doku_danamon_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Indomaret + type: doku_indomaret + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Mandiri VA + type: doku_mandiri_va + - details: + - key: ovoId + type: text + name: OVO + type: doku_ovo + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Bank Transfer + type: doku_permata_lite_atm + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: DOKU wallet + type: doku_wallet + - details: + - items: + - id: '66' + name: Bank Nowy BFG S.A. + - id: '92' + name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" + - id: '11' + name: Bank transfer / postal + - id: '74' + name: "Banki Sp\xF3\u0142dzielcze" + - id: '73' + name: BLIK + - id: '90' + name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" + - id: '59' + name: CinkciarzPAY + - id: '87' + name: Credit Agricole PBL + - id: '83' + name: EnveloBank + - id: '76' + name: Getin Bank PBL + - id: '81' + name: Idea Cloud + - id: '7' + name: ING Corporate customers + - id: '93' + name: Kasa Stefczyka + - id: '44' + name: "Millennium - P\u0142atno\u015Bci Internetowe" + - id: '10' + name: Millennium Corporate customers + - id: '68' + name: mRaty + - id: '1' + name: mTransfer + - id: '91' + name: Nest Bank + - id: '80' + name: Noble Pay + - id: '50' + name: Pay Way Toyota Bank + - id: '45' + name: Pay with Alior Bank + - id: '36' + name: Pekao24Przelew + - id: '70' + name: Pocztowy24 + - id: '6' + name: Przelew24 + - id: '46' + name: "P\u0142ac\u0119 z Citi Handlowy" + - id: '38' + name: "P\u0142ac\u0119 z ING" + - id: '2' + name: "P\u0142ac\u0119 z Inteligo" + - id: '4' + name: "P\u0142ac\u0119 z iPKO" + - id: '75' + name: "P\u0142ac\u0119 z Plus Bank" + - id: '51' + name: "P\u0142a\u0107 z BO\u015A" + - id: '55' + name: Raty z Alior Bankiem PLN + - id: '89' + name: Santander + - id: '52' + name: SkyCash + key: issuer + type: select + name: Local Polish Payment Methods + type: dotpay + - name: Dragonpay Prepaid Credits + type: dragonpay_credits + - name: Online Banking + type: dragonpay_ebanking + - name: GCash + type: dragonpay_gcash + - name: Over The Counter Banks + type: dragonpay_otc_banking + - name: OTC non-Bank via Dragonpay + type: dragonpay_otc_non_banking + - name: Convenience Stores + type: dragonpay_otc_philippines + - name: 7/11 + type: dragonpay_seveneleven + - name: eagleeye_voucher + type: eagleeye_voucher + - name: Finnish E-Banking + type: ebanking_FI + - name: Pay-easy ATM + type: econtext_atm + - name: Online Banking + type: econtext_online + - name: 7-Eleven + type: econtext_seven_eleven + - name: Convenience Stores + type: econtext_stores + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Lastschrift (ELV) + type: elv + - details: + - items: + - id: '231' + name: POP Pankki + - id: '551' + name: "Komer\u010Dn\xED banka" + - id: '232' + name: Aktia + - id: '552' + name: Raiffeisen + - id: '233' + name: "S\xE4\xE4st\xF6pankki" + - id: '750' + name: Swedbank + - id: '211' + name: Nordea + - id: '553' + name: "\u010CSOB" + - id: '234' + name: S-Pankki + - id: '751' + name: SEB + - id: '554' + name: Moneta + - id: '235' + name: OmaSP + - id: '752' + name: Nordea + - id: '213' + name: Op-Pohjola + - id: '555' + name: UniCredit + - id: '753' + name: LHV + - id: '556' + name: Fio + - id: '557' + name: mBank + - id: '216' + name: Handelsbanken + - id: '558' + name: Air Bank + - id: '260' + name: "L\xE4nsf\xF6rs\xE4kringar" + - id: '240' + name: BankDeposit + - id: '265' + name: Sparbanken + - id: '640' + name: BankDeposit + - id: '200' + name: "\xC5landsbanken" + - id: '940' + name: Swedbank + - id: '500' + name: "\u010Cesk\xE1 spo\u0159itelna" + - id: '720' + name: Swedbank + - id: '941' + name: SEB + - id: '204' + name: Danske Bank + - id: '721' + name: SEB + - id: '942' + name: Citadele + - id: '205' + name: Handelsbanken + - id: '722' + name: DNB + - id: '943' + name: DNB + - id: '206' + name: Nordea + - id: '723' + name: "\u0160iauli\u0173 bankas" + - id: '207' + name: SEB + - id: '724' + name: Nordea + - id: '505' + name: "Komer\u010Dn\xED banka" + - id: '208' + name: Skandiabanken + - id: '209' + name: Swedbank + key: issuer + type: select + name: Bank Payment + type: entercash + - name: Nationale Entertainment Card + type: entertainmentcard + - details: + - items: + - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 + name: Dolomitenbank + - id: ee9fc487-ebe0-486c-8101-17dce5141a67 + name: Raiffeissen Bankengruppe + - id: 6765e225-a0dc-4481-9666-e26303d4f221 + name: Hypo Tirol Bank AG + - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc + name: Sparda Bank Wien + - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f + name: Schoellerbank AG + - id: e2e97aaa-de4c-4e18-9431-d99790773433 + name: Volksbank Gruppe + - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 + name: Immo-Bank + - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 + name: Bank Austria + - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 + name: Easybank AG + - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a + name: VR-BankBraunau + - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 + name: Volkskreditbank + - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 + name: Erste Bank und Sparkassen + - id: ba7199cc-f057-42f2-9856-2378abf21638 + name: BAWAG P.S.K. Gruppe + key: issuer + type: select + name: EPS + type: eps + - name: Expert Cadeaukaart + type: expertgiftcard + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 3x Oney + type: facilypay_3x + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 4x Oney + type: facilypay_4x + - name: Fashioncheque + type: fashioncheque + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: Fawry + type: fawry + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Fonq Giftcard + type: fonqgiftcard + - name: Gall & Gall + type: gallgall + - name: GCash + type: gcash + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - details: + - key: bic + type: text + name: GiroPay + type: giropay + - name: Givex + type: givex + - name: Globe GCash + type: globegcash + - name: Goldsmiths Card + type: goldsmithscard + - name: GoPay Wallet + type: gopay_wallet + - name: OVO + type: grabpay_ID + - name: GrabPay + type: grabpay_PH + - name: GrabPay + type: grabpay_SG + - name: Hallmark Card + type: hallmarkcard + - name: HDFC + type: hdfc + - name: Hunkemoller Member Card + type: hmclub + - name: Hunkemoller Lingerie Card + type: hmlingerie + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - name: igive + type: igive + - name: Korean Account Transfer (IniPay) + type: inicisIniPay_accounttransfer + - name: Korean Credit Cards (IniPay) + type: inicisIniPay_creditcard + - name: Korean Mobile Phone (IniPay) + type: inicisIniPay_mobilephone + - name: Korean Virtual Account (IniPay) + type: inicisIniPay_virtualaccount + - name: Korean Account Transfer (Mobile) + type: inicisMobile_accounttransfer + - name: Korean Credit Cards (Mobile) + type: inicisMobile_creditcard + - name: Korean Mobile Phone (Mobile) + type: inicisMobile_mobilephone + - name: Korean Virtual Account (Mobile) + type: inicisMobile_virtualaccount + - name: Korean Credit Cards + type: inicis_creditcard + - name: "Interac\xAE Online" + type: interac + - name: Instant EFT + type: ipay + - name: iPay88 + type: ipay88 + - name: isracard + type: isracard + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: KakaoPay + type: kakaopay + - name: Karen Millen Card + type: karenmillen + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Bank Transfer + type: kcp_banktransfer + - name: "Korea\u2013issued cards" + type: kcp_creditcard + - name: PayCo + type: kcp_payco + - name: Virtual Account via KCP + type: kcp_va + - name: Pay later with Klarna. + type: klarna + - name: Pay over time with Klarna. + type: klarna_account + - name: Klarna B2B + type: klarna_b2b + - name: Pay now with Klarna. + type: klarna_paynow + - name: Leisure Card + type: leisurecard + - name: China Credit Card + type: lianlianpay_creditcard + - name: China Debit Card + type: lianlianpay_debitcard + - details: + - key: telephoneNumber + type: tel + name: China Online Banking - Credit Card + type: lianlianpay_ebanking_credit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '4031000' + name: Bank of Beijing + - id: '01040000' + name: Bank of China + - id: '03020000' + name: China Citic Bank + - id: '01050000' + name: China Construction Bank + - id: '03030000' + name: China Everbright Bank + - id: 03080000 + name: China Merchants Bank + - id: '03050000' + name: China Minsheng Banking Group + - id: '03040000' + name: Hua Xia Bank Co + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03070000' + name: PingAn Bank + - id: '1000000' + name: Postal Savings Bank of China + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Debit Card + type: lianlianpay_ebanking_debit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '01050000' + name: China Construction Bank + - id: 03080000 + name: China Merchants Bank + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03100000' + name: Shanghai Pudong Development Bank + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Enterprise + type: lianlianpay_ebanking_enterprise + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - name: Love2Shop GiftCard + type: love2shop + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: mada + type: mada + - name: Mappin & Webb Card + type: mappinwebbcard + - name: MB WAY + type: mbway + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: Mercado Pago + type: mercadopago + - name: MobilePay + type: mobilepay + - name: AliPay via Razer Merchant Services + type: molpay_alipay + - name: 7-Eleven + type: molpay_cash + - name: CIMB Virtual Account + type: molpay_cimb_va + - name: Malaysia E-Banking via Razer Merchant Services + type: molpay_ebanking_MY + - details: + - items: + - id: vtcpay-vietinbank + name: Vietinbank + - id: vtcpay-bidv + name: BIDV + - id: vtcpay-agribank + name: Agribank + - id: vtcpay-mb + name: MB Bank + - id: vtcpay-sacombank + name: Sacombank + - id: vtcpay-dongabank + name: DongABank + - id: vtcpay-maritimebank + name: MaritimeBank + - id: vtcpay-vietcombank + name: Vietcombank + - id: vtcpay-acb + name: ACB + - id: vtcpay-techcombank + name: Techcombank + key: issuer + type: select + name: Vietnam E-Banking + type: molpay_ebanking_VN + - details: + - items: + - id: fpx_bimb + name: Bank Islam + - id: fpx_uob + name: UOB Bank + - id: fpx_cimbclicks + name: CIMB Clicks + - id: fpx_kfh + name: Kuwait Finance House + - id: fpx_rhb + name: RHB Now + - id: fpx_abmb + name: Alliance Bank + - id: fpx_amb + name: Am Online + - id: fpx_hsbc + name: HSBC + - id: fpx_abb + name: Affin Bank + - id: fpx_ocbc + name: OCBC Bank + - id: fpx_pbb + name: Public Bank + - id: fpx_scb + name: Standard Chartered Bank + - id: fpx_bsn + name: Bank Simpanan Nasional + - id: fpx_mb2u + name: Maybank2u + - id: fpx_hlb + name: Hong Leong Connect + - id: fpx_bmmb + name: Bank Muamalat + - id: fpx_bkrm + name: Bank Rakyat + key: issuer + type: select + name: Malaysia E-Banking + type: molpay_ebanking_fpx_MY + - name: eNETS Debit + type: molpay_enetsd + - name: epay + type: molpay_epay + - name: Esapay + type: molpay_esapay + - name: MyClear FPX + type: molpay_fpx + - name: Maybank2u + type: molpay_maybank2u + - name: Nganluong + type: molpay_nganluong + - name: Tesco Lotus + type: molpay_paysbuy + - name: MOLPoints + type: molpay_points + - name: RHB Now + type: molpay_rhb + - name: SAM by SingPost + type: molpay_singpost + - name: MOLWallet + type: molpay_wallet + - name: MoMo ATM + type: momo_atm + - name: Momo Wallet + type: momo_wallet + - name: Moneybookers + type: moneybookers + - name: Multibanco + type: multibanco + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: BankAxess + type: netaxept_bankaxess + - name: NETELLER + type: neteller + - name: Onebip + type: onebip + - name: One Two Three + type: onetwothree + - name: Local Polish Payment Methods + type: onlineBanking_PL + - details: + - items: + - id: '1' + name: Model Bank v2 + key: issuer + type: select + name: Online banking + type: openbanking_UK + - name: Oxxo + type: oxxo + - name: Pathe Giftcard + type: pathegiftcard + - name: PayBright + type: paybright + - name: PayMaya Wallet + type: paymaya_wallet + - name: PayPal + type: paypal + - name: Paysafecard + type: paysafecard + - name: Payshop + type: payshop + - name: PayD AMT via Paythru + type: paythru_amt + - name: EFT via Paythru + type: paythru_eft + - name: PayTM + type: paytm + - details: + - key: virtualPaymentAddress + type: text + name: PayU UPI + type: payu_IN_upi + - name: EFT Pro via PayU + type: payu_ZA_eftpro + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: pix + type: pix + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Podium Card + type: podiumcard + - name: POLi + type: poli + - name: PPS + type: pps + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Illicado Gift Card + type: prosodie_illicado + - name: PSE + type: pse + - details: + - items: + - id: '+7' + name: RU + - id: '+9955' + name: GE + - id: '+507' + name: PA + - id: '+44' + name: GB + - id: '+992' + name: TJ + - id: '+370' + name: LT + - id: '+972' + name: IL + - id: '+996' + name: KG + - id: '+380' + name: UA + - id: '+84' + name: VN + - id: '+90' + name: TR + - id: '+994' + name: AZ + - id: '+374' + name: AM + - id: '+371' + name: LV + - id: '+91' + name: IN + - id: '+66' + name: TH + - id: '+373' + name: MD + - id: '+1' + name: US + - id: '+81' + name: JP + - id: '+998' + name: UZ + - id: '+77' + name: KZ + - id: '+375' + name: BY + - id: '+372' + name: EE + - id: '+40' + name: RO + - id: '+82' + name: KR + key: qiwiwallet.telephoneNumberPrefix + type: select + - key: qiwiwallet.telephoneNumber + type: text + name: Qiwi Wallet + type: qiwiwallet + - name: RatePay Invoice + type: ratepay + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: SafetyPay + type: safetypay + - name: SafetyPay Cash + type: safetypay_cash + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: SEB Direktbetalning + type: sebdirectpayment + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: 7-Eleven + type: seveneleven + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: Swish + type: swish + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: TenPay + type: tenpay + - name: The Sting Giftcard + type: thestinggiftcard + - name: Trustly + type: trustly + - name: Online Banking by Trustpay + type: trustpay + - name: TWINT + type: twint + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - details: + - key: virtualPaymentAddress + type: text + name: UPI Collect + type: upi_collect + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: telephoneNumber + optional: true + type: tel + name: Vipps + type: vipps + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: VVV Giftcard + type: vvvgiftcard + - name: Webshop Giftcard + type: webshopgiftcard + - name: WeChat Pay + type: wechatpayMiniProgram + - name: WeChat Pay + type: wechatpayQR + - name: WeChat Pay + type: wechatpayWeb + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: WOS Card + type: woscard + - name: Alfa-Click + type: yandex_alfaclick + - name: Pay using bank card + type: yandex_bank_card + - name: Cash terminals + type: yandex_cash + - name: Pay using installments + type: yandex_installments + - name: YooMoney + type: yandex_money + - name: Promsvyazbank + type: yandex_promsvyazbank + - name: Sberbank Online + type: yandex_sberbank + - name: WebMoney + type: yandex_webmoney + - name: Your Gift + type: yourgift + - name: Zip + type: zip post-paymentMethods-filtered: summary: Get payment methods based on the country and amount value: @@ -8660,6 +10216,313 @@ components: amount: currency: EUR value: 1000 + post-paymentMethods-filtered-200: + summary: Example response for request 'filtered' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentMethods-include-oneclick: summary: Get payment methods including stored card details value: @@ -8669,6 +10532,313 @@ components: currency: EUR value: 1000 shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-paymentMethods-include-oneclick-200: + summary: Example response for request 'include-oneclick' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -8702,6 +10872,10 @@ components: shopperLocale: nl_NL merchantAccount: YOUR_MERCHANT_ACCOUNT sdkVersion: 1.7.0 + post-paymentSession-enableOneClick-200: + summary: Example response for request 'enableOneClick' + value: + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-paymentSession-ios: summary: Set up a payment session (iOS) value: @@ -8717,62 +10891,10 @@ components: shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-split: - summary: Split a payment between a sub-merchant and a platform account + post-paymentSession-web-200: + summary: Example response for request 'web' value: - amount: - currency: EUR - value: 6200 - additionalData: - split.api: '1' - split.nrOfItems: '2' - split.totalAmount: '6200' - split.currencyCode: EUR - split.item1.amount: '6000' - split.item1.type: MarketPlace - split.item1.account: '151272963' - split.item1.reference: '6124145' - split.item1.description: 'Porcelain Doll: Eliza (20cm)' - split.item2.amount: '200' - split.item2.type: Commission - split.item2.reference: '6124146' - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Android - token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK - returnUrl: app:// - countryCode: NL - shopperLocale: nl_NL - sessionValidity: '2017-04-06T13:09:13Z' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-payments-applepay: - summary: Make an Apple Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: applepay - applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -8834,131 +10956,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields: - summary: Make a payment with 3D Secure 2 native authentication - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4212345678901237 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - holderName: John Smith - browserInfo: - userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 - Firefox/3.0 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct: - summary: Make a card payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw: - summary: Tokenize card details for one-off payments - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - storePaymentMethod: true - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay: - summary: Make a giropay payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: giropay - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-googlepay: - summary: Make a Google Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: paywithgoogle - googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... - merchantAccount: YourMerchantAccount - post-payments-ideal: - summary: Make an iDEAL payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: ideal - issuer: '1121' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-klarna: summary: Make a Klarna payment value: @@ -9024,95 +11021,7 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-oneclick-securedfields: - summary: Make a one-off payment with a token and CVV (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - storedPaymentMethodId: '8416038790273850' - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: CardOnFile - post-payments-recurring: - summary: Make a card payment with a token - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - storedPaymentMethodId: '8316038796685850' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: Subscription post-payments-result-basic: summary: Verify payment results value: payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK - post-payments-sofort: - summary: Make a Sofort payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: directEbanking - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-split: - summary: Split a payment between a sub-merchant and a platform account - value: - paymentMethod: - type: scheme - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' - post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT diff --git a/yaml/CheckoutService-v53.yaml b/yaml/CheckoutService-v53.yaml index f1eacf3..124b57b 100644 --- a/yaml/CheckoutService-v53.yaml +++ b/yaml/CheckoutService-v53.yaml @@ -81,13 +81,21 @@ paths: $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-basic-200' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -124,6 +132,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -150,13 +161,21 @@ paths: $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-cancel-basic-200' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -193,6 +212,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -223,13 +245,21 @@ paths: $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-originKeys-basic-200' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -266,6 +296,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -295,19 +328,30 @@ paths: $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/CreatePaymentLinkRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentLinks-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '201': content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResource' description: Created - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -344,6 +388,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -367,13 +414,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -410,6 +464,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -441,13 +498,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -484,6 +548,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -521,13 +588,25 @@ paths: $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentMethods-basic-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + filtered-200: + $ref: '#/components/examples/post-paymentMethods-filtered-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -564,6 +643,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -592,13 +674,21 @@ paths: $ref: '#/components/examples/post-paymentMethods-balance-basic' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + plastix-200: + $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -629,12 +719,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -661,10 +751,6 @@ paths: content: application/json: examples: - split: - $ref: '#/components/examples/post-paymentSession-split' - web: - $ref: '#/components/examples/post-paymentSession-web' android: $ref: '#/components/examples/post-paymentSession-android' ios: @@ -673,19 +759,26 @@ paths: $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick-200: + $ref: '#/components/examples/post-paymentSession-enableOneClick-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -701,9 +794,6 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -716,12 +806,12 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -743,44 +833,18 @@ paths: content: application/json: examples: - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' - giropay: - $ref: '#/components/examples/post-payments-giropay' - card-3d-secure-securedfields: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' - enableOneClick-raw: - $ref: '#/components/examples/post-payments-enableOneClick-raw' - applepay: - $ref: '#/components/examples/post-payments-applepay' - ideal: - $ref: '#/components/examples/post-payments-ideal' - oneclick-securedfields: - $ref: '#/components/examples/post-payments-oneclick-securedfields' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' - recurring: - $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' - sofort: - $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' card-3d-secure-direct: $ref: '#/components/examples/post-payments-card-3d-secure-direct' klarna: $ref: '#/components/examples/post-payments-klarna' - split: - $ref: '#/components/examples/post-payments-split' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' schema: $ref: '#/components/schemas/PaymentRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -788,48 +852,39 @@ paths: schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -851,6 +906,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DetailsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -858,6 +915,9 @@ paths: schema: $ref: '#/components/schemas/PaymentDetailsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -885,6 +945,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -910,6 +973,8 @@ paths: $ref: '#/components/examples/post-payments-result-basic' schema: $ref: '#/components/schemas/PaymentVerificationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -917,6 +982,9 @@ paths: schema: $ref: '#/components/schemas/PaymentVerificationResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -947,12 +1015,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -3069,19 +3137,19 @@ components: type: string encryptedCardNumber: description: The encrypted card number. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryMonth: description: The encrypted card expiry month. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryYear: description: The encrypted card expiry year. - maxLength: 7000 + maxLength: 10000 type: string encryptedSecurityCode: description: The encrypted card verification code. - maxLength: 7000 + maxLength: 10000 type: string expiryMonth: description: The card expiry month. Only collect raw card data if you are @@ -3341,8 +3409,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -3566,53 +3640,20 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Success** \u2013 Indicates that the balance check was successful.\n\ + * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\ + \ have enough balance to pay the amount in the request, or that the currency\ + \ of the balance on the card did not match the currency of the requested\ + \ amount.\n* **Failed** \u2013 Indicates that the balance check failed." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success + - NotEnoughBalance + - Failed type: string required: - balance + - resultCode CheckoutBankTransferAction: additionalProperties: false properties: @@ -3669,7 +3710,11 @@ components: description: A unique reference of the cancellation request. type: string resultCode: - description: The result of the cancellation request. + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Received** \u2013 Indicates the cancellation has successfully been\ + \ received by Adyen, and will be processed." + enum: + - Received type: string required: - pspReference @@ -3745,55 +3790,16 @@ components: description: The remaining amount in the order. $ref: '#/components/schemas/Amount' resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the order creation request.\n The value is always\ + \ **Success**." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success type: string required: - remainingAmount - expiresAt - orderData + - resultCode CheckoutDonationAction: additionalProperties: false properties: @@ -5316,8 +5322,10 @@ components: properties: action: x-addedInVersion: 49 - description: Action to be taken for completing the payment. - $ref: '#/components/schemas/CheckoutThreeDS2ChallengeAction' + description: Action to be taken for completing the payment. When returned, + only the 3D Secure action is needed in most cases. + oneOf: + - $ref: '#/components/schemas/CheckoutRedirectAction' additionalData: additionalProperties: type: string @@ -6044,8 +6052,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -6687,8 +6701,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -8010,11 +8030,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -8559,6 +8579,21 @@ components: BasicAuth: scheme: basic type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string examples: generic-400: summary: Response code 400. Bad request. @@ -8596,10 +8631,38 @@ components: message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' + get-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A patch-paymentLinks-linkId-basic: summary: Update the status of a payment link value: status: expired + patch-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: expired + url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -8608,6 +8671,17 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178914061985' + resultCode: Success + expiresAt: '2021-04-09T14:16:46Z' + orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== + reference: shopper-reference-ekvL83 + remainingAmount: + currency: EUR + value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -8615,6 +8689,11 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8816178914079738' + resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -8622,6 +8701,13 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com + post-originKeys-basic-200: + summary: Example response for request 'basic' + value: + originKeys: + https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw + https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc + https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -8648,6 +8734,15 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP + post-paymentLinks-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 1250 + expiresAt: '2021-04-09T14:17:31Z' + reference: shopper-reference-ekvL83 + url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -8665,10 +8760,1471 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix-200: + summary: Example response for request 'plastix' + value: + additionalData: + nonScheme.transactionLimit: '5000' + nonScheme.transactionLimitCcy: EUR + pspReference: 851617891188737F + resultCode: Success + balance: + currency: EUR + value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic-200: + summary: Example response for request 'basic' + value: + paymentMethods: + - details: + - details: + - key: ownerName + type: text + - key: bankLocationId + type: text + - key: bankAccountNumber + type: text + key: bankAccount + type: bankAccount + name: ACH Direct Debit + type: ach + - name: Adyen Voucher + type: adyen_test_voucher + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: Afterpay + type: afterpaytouch + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: AliPay + type: alipay + - name: AliPay HK + type: alipay_hk + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Credit Card via AsiaPay + type: asiapay + - name: China UnionPay + type: asiapay_unionpay + - name: Baby Gift Card + type: babygiftcard + - name: Baloto + type: baloto + - name: BancNet + type: bancnet + - name: Bank Transfer (BG) + type: bankTransfer_BG + - name: Bank Transfer (CH) + type: bankTransfer_CH + - name: Bank Transfer (DE) + type: bankTransfer_DE + - name: Bank Transfer (FI) + type: bankTransfer_FI + - name: Bank Transfer (GB) + type: bankTransfer_GB + - name: Bank Transfer (HU) + type: bankTransfer_HU + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bank Transfer (IE) + type: bankTransfer_IE + - name: Electronic Bank Transfer (MX) + type: bankTransfer_MX_linked + - name: Bank Transfer (MX) + type: bankTransfer_MX_offline + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Bank Transfer (PL) + type: bankTransfer_PL + - name: Bank Transfer (SE) + type: bankTransfer_SE + - name: Bank Transfer (US) + type: bankTransfer_US + - name: Payconiq by Bancontact + type: bcmc_mobile + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: 99Bill + type: bill99 + - details: + - items: + - id: AUB_DIRECT + name: AU Small Finance Bank + - id: ALB_DIRECT + name: 'Allahabad Bank ' + - id: APG_DIRECT + name: Andhra Pragathi Grameena Bank + - id: BDN_DIRECT + name: Bandhan bank + - id: BBK_DIRECT + name: Bank of Bahrain and Kuwait + - id: BBR_DIRECT + name: Bank of Baroda - Retail Banking + - id: BCB_DIRECT + name: 'Bassien Catholic Co-Operative Bank ' + - id: CNB_DIRECT + name: Canara Bank + - id: SYD_DIRECT + name: Canara Bank (e-Syndicate) + - id: CSB_DIRECT + name: Catholic Syrian Bank + - id: CBI_DIRECT + name: Central Bank of India + - id: CUB_DIRECT + name: City Union Bank + - id: COB_DIRECT + name: Cosmos Bank + - id: DEN_DIRECT + name: Dena Bank + - id: DBK_DIRECT + name: Deutsche Bank + - id: DCB_DIRECT + name: Development Credit Bank + - id: DLB_DIRECT + name: Dhanlakshmi Bank - Retail Net Banking + - id: ESF_DIRECT + name: ESAF Small Finance Bank + - id: EQB_DIRECT + name: Equitas Small Finance Bank + - id: FBK_DIRECT + name: Federal Bank + - id: FNC_DIRECT + name: Fincare Bank + - id: HDF_DIRECT + name: HDFC Bank + - id: ICI_DIRECT + name: 'ICICI Bank ' + - id: IDB_DIRECT + name: IDBI Bank - Retail Net Banking + - id: IDN_DIRECT + name: IDFC FIRST Bank + - id: INB_DIRECT + name: Indian Bank + - id: IOB_DIRECT + name: Indian Overseas Bank + - id: IDS_DIRECT + name: IndusInd Bank + - id: JKB_DIRECT + name: Jammu & Kashmir Bank + - id: JNB_DIRECT + name: Jana Small Finance Bank + - id: JSB_DIRECT + name: Janata Sahakari Bank Ltd Pune + - id: KJB_DIRECT + name: Kalyan Janata Sahakari Bank + - id: KBL_DIRECT + name: Karnataka Bank Ltd + - id: KVB_DIRECT + name: Karur Vysya Bank + - id: 162_DIRECT + name: Kotak Bank + - id: LVR_DIRECT + name: Laxmi Vilas Bank - Retail + - id: NKB_DIRECT + name: NKGSB Co-op Bank + - id: NEB_DIRECT + name: North East Small Finance Bank + - id: OBC_DIRECT + name: PNB (Erstwhile-Oriental Bank of Commerce) + - id: UNI_DIRECT + name: PNB (Erstwhile-United Bank of India) + - id: PMC_DIRECT + name: Punjab & Maharastra Co-op Bank + - id: PSB_DIRECT + name: Punjab & Sind Bank + - id: CPN_DIRECT + name: 'Punjab National Bank - Corporate ' + - id: PNB_DIRECT + name: Punjab National Bank - Retail Banking + - id: RBL_DIRECT + name: RBL Bank Limited + - id: SWB_DIRECT + name: Saraswat Bank + - id: SHB_DIRECT + name: Shivalik Mercantile Cooperative Bank Ltd + - id: SIB_DIRECT + name: South Indian Bank + - id: SCB_DIRECT + name: Standard Chartered Bank + - id: SBI_DIRECT + name: State Bank of India + - id: SRB_DIRECT + name: Suryoday Small Finance Bank + - id: TJB_DIRECT + name: TJSB Bank + - id: TNC_DIRECT + name: Tamil Nadu State Co-operative Bank + - id: TMB_DIRECT + name: Tamilnad Mercantile Bank Ltd + - id: TBB_DIRECT + name: Thane Bharat Sahakari Bank Ltd + - id: MSB_DIRECT + name: The Mehsana Urban Co Op Bank Ltd + - id: UCO_DIRECT + name: UCO Bank + - id: UBI_DIRECT + name: Union Bank of India + - id: ADB_DIRECT + name: Union Bank of India (Erstwhile Andhra Bank) + - id: CRP_DIRECT + name: Union Bank of India (Erstwhile Corporation Bank) + - id: VRB_DIRECT + name: Varachha Co-operative Bank Limited + - id: VJB_DIRECT + name: Vijaya Bank + - id: YBK_DIRECT + name: Yes Bank + - id: ZOB_DIRECT + name: Zoroastrian Co-operative Bank Limited + - id: DBS_DIRECT + name: digibank by DBS + key: issuer + type: select + name: Online Banking India + type: billdesk_online + - name: UPI + type: billdesk_upi + - details: + - items: + - id: DCW_DIRECT + name: DCB Cippy + - id: ICC_DIRECT + name: ICC Cash Card + - id: OXY_DIRECT + name: Oxigen Wallet + - id: PCH_DIRECT + name: Pay World Money + key: issuer + type: select + name: Wallets India + type: billdesk_wallet + - name: Blik + type: blik + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Boleto + type: boleto + - name: Boleto Bancario + type: boletobancario_santander + - name: Bradesco + type: bradesco + - name: Cash-Ticket + type: cashticket + - name: CashU + type: cashu + - name: CCAvenue + type: ccavenue + - name: Mula Checkout + type: cellulant + - name: Chasin Giftcard + type: chasingiftcard + - name: Clearpay + type: clearpay + - name: ClickandBuy + type: clickandbuy + - name: Paiement en 3 fois par Cartes Bancaires + type: cofinoga_3xcb + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: DANA + type: dana + - name: DineroMail + type: dineromail + - name: Online bank transfer. + type: directEbanking + - name: Direct Debit Brazil - Banco do Brazil + type: directdebit_BR_bancodobrasil + - name: Direct Debit Brazil - Bradesco + type: directdebit_BR_bradesco + - name: Direct Debit Brazil - Caixa Economica Federal + type: directdebit_BR_caixa + - name: Direct Debit Brazil - HSBC + type: directdebit_BR_hsbc + - name: Direct Debit Brazil - Itau + type: directdebit_BR_itau + - name: Direct Debit Brazil - Santander + type: directdebit_BR_santander + - name: BACS Direct Debit + type: directdebit_GB + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Alfamart + type: doku_alfamart + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BCA Bank Transfer + type: doku_bca_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BNI VA + type: doku_bni_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BRI VA + type: doku_bri_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: CIMB VA + type: doku_cimb_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Danamon VA + type: doku_danamon_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Indomaret + type: doku_indomaret + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Mandiri VA + type: doku_mandiri_va + - details: + - key: ovoId + type: text + name: OVO + type: doku_ovo + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Bank Transfer + type: doku_permata_lite_atm + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: DOKU wallet + type: doku_wallet + - details: + - items: + - id: '66' + name: Bank Nowy BFG S.A. + - id: '92' + name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" + - id: '11' + name: Bank transfer / postal + - id: '74' + name: "Banki Sp\xF3\u0142dzielcze" + - id: '73' + name: BLIK + - id: '90' + name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" + - id: '59' + name: CinkciarzPAY + - id: '87' + name: Credit Agricole PBL + - id: '83' + name: EnveloBank + - id: '76' + name: Getin Bank PBL + - id: '81' + name: Idea Cloud + - id: '7' + name: ING Corporate customers + - id: '93' + name: Kasa Stefczyka + - id: '44' + name: "Millennium - P\u0142atno\u015Bci Internetowe" + - id: '10' + name: Millennium Corporate customers + - id: '68' + name: mRaty + - id: '1' + name: mTransfer + - id: '91' + name: Nest Bank + - id: '80' + name: Noble Pay + - id: '50' + name: Pay Way Toyota Bank + - id: '45' + name: Pay with Alior Bank + - id: '36' + name: Pekao24Przelew + - id: '70' + name: Pocztowy24 + - id: '6' + name: Przelew24 + - id: '46' + name: "P\u0142ac\u0119 z Citi Handlowy" + - id: '38' + name: "P\u0142ac\u0119 z ING" + - id: '2' + name: "P\u0142ac\u0119 z Inteligo" + - id: '4' + name: "P\u0142ac\u0119 z iPKO" + - id: '75' + name: "P\u0142ac\u0119 z Plus Bank" + - id: '51' + name: "P\u0142a\u0107 z BO\u015A" + - id: '55' + name: Raty z Alior Bankiem PLN + - id: '89' + name: Santander + - id: '52' + name: SkyCash + key: issuer + type: select + name: Local Polish Payment Methods + type: dotpay + - name: Dragonpay Prepaid Credits + type: dragonpay_credits + - name: Online Banking + type: dragonpay_ebanking + - name: GCash + type: dragonpay_gcash + - name: Over The Counter Banks + type: dragonpay_otc_banking + - name: OTC non-Bank via Dragonpay + type: dragonpay_otc_non_banking + - name: Convenience Stores + type: dragonpay_otc_philippines + - name: 7/11 + type: dragonpay_seveneleven + - name: eagleeye_voucher + type: eagleeye_voucher + - name: Finnish E-Banking + type: ebanking_FI + - name: Pay-easy ATM + type: econtext_atm + - name: Online Banking + type: econtext_online + - name: 7-Eleven + type: econtext_seven_eleven + - name: Convenience Stores + type: econtext_stores + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Lastschrift (ELV) + type: elv + - details: + - items: + - id: '231' + name: POP Pankki + - id: '551' + name: "Komer\u010Dn\xED banka" + - id: '232' + name: Aktia + - id: '552' + name: Raiffeisen + - id: '233' + name: "S\xE4\xE4st\xF6pankki" + - id: '750' + name: Swedbank + - id: '211' + name: Nordea + - id: '553' + name: "\u010CSOB" + - id: '234' + name: S-Pankki + - id: '751' + name: SEB + - id: '554' + name: Moneta + - id: '235' + name: OmaSP + - id: '752' + name: Nordea + - id: '213' + name: Op-Pohjola + - id: '555' + name: UniCredit + - id: '753' + name: LHV + - id: '556' + name: Fio + - id: '557' + name: mBank + - id: '216' + name: Handelsbanken + - id: '558' + name: Air Bank + - id: '260' + name: "L\xE4nsf\xF6rs\xE4kringar" + - id: '240' + name: BankDeposit + - id: '265' + name: Sparbanken + - id: '640' + name: BankDeposit + - id: '200' + name: "\xC5landsbanken" + - id: '940' + name: Swedbank + - id: '500' + name: "\u010Cesk\xE1 spo\u0159itelna" + - id: '720' + name: Swedbank + - id: '941' + name: SEB + - id: '204' + name: Danske Bank + - id: '721' + name: SEB + - id: '942' + name: Citadele + - id: '205' + name: Handelsbanken + - id: '722' + name: DNB + - id: '943' + name: DNB + - id: '206' + name: Nordea + - id: '723' + name: "\u0160iauli\u0173 bankas" + - id: '207' + name: SEB + - id: '724' + name: Nordea + - id: '505' + name: "Komer\u010Dn\xED banka" + - id: '208' + name: Skandiabanken + - id: '209' + name: Swedbank + key: issuer + type: select + name: Bank Payment + type: entercash + - name: Nationale Entertainment Card + type: entertainmentcard + - details: + - items: + - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 + name: Dolomitenbank + - id: ee9fc487-ebe0-486c-8101-17dce5141a67 + name: Raiffeissen Bankengruppe + - id: 6765e225-a0dc-4481-9666-e26303d4f221 + name: Hypo Tirol Bank AG + - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc + name: Sparda Bank Wien + - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f + name: Schoellerbank AG + - id: e2e97aaa-de4c-4e18-9431-d99790773433 + name: Volksbank Gruppe + - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 + name: Immo-Bank + - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 + name: Bank Austria + - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 + name: Easybank AG + - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a + name: VR-BankBraunau + - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 + name: Volkskreditbank + - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 + name: Erste Bank und Sparkassen + - id: ba7199cc-f057-42f2-9856-2378abf21638 + name: BAWAG P.S.K. Gruppe + key: issuer + type: select + name: EPS + type: eps + - name: Expert Cadeaukaart + type: expertgiftcard + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 3x Oney + type: facilypay_3x + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 4x Oney + type: facilypay_4x + - name: Fashioncheque + type: fashioncheque + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: Fawry + type: fawry + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Fonq Giftcard + type: fonqgiftcard + - name: Gall & Gall + type: gallgall + - name: GCash + type: gcash + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - details: + - key: bic + type: text + name: GiroPay + type: giropay + - name: Givex + type: givex + - name: Globe GCash + type: globegcash + - name: Goldsmiths Card + type: goldsmithscard + - name: GoPay Wallet + type: gopay_wallet + - name: OVO + type: grabpay_ID + - name: GrabPay + type: grabpay_PH + - name: GrabPay + type: grabpay_SG + - name: Hallmark Card + type: hallmarkcard + - name: HDFC + type: hdfc + - name: Hunkemoller Member Card + type: hmclub + - name: Hunkemoller Lingerie Card + type: hmlingerie + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - name: igive + type: igive + - name: Korean Account Transfer (IniPay) + type: inicisIniPay_accounttransfer + - name: Korean Credit Cards (IniPay) + type: inicisIniPay_creditcard + - name: Korean Mobile Phone (IniPay) + type: inicisIniPay_mobilephone + - name: Korean Virtual Account (IniPay) + type: inicisIniPay_virtualaccount + - name: Korean Account Transfer (Mobile) + type: inicisMobile_accounttransfer + - name: Korean Credit Cards (Mobile) + type: inicisMobile_creditcard + - name: Korean Mobile Phone (Mobile) + type: inicisMobile_mobilephone + - name: Korean Virtual Account (Mobile) + type: inicisMobile_virtualaccount + - name: Korean Credit Cards + type: inicis_creditcard + - name: "Interac\xAE Online" + type: interac + - name: Instant EFT + type: ipay + - name: iPay88 + type: ipay88 + - name: isracard + type: isracard + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: KakaoPay + type: kakaopay + - name: Karen Millen Card + type: karenmillen + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Bank Transfer + type: kcp_banktransfer + - name: "Korea\u2013issued cards" + type: kcp_creditcard + - name: PayCo + type: kcp_payco + - name: Virtual Account via KCP + type: kcp_va + - name: Pay later with Klarna. + type: klarna + - name: Pay over time with Klarna. + type: klarna_account + - name: Klarna B2B + type: klarna_b2b + - name: Pay now with Klarna. + type: klarna_paynow + - name: Leisure Card + type: leisurecard + - name: China Credit Card + type: lianlianpay_creditcard + - name: China Debit Card + type: lianlianpay_debitcard + - details: + - key: telephoneNumber + type: tel + name: China Online Banking - Credit Card + type: lianlianpay_ebanking_credit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '4031000' + name: Bank of Beijing + - id: '01040000' + name: Bank of China + - id: '03020000' + name: China Citic Bank + - id: '01050000' + name: China Construction Bank + - id: '03030000' + name: China Everbright Bank + - id: 03080000 + name: China Merchants Bank + - id: '03050000' + name: China Minsheng Banking Group + - id: '03040000' + name: Hua Xia Bank Co + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03070000' + name: PingAn Bank + - id: '1000000' + name: Postal Savings Bank of China + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Debit Card + type: lianlianpay_ebanking_debit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '01050000' + name: China Construction Bank + - id: 03080000 + name: China Merchants Bank + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03100000' + name: Shanghai Pudong Development Bank + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Enterprise + type: lianlianpay_ebanking_enterprise + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - name: Love2Shop GiftCard + type: love2shop + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: mada + type: mada + - name: Mappin & Webb Card + type: mappinwebbcard + - name: MB WAY + type: mbway + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: Mercado Pago + type: mercadopago + - name: MobilePay + type: mobilepay + - name: AliPay via Razer Merchant Services + type: molpay_alipay + - name: 7-Eleven + type: molpay_cash + - name: CIMB Virtual Account + type: molpay_cimb_va + - name: Malaysia E-Banking via Razer Merchant Services + type: molpay_ebanking_MY + - details: + - items: + - id: vtcpay-vietinbank + name: Vietinbank + - id: vtcpay-bidv + name: BIDV + - id: vtcpay-agribank + name: Agribank + - id: vtcpay-mb + name: MB Bank + - id: vtcpay-sacombank + name: Sacombank + - id: vtcpay-dongabank + name: DongABank + - id: vtcpay-maritimebank + name: MaritimeBank + - id: vtcpay-vietcombank + name: Vietcombank + - id: vtcpay-acb + name: ACB + - id: vtcpay-techcombank + name: Techcombank + key: issuer + type: select + name: Vietnam E-Banking + type: molpay_ebanking_VN + - details: + - items: + - id: fpx_bimb + name: Bank Islam + - id: fpx_uob + name: UOB Bank + - id: fpx_cimbclicks + name: CIMB Clicks + - id: fpx_kfh + name: Kuwait Finance House + - id: fpx_rhb + name: RHB Now + - id: fpx_abmb + name: Alliance Bank + - id: fpx_amb + name: Am Online + - id: fpx_hsbc + name: HSBC + - id: fpx_abb + name: Affin Bank + - id: fpx_ocbc + name: OCBC Bank + - id: fpx_pbb + name: Public Bank + - id: fpx_scb + name: Standard Chartered Bank + - id: fpx_bsn + name: Bank Simpanan Nasional + - id: fpx_mb2u + name: Maybank2u + - id: fpx_hlb + name: Hong Leong Connect + - id: fpx_bmmb + name: Bank Muamalat + - id: fpx_bkrm + name: Bank Rakyat + key: issuer + type: select + name: Malaysia E-Banking + type: molpay_ebanking_fpx_MY + - name: eNETS Debit + type: molpay_enetsd + - name: epay + type: molpay_epay + - name: Esapay + type: molpay_esapay + - name: MyClear FPX + type: molpay_fpx + - name: Maybank2u + type: molpay_maybank2u + - name: Nganluong + type: molpay_nganluong + - name: Tesco Lotus + type: molpay_paysbuy + - name: MOLPoints + type: molpay_points + - name: RHB Now + type: molpay_rhb + - name: SAM by SingPost + type: molpay_singpost + - name: MOLWallet + type: molpay_wallet + - name: MoMo ATM + type: momo_atm + - name: Momo Wallet + type: momo_wallet + - name: Moneybookers + type: moneybookers + - name: Multibanco + type: multibanco + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: BankAxess + type: netaxept_bankaxess + - name: NETELLER + type: neteller + - name: Onebip + type: onebip + - name: One Two Three + type: onetwothree + - name: Local Polish Payment Methods + type: onlineBanking_PL + - details: + - items: + - id: '1' + name: Model Bank v2 + key: issuer + type: select + name: Online banking + type: openbanking_UK + - name: Oxxo + type: oxxo + - name: Pathe Giftcard + type: pathegiftcard + - name: PayBright + type: paybright + - name: PayMaya Wallet + type: paymaya_wallet + - name: PayPal + type: paypal + - name: Paysafecard + type: paysafecard + - name: Payshop + type: payshop + - name: PayD AMT via Paythru + type: paythru_amt + - name: EFT via Paythru + type: paythru_eft + - name: PayTM + type: paytm + - details: + - key: virtualPaymentAddress + type: text + name: PayU UPI + type: payu_IN_upi + - name: EFT Pro via PayU + type: payu_ZA_eftpro + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: pix + type: pix + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Podium Card + type: podiumcard + - name: POLi + type: poli + - name: PPS + type: pps + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Illicado Gift Card + type: prosodie_illicado + - name: PSE + type: pse + - details: + - items: + - id: '+7' + name: RU + - id: '+9955' + name: GE + - id: '+507' + name: PA + - id: '+44' + name: GB + - id: '+992' + name: TJ + - id: '+370' + name: LT + - id: '+972' + name: IL + - id: '+996' + name: KG + - id: '+380' + name: UA + - id: '+84' + name: VN + - id: '+90' + name: TR + - id: '+994' + name: AZ + - id: '+374' + name: AM + - id: '+371' + name: LV + - id: '+91' + name: IN + - id: '+66' + name: TH + - id: '+373' + name: MD + - id: '+1' + name: US + - id: '+81' + name: JP + - id: '+998' + name: UZ + - id: '+77' + name: KZ + - id: '+375' + name: BY + - id: '+372' + name: EE + - id: '+40' + name: RO + - id: '+82' + name: KR + key: qiwiwallet.telephoneNumberPrefix + type: select + - key: qiwiwallet.telephoneNumber + type: text + name: Qiwi Wallet + type: qiwiwallet + - name: RatePay Invoice + type: ratepay + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: SafetyPay + type: safetypay + - name: SafetyPay Cash + type: safetypay_cash + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: SEB Direktbetalning + type: sebdirectpayment + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: 7-Eleven + type: seveneleven + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: Swish + type: swish + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: TenPay + type: tenpay + - name: The Sting Giftcard + type: thestinggiftcard + - name: Trustly + type: trustly + - name: Online Banking by Trustpay + type: trustpay + - name: TWINT + type: twint + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - details: + - key: virtualPaymentAddress + type: text + name: UPI Collect + type: upi_collect + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: telephoneNumber + optional: true + type: tel + name: Vipps + type: vipps + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: VVV Giftcard + type: vvvgiftcard + - name: Webshop Giftcard + type: webshopgiftcard + - name: WeChat Pay + type: wechatpayMiniProgram + - name: WeChat Pay + type: wechatpayQR + - name: WeChat Pay + type: wechatpayWeb + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: WOS Card + type: woscard + - name: Alfa-Click + type: yandex_alfaclick + - name: Pay using bank card + type: yandex_bank_card + - name: Cash terminals + type: yandex_cash + - name: Pay using installments + type: yandex_installments + - name: YooMoney + type: yandex_money + - name: Promsvyazbank + type: yandex_promsvyazbank + - name: Sberbank Online + type: yandex_sberbank + - name: WebMoney + type: yandex_webmoney + - name: Your Gift + type: yourgift + - name: Zip + type: zip post-paymentMethods-filtered: summary: Get payment methods based on the country and amount value: @@ -8678,6 +10234,313 @@ components: amount: currency: EUR value: 1000 + post-paymentMethods-filtered-200: + summary: Example response for request 'filtered' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentMethods-include-oneclick: summary: Get payment methods including stored card details value: @@ -8687,6 +10550,313 @@ components: currency: EUR value: 1000 shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-paymentMethods-include-oneclick-200: + summary: Example response for request 'include-oneclick' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -8720,6 +10890,10 @@ components: shopperLocale: nl_NL merchantAccount: YOUR_MERCHANT_ACCOUNT sdkVersion: 1.7.0 + post-paymentSession-enableOneClick-200: + summary: Example response for request 'enableOneClick' + value: + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-paymentSession-ios: summary: Set up a payment session (iOS) value: @@ -8735,62 +10909,10 @@ components: shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-split: - summary: Split a payment between a sub-merchant and a platform account + post-paymentSession-web-200: + summary: Example response for request 'web' value: - amount: - currency: EUR - value: 6200 - additionalData: - split.api: '1' - split.nrOfItems: '2' - split.totalAmount: '6200' - split.currencyCode: EUR - split.item1.amount: '6000' - split.item1.type: MarketPlace - split.item1.account: '151272963' - split.item1.reference: '6124145' - split.item1.description: 'Porcelain Doll: Eliza (20cm)' - split.item2.amount: '200' - split.item2.type: Commission - split.item2.reference: '6124146' - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Android - token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK - returnUrl: app:// - countryCode: NL - shopperLocale: nl_NL - sessionValidity: '2017-04-06T13:09:13Z' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-payments-applepay: - summary: Make an Apple Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: applepay - applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -8852,131 +10974,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields: - summary: Make a payment with 3D Secure 2 native authentication - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4212345678901237 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - holderName: John Smith - browserInfo: - userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 - Firefox/3.0 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct: - summary: Make a card payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw: - summary: Tokenize card details for one-off payments - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - storePaymentMethod: true - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay: - summary: Make a giropay payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: giropay - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-googlepay: - summary: Make a Google Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: paywithgoogle - googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... - merchantAccount: YourMerchantAccount - post-payments-ideal: - summary: Make an iDEAL payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: ideal - issuer: '1121' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-klarna: summary: Make a Klarna payment value: @@ -9042,95 +11039,7 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-oneclick-securedfields: - summary: Make a one-off payment with a token and CVV (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - storedPaymentMethodId: '8416038790273850' - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: CardOnFile - post-payments-recurring: - summary: Make a card payment with a token - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - storedPaymentMethodId: '8316038796685850' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: Subscription post-payments-result-basic: summary: Verify payment results value: payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK - post-payments-sofort: - summary: Make a Sofort payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: directEbanking - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-split: - summary: Split a payment between a sub-merchant and a platform account - value: - paymentMethod: - type: scheme - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' - post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT diff --git a/yaml/CheckoutService-v64.yaml b/yaml/CheckoutService-v64.yaml index 4827e4d..52c5f2d 100644 --- a/yaml/CheckoutService-v64.yaml +++ b/yaml/CheckoutService-v64.yaml @@ -81,13 +81,21 @@ paths: $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-basic-200' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -124,6 +132,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -150,13 +161,21 @@ paths: $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-cancel-basic-200' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -193,6 +212,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -223,13 +245,21 @@ paths: $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-originKeys-basic-200' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -266,6 +296,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -295,19 +328,30 @@ paths: $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/CreatePaymentLinkRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentLinks-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '201': content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResource' description: Created - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -344,6 +388,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -367,13 +414,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -410,6 +464,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -441,13 +498,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -484,6 +548,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -521,13 +588,25 @@ paths: $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentMethods-basic-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + filtered-200: + $ref: '#/components/examples/post-paymentMethods-filtered-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -564,6 +643,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -592,13 +674,21 @@ paths: $ref: '#/components/examples/post-paymentMethods-balance-basic' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + plastix-200: + $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -629,12 +719,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -661,10 +751,6 @@ paths: content: application/json: examples: - split: - $ref: '#/components/examples/post-paymentSession-split' - web: - $ref: '#/components/examples/post-paymentSession-web' android: $ref: '#/components/examples/post-paymentSession-android' ios: @@ -673,19 +759,26 @@ paths: $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick-200: + $ref: '#/components/examples/post-paymentSession-enableOneClick-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -701,9 +794,6 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -716,12 +806,12 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -743,44 +833,18 @@ paths: content: application/json: examples: - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' - giropay: - $ref: '#/components/examples/post-payments-giropay' - card-3d-secure-securedfields: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' - enableOneClick-raw: - $ref: '#/components/examples/post-payments-enableOneClick-raw' - applepay: - $ref: '#/components/examples/post-payments-applepay' - ideal: - $ref: '#/components/examples/post-payments-ideal' - oneclick-securedfields: - $ref: '#/components/examples/post-payments-oneclick-securedfields' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' - recurring: - $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' - sofort: - $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' card-3d-secure-direct: $ref: '#/components/examples/post-payments-card-3d-secure-direct' klarna: $ref: '#/components/examples/post-payments-klarna' - split: - $ref: '#/components/examples/post-payments-split' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' schema: $ref: '#/components/schemas/PaymentRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -788,48 +852,39 @@ paths: schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -851,6 +906,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DetailsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -858,6 +915,9 @@ paths: schema: $ref: '#/components/schemas/PaymentDetailsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -885,6 +945,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -910,6 +973,8 @@ paths: $ref: '#/components/examples/post-payments-result-basic' schema: $ref: '#/components/schemas/PaymentVerificationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -917,6 +982,9 @@ paths: schema: $ref: '#/components/schemas/PaymentVerificationResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -947,12 +1015,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -3069,19 +3137,19 @@ components: type: string encryptedCardNumber: description: The encrypted card number. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryMonth: description: The encrypted card expiry month. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryYear: description: The encrypted card expiry year. - maxLength: 7000 + maxLength: 10000 type: string encryptedSecurityCode: description: The encrypted card verification code. - maxLength: 7000 + maxLength: 10000 type: string expiryMonth: description: The card expiry month. Only collect raw card data if you are @@ -3341,8 +3409,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -3566,53 +3640,20 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Success** \u2013 Indicates that the balance check was successful.\n\ + * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\ + \ have enough balance to pay the amount in the request, or that the currency\ + \ of the balance on the card did not match the currency of the requested\ + \ amount.\n* **Failed** \u2013 Indicates that the balance check failed." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success + - NotEnoughBalance + - Failed type: string required: - balance + - resultCode CheckoutBankTransferAction: additionalProperties: false properties: @@ -3669,7 +3710,11 @@ components: description: A unique reference of the cancellation request. type: string resultCode: - description: The result of the cancellation request. + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Received** \u2013 Indicates the cancellation has successfully been\ + \ received by Adyen, and will be processed." + enum: + - Received type: string required: - pspReference @@ -3745,55 +3790,16 @@ components: description: The remaining amount in the order. $ref: '#/components/schemas/Amount' resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the order creation request.\n The value is always\ + \ **Success**." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success type: string required: - remainingAmount - expiresAt - orderData + - resultCode CheckoutDonationAction: additionalProperties: false properties: @@ -5363,8 +5369,10 @@ components: properties: action: x-addedInVersion: 49 - description: Action to be taken for completing the payment. - $ref: '#/components/schemas/CheckoutThreeDS2ChallengeAction' + description: Action to be taken for completing the payment. When returned, + only the 3D Secure action is needed in most cases. + oneOf: + - $ref: '#/components/schemas/CheckoutRedirectAction' additionalData: additionalProperties: type: string @@ -6110,8 +6118,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -6767,8 +6781,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -8090,11 +8110,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -8639,6 +8659,21 @@ components: BasicAuth: scheme: basic type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string examples: generic-400: summary: Response code 400. Bad request. @@ -8676,10 +8711,38 @@ components: message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' + get-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A patch-paymentLinks-linkId-basic: summary: Update the status of a payment link value: status: expired + patch-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: expired + url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -8688,6 +8751,17 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178914061985' + resultCode: Success + expiresAt: '2021-04-09T14:16:46Z' + orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== + reference: shopper-reference-ekvL83 + remainingAmount: + currency: EUR + value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -8695,6 +8769,11 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8816178914079738' + resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -8702,6 +8781,13 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com + post-originKeys-basic-200: + summary: Example response for request 'basic' + value: + originKeys: + https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw + https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc + https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -8728,6 +8814,15 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP + post-paymentLinks-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 1250 + expiresAt: '2021-04-09T14:17:31Z' + reference: shopper-reference-ekvL83 + url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -8745,10 +8840,1471 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix-200: + summary: Example response for request 'plastix' + value: + additionalData: + nonScheme.transactionLimit: '5000' + nonScheme.transactionLimitCcy: EUR + pspReference: 851617891188737F + resultCode: Success + balance: + currency: EUR + value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic-200: + summary: Example response for request 'basic' + value: + paymentMethods: + - details: + - details: + - key: ownerName + type: text + - key: bankLocationId + type: text + - key: bankAccountNumber + type: text + key: bankAccount + type: bankAccount + name: ACH Direct Debit + type: ach + - name: Adyen Voucher + type: adyen_test_voucher + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: Afterpay + type: afterpaytouch + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: AliPay + type: alipay + - name: AliPay HK + type: alipay_hk + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Credit Card via AsiaPay + type: asiapay + - name: China UnionPay + type: asiapay_unionpay + - name: Baby Gift Card + type: babygiftcard + - name: Baloto + type: baloto + - name: BancNet + type: bancnet + - name: Bank Transfer (BG) + type: bankTransfer_BG + - name: Bank Transfer (CH) + type: bankTransfer_CH + - name: Bank Transfer (DE) + type: bankTransfer_DE + - name: Bank Transfer (FI) + type: bankTransfer_FI + - name: Bank Transfer (GB) + type: bankTransfer_GB + - name: Bank Transfer (HU) + type: bankTransfer_HU + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bank Transfer (IE) + type: bankTransfer_IE + - name: Electronic Bank Transfer (MX) + type: bankTransfer_MX_linked + - name: Bank Transfer (MX) + type: bankTransfer_MX_offline + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Bank Transfer (PL) + type: bankTransfer_PL + - name: Bank Transfer (SE) + type: bankTransfer_SE + - name: Bank Transfer (US) + type: bankTransfer_US + - name: Payconiq by Bancontact + type: bcmc_mobile + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: 99Bill + type: bill99 + - details: + - items: + - id: AUB_DIRECT + name: AU Small Finance Bank + - id: ALB_DIRECT + name: 'Allahabad Bank ' + - id: APG_DIRECT + name: Andhra Pragathi Grameena Bank + - id: BDN_DIRECT + name: Bandhan bank + - id: BBK_DIRECT + name: Bank of Bahrain and Kuwait + - id: BBR_DIRECT + name: Bank of Baroda - Retail Banking + - id: BCB_DIRECT + name: 'Bassien Catholic Co-Operative Bank ' + - id: CNB_DIRECT + name: Canara Bank + - id: SYD_DIRECT + name: Canara Bank (e-Syndicate) + - id: CSB_DIRECT + name: Catholic Syrian Bank + - id: CBI_DIRECT + name: Central Bank of India + - id: CUB_DIRECT + name: City Union Bank + - id: COB_DIRECT + name: Cosmos Bank + - id: DEN_DIRECT + name: Dena Bank + - id: DBK_DIRECT + name: Deutsche Bank + - id: DCB_DIRECT + name: Development Credit Bank + - id: DLB_DIRECT + name: Dhanlakshmi Bank - Retail Net Banking + - id: ESF_DIRECT + name: ESAF Small Finance Bank + - id: EQB_DIRECT + name: Equitas Small Finance Bank + - id: FBK_DIRECT + name: Federal Bank + - id: FNC_DIRECT + name: Fincare Bank + - id: HDF_DIRECT + name: HDFC Bank + - id: ICI_DIRECT + name: 'ICICI Bank ' + - id: IDB_DIRECT + name: IDBI Bank - Retail Net Banking + - id: IDN_DIRECT + name: IDFC FIRST Bank + - id: INB_DIRECT + name: Indian Bank + - id: IOB_DIRECT + name: Indian Overseas Bank + - id: IDS_DIRECT + name: IndusInd Bank + - id: JKB_DIRECT + name: Jammu & Kashmir Bank + - id: JNB_DIRECT + name: Jana Small Finance Bank + - id: JSB_DIRECT + name: Janata Sahakari Bank Ltd Pune + - id: KJB_DIRECT + name: Kalyan Janata Sahakari Bank + - id: KBL_DIRECT + name: Karnataka Bank Ltd + - id: KVB_DIRECT + name: Karur Vysya Bank + - id: 162_DIRECT + name: Kotak Bank + - id: LVR_DIRECT + name: Laxmi Vilas Bank - Retail + - id: NKB_DIRECT + name: NKGSB Co-op Bank + - id: NEB_DIRECT + name: North East Small Finance Bank + - id: OBC_DIRECT + name: PNB (Erstwhile-Oriental Bank of Commerce) + - id: UNI_DIRECT + name: PNB (Erstwhile-United Bank of India) + - id: PMC_DIRECT + name: Punjab & Maharastra Co-op Bank + - id: PSB_DIRECT + name: Punjab & Sind Bank + - id: CPN_DIRECT + name: 'Punjab National Bank - Corporate ' + - id: PNB_DIRECT + name: Punjab National Bank - Retail Banking + - id: RBL_DIRECT + name: RBL Bank Limited + - id: SWB_DIRECT + name: Saraswat Bank + - id: SHB_DIRECT + name: Shivalik Mercantile Cooperative Bank Ltd + - id: SIB_DIRECT + name: South Indian Bank + - id: SCB_DIRECT + name: Standard Chartered Bank + - id: SBI_DIRECT + name: State Bank of India + - id: SRB_DIRECT + name: Suryoday Small Finance Bank + - id: TJB_DIRECT + name: TJSB Bank + - id: TNC_DIRECT + name: Tamil Nadu State Co-operative Bank + - id: TMB_DIRECT + name: Tamilnad Mercantile Bank Ltd + - id: TBB_DIRECT + name: Thane Bharat Sahakari Bank Ltd + - id: MSB_DIRECT + name: The Mehsana Urban Co Op Bank Ltd + - id: UCO_DIRECT + name: UCO Bank + - id: UBI_DIRECT + name: Union Bank of India + - id: ADB_DIRECT + name: Union Bank of India (Erstwhile Andhra Bank) + - id: CRP_DIRECT + name: Union Bank of India (Erstwhile Corporation Bank) + - id: VRB_DIRECT + name: Varachha Co-operative Bank Limited + - id: VJB_DIRECT + name: Vijaya Bank + - id: YBK_DIRECT + name: Yes Bank + - id: ZOB_DIRECT + name: Zoroastrian Co-operative Bank Limited + - id: DBS_DIRECT + name: digibank by DBS + key: issuer + type: select + name: Online Banking India + type: billdesk_online + - name: UPI + type: billdesk_upi + - details: + - items: + - id: DCW_DIRECT + name: DCB Cippy + - id: ICC_DIRECT + name: ICC Cash Card + - id: OXY_DIRECT + name: Oxigen Wallet + - id: PCH_DIRECT + name: Pay World Money + key: issuer + type: select + name: Wallets India + type: billdesk_wallet + - name: Blik + type: blik + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Boleto + type: boleto + - name: Boleto Bancario + type: boletobancario_santander + - name: Bradesco + type: bradesco + - name: Cash-Ticket + type: cashticket + - name: CashU + type: cashu + - name: CCAvenue + type: ccavenue + - name: Mula Checkout + type: cellulant + - name: Chasin Giftcard + type: chasingiftcard + - name: Clearpay + type: clearpay + - name: ClickandBuy + type: clickandbuy + - name: Paiement en 3 fois par Cartes Bancaires + type: cofinoga_3xcb + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: DANA + type: dana + - name: DineroMail + type: dineromail + - name: Online bank transfer. + type: directEbanking + - name: Direct Debit Brazil - Banco do Brazil + type: directdebit_BR_bancodobrasil + - name: Direct Debit Brazil - Bradesco + type: directdebit_BR_bradesco + - name: Direct Debit Brazil - Caixa Economica Federal + type: directdebit_BR_caixa + - name: Direct Debit Brazil - HSBC + type: directdebit_BR_hsbc + - name: Direct Debit Brazil - Itau + type: directdebit_BR_itau + - name: Direct Debit Brazil - Santander + type: directdebit_BR_santander + - name: BACS Direct Debit + type: directdebit_GB + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Alfamart + type: doku_alfamart + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BCA Bank Transfer + type: doku_bca_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BNI VA + type: doku_bni_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BRI VA + type: doku_bri_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: CIMB VA + type: doku_cimb_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Danamon VA + type: doku_danamon_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Indomaret + type: doku_indomaret + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Mandiri VA + type: doku_mandiri_va + - details: + - key: ovoId + type: text + name: OVO + type: doku_ovo + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Bank Transfer + type: doku_permata_lite_atm + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: DOKU wallet + type: doku_wallet + - details: + - items: + - id: '66' + name: Bank Nowy BFG S.A. + - id: '92' + name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" + - id: '11' + name: Bank transfer / postal + - id: '74' + name: "Banki Sp\xF3\u0142dzielcze" + - id: '73' + name: BLIK + - id: '90' + name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" + - id: '59' + name: CinkciarzPAY + - id: '87' + name: Credit Agricole PBL + - id: '83' + name: EnveloBank + - id: '76' + name: Getin Bank PBL + - id: '81' + name: Idea Cloud + - id: '7' + name: ING Corporate customers + - id: '93' + name: Kasa Stefczyka + - id: '44' + name: "Millennium - P\u0142atno\u015Bci Internetowe" + - id: '10' + name: Millennium Corporate customers + - id: '68' + name: mRaty + - id: '1' + name: mTransfer + - id: '91' + name: Nest Bank + - id: '80' + name: Noble Pay + - id: '50' + name: Pay Way Toyota Bank + - id: '45' + name: Pay with Alior Bank + - id: '36' + name: Pekao24Przelew + - id: '70' + name: Pocztowy24 + - id: '6' + name: Przelew24 + - id: '46' + name: "P\u0142ac\u0119 z Citi Handlowy" + - id: '38' + name: "P\u0142ac\u0119 z ING" + - id: '2' + name: "P\u0142ac\u0119 z Inteligo" + - id: '4' + name: "P\u0142ac\u0119 z iPKO" + - id: '75' + name: "P\u0142ac\u0119 z Plus Bank" + - id: '51' + name: "P\u0142a\u0107 z BO\u015A" + - id: '55' + name: Raty z Alior Bankiem PLN + - id: '89' + name: Santander + - id: '52' + name: SkyCash + key: issuer + type: select + name: Local Polish Payment Methods + type: dotpay + - name: Dragonpay Prepaid Credits + type: dragonpay_credits + - name: Online Banking + type: dragonpay_ebanking + - name: GCash + type: dragonpay_gcash + - name: Over The Counter Banks + type: dragonpay_otc_banking + - name: OTC non-Bank via Dragonpay + type: dragonpay_otc_non_banking + - name: Convenience Stores + type: dragonpay_otc_philippines + - name: 7/11 + type: dragonpay_seveneleven + - name: eagleeye_voucher + type: eagleeye_voucher + - name: Finnish E-Banking + type: ebanking_FI + - name: Pay-easy ATM + type: econtext_atm + - name: Online Banking + type: econtext_online + - name: 7-Eleven + type: econtext_seven_eleven + - name: Convenience Stores + type: econtext_stores + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Lastschrift (ELV) + type: elv + - details: + - items: + - id: '231' + name: POP Pankki + - id: '551' + name: "Komer\u010Dn\xED banka" + - id: '232' + name: Aktia + - id: '552' + name: Raiffeisen + - id: '233' + name: "S\xE4\xE4st\xF6pankki" + - id: '750' + name: Swedbank + - id: '211' + name: Nordea + - id: '553' + name: "\u010CSOB" + - id: '234' + name: S-Pankki + - id: '751' + name: SEB + - id: '554' + name: Moneta + - id: '235' + name: OmaSP + - id: '752' + name: Nordea + - id: '213' + name: Op-Pohjola + - id: '555' + name: UniCredit + - id: '753' + name: LHV + - id: '556' + name: Fio + - id: '557' + name: mBank + - id: '216' + name: Handelsbanken + - id: '558' + name: Air Bank + - id: '260' + name: "L\xE4nsf\xF6rs\xE4kringar" + - id: '240' + name: BankDeposit + - id: '265' + name: Sparbanken + - id: '640' + name: BankDeposit + - id: '200' + name: "\xC5landsbanken" + - id: '940' + name: Swedbank + - id: '500' + name: "\u010Cesk\xE1 spo\u0159itelna" + - id: '720' + name: Swedbank + - id: '941' + name: SEB + - id: '204' + name: Danske Bank + - id: '721' + name: SEB + - id: '942' + name: Citadele + - id: '205' + name: Handelsbanken + - id: '722' + name: DNB + - id: '943' + name: DNB + - id: '206' + name: Nordea + - id: '723' + name: "\u0160iauli\u0173 bankas" + - id: '207' + name: SEB + - id: '724' + name: Nordea + - id: '505' + name: "Komer\u010Dn\xED banka" + - id: '208' + name: Skandiabanken + - id: '209' + name: Swedbank + key: issuer + type: select + name: Bank Payment + type: entercash + - name: Nationale Entertainment Card + type: entertainmentcard + - details: + - items: + - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 + name: Dolomitenbank + - id: ee9fc487-ebe0-486c-8101-17dce5141a67 + name: Raiffeissen Bankengruppe + - id: 6765e225-a0dc-4481-9666-e26303d4f221 + name: Hypo Tirol Bank AG + - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc + name: Sparda Bank Wien + - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f + name: Schoellerbank AG + - id: e2e97aaa-de4c-4e18-9431-d99790773433 + name: Volksbank Gruppe + - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 + name: Immo-Bank + - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 + name: Bank Austria + - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 + name: Easybank AG + - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a + name: VR-BankBraunau + - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 + name: Volkskreditbank + - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 + name: Erste Bank und Sparkassen + - id: ba7199cc-f057-42f2-9856-2378abf21638 + name: BAWAG P.S.K. Gruppe + key: issuer + type: select + name: EPS + type: eps + - name: Expert Cadeaukaart + type: expertgiftcard + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 3x Oney + type: facilypay_3x + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 4x Oney + type: facilypay_4x + - name: Fashioncheque + type: fashioncheque + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: Fawry + type: fawry + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Fonq Giftcard + type: fonqgiftcard + - name: Gall & Gall + type: gallgall + - name: GCash + type: gcash + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - details: + - key: bic + type: text + name: GiroPay + type: giropay + - name: Givex + type: givex + - name: Globe GCash + type: globegcash + - name: Goldsmiths Card + type: goldsmithscard + - name: GoPay Wallet + type: gopay_wallet + - name: OVO + type: grabpay_ID + - name: GrabPay + type: grabpay_PH + - name: GrabPay + type: grabpay_SG + - name: Hallmark Card + type: hallmarkcard + - name: HDFC + type: hdfc + - name: Hunkemoller Member Card + type: hmclub + - name: Hunkemoller Lingerie Card + type: hmlingerie + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - name: igive + type: igive + - name: Korean Account Transfer (IniPay) + type: inicisIniPay_accounttransfer + - name: Korean Credit Cards (IniPay) + type: inicisIniPay_creditcard + - name: Korean Mobile Phone (IniPay) + type: inicisIniPay_mobilephone + - name: Korean Virtual Account (IniPay) + type: inicisIniPay_virtualaccount + - name: Korean Account Transfer (Mobile) + type: inicisMobile_accounttransfer + - name: Korean Credit Cards (Mobile) + type: inicisMobile_creditcard + - name: Korean Mobile Phone (Mobile) + type: inicisMobile_mobilephone + - name: Korean Virtual Account (Mobile) + type: inicisMobile_virtualaccount + - name: Korean Credit Cards + type: inicis_creditcard + - name: "Interac\xAE Online" + type: interac + - name: Instant EFT + type: ipay + - name: iPay88 + type: ipay88 + - name: isracard + type: isracard + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: KakaoPay + type: kakaopay + - name: Karen Millen Card + type: karenmillen + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Bank Transfer + type: kcp_banktransfer + - name: "Korea\u2013issued cards" + type: kcp_creditcard + - name: PayCo + type: kcp_payco + - name: Virtual Account via KCP + type: kcp_va + - name: Pay later with Klarna. + type: klarna + - name: Pay over time with Klarna. + type: klarna_account + - name: Klarna B2B + type: klarna_b2b + - name: Pay now with Klarna. + type: klarna_paynow + - name: Leisure Card + type: leisurecard + - name: China Credit Card + type: lianlianpay_creditcard + - name: China Debit Card + type: lianlianpay_debitcard + - details: + - key: telephoneNumber + type: tel + name: China Online Banking - Credit Card + type: lianlianpay_ebanking_credit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '4031000' + name: Bank of Beijing + - id: '01040000' + name: Bank of China + - id: '03020000' + name: China Citic Bank + - id: '01050000' + name: China Construction Bank + - id: '03030000' + name: China Everbright Bank + - id: 03080000 + name: China Merchants Bank + - id: '03050000' + name: China Minsheng Banking Group + - id: '03040000' + name: Hua Xia Bank Co + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03070000' + name: PingAn Bank + - id: '1000000' + name: Postal Savings Bank of China + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Debit Card + type: lianlianpay_ebanking_debit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '01050000' + name: China Construction Bank + - id: 03080000 + name: China Merchants Bank + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03100000' + name: Shanghai Pudong Development Bank + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Enterprise + type: lianlianpay_ebanking_enterprise + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - name: Love2Shop GiftCard + type: love2shop + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: mada + type: mada + - name: Mappin & Webb Card + type: mappinwebbcard + - name: MB WAY + type: mbway + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: Mercado Pago + type: mercadopago + - name: MobilePay + type: mobilepay + - name: AliPay via Razer Merchant Services + type: molpay_alipay + - name: 7-Eleven + type: molpay_cash + - name: CIMB Virtual Account + type: molpay_cimb_va + - name: Malaysia E-Banking via Razer Merchant Services + type: molpay_ebanking_MY + - details: + - items: + - id: vtcpay-vietinbank + name: Vietinbank + - id: vtcpay-bidv + name: BIDV + - id: vtcpay-agribank + name: Agribank + - id: vtcpay-mb + name: MB Bank + - id: vtcpay-sacombank + name: Sacombank + - id: vtcpay-dongabank + name: DongABank + - id: vtcpay-maritimebank + name: MaritimeBank + - id: vtcpay-vietcombank + name: Vietcombank + - id: vtcpay-acb + name: ACB + - id: vtcpay-techcombank + name: Techcombank + key: issuer + type: select + name: Vietnam E-Banking + type: molpay_ebanking_VN + - details: + - items: + - id: fpx_bimb + name: Bank Islam + - id: fpx_uob + name: UOB Bank + - id: fpx_cimbclicks + name: CIMB Clicks + - id: fpx_kfh + name: Kuwait Finance House + - id: fpx_rhb + name: RHB Now + - id: fpx_abmb + name: Alliance Bank + - id: fpx_amb + name: Am Online + - id: fpx_hsbc + name: HSBC + - id: fpx_abb + name: Affin Bank + - id: fpx_ocbc + name: OCBC Bank + - id: fpx_pbb + name: Public Bank + - id: fpx_scb + name: Standard Chartered Bank + - id: fpx_bsn + name: Bank Simpanan Nasional + - id: fpx_mb2u + name: Maybank2u + - id: fpx_hlb + name: Hong Leong Connect + - id: fpx_bmmb + name: Bank Muamalat + - id: fpx_bkrm + name: Bank Rakyat + key: issuer + type: select + name: Malaysia E-Banking + type: molpay_ebanking_fpx_MY + - name: eNETS Debit + type: molpay_enetsd + - name: epay + type: molpay_epay + - name: Esapay + type: molpay_esapay + - name: MyClear FPX + type: molpay_fpx + - name: Maybank2u + type: molpay_maybank2u + - name: Nganluong + type: molpay_nganluong + - name: Tesco Lotus + type: molpay_paysbuy + - name: MOLPoints + type: molpay_points + - name: RHB Now + type: molpay_rhb + - name: SAM by SingPost + type: molpay_singpost + - name: MOLWallet + type: molpay_wallet + - name: MoMo ATM + type: momo_atm + - name: Momo Wallet + type: momo_wallet + - name: Moneybookers + type: moneybookers + - name: Multibanco + type: multibanco + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: BankAxess + type: netaxept_bankaxess + - name: NETELLER + type: neteller + - name: Onebip + type: onebip + - name: One Two Three + type: onetwothree + - name: Local Polish Payment Methods + type: onlineBanking_PL + - details: + - items: + - id: '1' + name: Model Bank v2 + key: issuer + type: select + name: Online banking + type: openbanking_UK + - name: Oxxo + type: oxxo + - name: Pathe Giftcard + type: pathegiftcard + - name: PayBright + type: paybright + - name: PayMaya Wallet + type: paymaya_wallet + - name: PayPal + type: paypal + - name: Paysafecard + type: paysafecard + - name: Payshop + type: payshop + - name: PayD AMT via Paythru + type: paythru_amt + - name: EFT via Paythru + type: paythru_eft + - name: PayTM + type: paytm + - details: + - key: virtualPaymentAddress + type: text + name: PayU UPI + type: payu_IN_upi + - name: EFT Pro via PayU + type: payu_ZA_eftpro + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: pix + type: pix + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Podium Card + type: podiumcard + - name: POLi + type: poli + - name: PPS + type: pps + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Illicado Gift Card + type: prosodie_illicado + - name: PSE + type: pse + - details: + - items: + - id: '+7' + name: RU + - id: '+9955' + name: GE + - id: '+507' + name: PA + - id: '+44' + name: GB + - id: '+992' + name: TJ + - id: '+370' + name: LT + - id: '+972' + name: IL + - id: '+996' + name: KG + - id: '+380' + name: UA + - id: '+84' + name: VN + - id: '+90' + name: TR + - id: '+994' + name: AZ + - id: '+374' + name: AM + - id: '+371' + name: LV + - id: '+91' + name: IN + - id: '+66' + name: TH + - id: '+373' + name: MD + - id: '+1' + name: US + - id: '+81' + name: JP + - id: '+998' + name: UZ + - id: '+77' + name: KZ + - id: '+375' + name: BY + - id: '+372' + name: EE + - id: '+40' + name: RO + - id: '+82' + name: KR + key: qiwiwallet.telephoneNumberPrefix + type: select + - key: qiwiwallet.telephoneNumber + type: text + name: Qiwi Wallet + type: qiwiwallet + - name: RatePay Invoice + type: ratepay + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: SafetyPay + type: safetypay + - name: SafetyPay Cash + type: safetypay_cash + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: SEB Direktbetalning + type: sebdirectpayment + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: 7-Eleven + type: seveneleven + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: Swish + type: swish + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: TenPay + type: tenpay + - name: The Sting Giftcard + type: thestinggiftcard + - name: Trustly + type: trustly + - name: Online Banking by Trustpay + type: trustpay + - name: TWINT + type: twint + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - details: + - key: virtualPaymentAddress + type: text + name: UPI Collect + type: upi_collect + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: telephoneNumber + optional: true + type: tel + name: Vipps + type: vipps + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: VVV Giftcard + type: vvvgiftcard + - name: Webshop Giftcard + type: webshopgiftcard + - name: WeChat Pay + type: wechatpayMiniProgram + - name: WeChat Pay + type: wechatpayQR + - name: WeChat Pay + type: wechatpayWeb + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: WOS Card + type: woscard + - name: Alfa-Click + type: yandex_alfaclick + - name: Pay using bank card + type: yandex_bank_card + - name: Cash terminals + type: yandex_cash + - name: Pay using installments + type: yandex_installments + - name: YooMoney + type: yandex_money + - name: Promsvyazbank + type: yandex_promsvyazbank + - name: Sberbank Online + type: yandex_sberbank + - name: WebMoney + type: yandex_webmoney + - name: Your Gift + type: yourgift + - name: Zip + type: zip post-paymentMethods-filtered: summary: Get payment methods based on the country and amount value: @@ -8758,6 +10314,313 @@ components: amount: currency: EUR value: 1000 + post-paymentMethods-filtered-200: + summary: Example response for request 'filtered' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentMethods-include-oneclick: summary: Get payment methods including stored card details value: @@ -8767,6 +10630,313 @@ components: currency: EUR value: 1000 shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-paymentMethods-include-oneclick-200: + summary: Example response for request 'include-oneclick' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -8800,6 +10970,10 @@ components: shopperLocale: nl_NL merchantAccount: YOUR_MERCHANT_ACCOUNT sdkVersion: 1.7.0 + post-paymentSession-enableOneClick-200: + summary: Example response for request 'enableOneClick' + value: + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-paymentSession-ios: summary: Set up a payment session (iOS) value: @@ -8815,62 +10989,10 @@ components: shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-split: - summary: Split a payment between a sub-merchant and a platform account + post-paymentSession-web-200: + summary: Example response for request 'web' value: - amount: - currency: EUR - value: 6200 - additionalData: - split.api: '1' - split.nrOfItems: '2' - split.totalAmount: '6200' - split.currencyCode: EUR - split.item1.amount: '6000' - split.item1.type: MarketPlace - split.item1.account: '151272963' - split.item1.reference: '6124145' - split.item1.description: 'Porcelain Doll: Eliza (20cm)' - split.item2.amount: '200' - split.item2.type: Commission - split.item2.reference: '6124146' - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Android - token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK - returnUrl: app:// - countryCode: NL - shopperLocale: nl_NL - sessionValidity: '2017-04-06T13:09:13Z' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-payments-applepay: - summary: Make an Apple Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: applepay - applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -8932,131 +11054,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields: - summary: Make a payment with 3D Secure 2 native authentication - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4212345678901237 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - holderName: John Smith - browserInfo: - userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 - Firefox/3.0 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct: - summary: Make a card payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw: - summary: Tokenize card details for one-off payments - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - storePaymentMethod: true - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay: - summary: Make a giropay payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: giropay - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-googlepay: - summary: Make a Google Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: paywithgoogle - googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... - merchantAccount: YourMerchantAccount - post-payments-ideal: - summary: Make an iDEAL payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: ideal - issuer: '1121' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-klarna: summary: Make a Klarna payment value: @@ -9122,95 +11119,7 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-oneclick-securedfields: - summary: Make a one-off payment with a token and CVV (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - storedPaymentMethodId: '8416038790273850' - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: CardOnFile - post-payments-recurring: - summary: Make a card payment with a token - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - storedPaymentMethodId: '8316038796685850' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: Subscription post-payments-result-basic: summary: Verify payment results value: payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK - post-payments-sofort: - summary: Make a Sofort payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: directEbanking - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-split: - summary: Split a payment between a sub-merchant and a platform account - value: - paymentMethod: - type: scheme - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' - post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT diff --git a/yaml/CheckoutService-v65.yaml b/yaml/CheckoutService-v65.yaml index 7b38d3b..8ee980e 100644 --- a/yaml/CheckoutService-v65.yaml +++ b/yaml/CheckoutService-v65.yaml @@ -81,13 +81,21 @@ paths: $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-basic-200' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -124,6 +132,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -150,13 +161,21 @@ paths: $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-cancel-basic-200' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -193,6 +212,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -223,13 +245,21 @@ paths: $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-originKeys-basic-200' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -266,6 +296,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -295,19 +328,30 @@ paths: $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/CreatePaymentLinkRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentLinks-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '201': content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResource' description: Created - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -344,6 +388,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -367,13 +414,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -410,6 +464,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -441,13 +498,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -484,6 +548,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -521,13 +588,25 @@ paths: $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentMethods-basic-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + filtered-200: + $ref: '#/components/examples/post-paymentMethods-filtered-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -564,6 +643,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -592,13 +674,21 @@ paths: $ref: '#/components/examples/post-paymentMethods-balance-basic' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + plastix-200: + $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -629,12 +719,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -661,10 +751,6 @@ paths: content: application/json: examples: - split: - $ref: '#/components/examples/post-paymentSession-split' - web: - $ref: '#/components/examples/post-paymentSession-web' android: $ref: '#/components/examples/post-paymentSession-android' ios: @@ -673,19 +759,26 @@ paths: $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick-200: + $ref: '#/components/examples/post-paymentSession-enableOneClick-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -701,9 +794,6 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -716,12 +806,12 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -743,44 +833,18 @@ paths: content: application/json: examples: - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' - giropay: - $ref: '#/components/examples/post-payments-giropay' - card-3d-secure-securedfields: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' - enableOneClick-raw: - $ref: '#/components/examples/post-payments-enableOneClick-raw' - applepay: - $ref: '#/components/examples/post-payments-applepay' - ideal: - $ref: '#/components/examples/post-payments-ideal' - oneclick-securedfields: - $ref: '#/components/examples/post-payments-oneclick-securedfields' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' - recurring: - $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' - sofort: - $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' card-3d-secure-direct: $ref: '#/components/examples/post-payments-card-3d-secure-direct' klarna: $ref: '#/components/examples/post-payments-klarna' - split: - $ref: '#/components/examples/post-payments-split' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' schema: $ref: '#/components/schemas/PaymentRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -788,48 +852,39 @@ paths: schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -851,6 +906,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DetailsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -858,6 +915,9 @@ paths: schema: $ref: '#/components/schemas/PaymentDetailsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -885,6 +945,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -910,6 +973,8 @@ paths: $ref: '#/components/examples/post-payments-result-basic' schema: $ref: '#/components/schemas/PaymentVerificationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -917,6 +982,9 @@ paths: schema: $ref: '#/components/schemas/PaymentVerificationResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -947,12 +1015,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -3081,19 +3149,19 @@ components: type: string encryptedCardNumber: description: The encrypted card number. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryMonth: description: The encrypted card expiry month. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryYear: description: The encrypted card expiry year. - maxLength: 7000 + maxLength: 10000 type: string encryptedSecurityCode: description: The encrypted card verification code. - maxLength: 7000 + maxLength: 10000 type: string expiryMonth: description: The card expiry month. Only collect raw card data if you are @@ -3347,8 +3415,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -3572,50 +3646,16 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Success** \u2013 Indicates that the balance check was successful.\n\ + * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\ + \ have enough balance to pay the amount in the request, or that the currency\ + \ of the balance on the card did not match the currency of the requested\ + \ amount.\n* **Failed** \u2013 Indicates that the balance check failed." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success + - NotEnoughBalance + - Failed type: string transactionLimit: x-addedInVersion: 65 @@ -3624,6 +3664,7 @@ components: $ref: '#/components/schemas/Amount' required: - balance + - resultCode CheckoutBankTransferAction: additionalProperties: false properties: @@ -3680,7 +3721,11 @@ components: description: A unique reference of the cancellation request. type: string resultCode: - description: The result of the cancellation request. + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Received** \u2013 Indicates the cancellation has successfully been\ + \ received by Adyen, and will be processed." + enum: + - Received type: string required: - pspReference @@ -3756,55 +3801,16 @@ components: description: The remaining amount in the order. $ref: '#/components/schemas/Amount' resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the order creation request.\n The value is always\ + \ **Success**." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success type: string required: - remainingAmount - expiresAt - orderData + - resultCode CheckoutDonationAction: additionalProperties: false properties: @@ -5378,8 +5384,10 @@ components: properties: action: x-addedInVersion: 49 - description: Action to be taken for completing the payment. - $ref: '#/components/schemas/CheckoutThreeDS2ChallengeAction' + description: Action to be taken for completing the payment. When returned, + only the 3D Secure action is needed in most cases. + oneOf: + - $ref: '#/components/schemas/CheckoutRedirectAction' additionalData: additionalProperties: type: string @@ -6094,8 +6102,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -6745,8 +6759,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -8079,11 +8099,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -8628,6 +8648,21 @@ components: BasicAuth: scheme: basic type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string examples: generic-400: summary: Response code 400. Bad request. @@ -8667,10 +8702,38 @@ components: message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' + get-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A patch-paymentLinks-linkId-basic: summary: Update the status of a payment link value: status: expired + patch-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: expired + url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -8679,6 +8742,17 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178914061985' + resultCode: Success + expiresAt: '2021-04-09T14:16:46Z' + orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== + reference: shopper-reference-ekvL83 + remainingAmount: + currency: EUR + value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -8686,6 +8760,11 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8816178914079738' + resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -8693,6 +8772,13 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com + post-originKeys-basic-200: + summary: Example response for request 'basic' + value: + originKeys: + https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw + https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc + https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -8719,6 +8805,15 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP + post-paymentLinks-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 1250 + expiresAt: '2021-04-09T14:17:31Z' + reference: shopper-reference-ekvL83 + url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -8736,10 +8831,1471 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix-200: + summary: Example response for request 'plastix' + value: + additionalData: + nonScheme.transactionLimit: '5000' + nonScheme.transactionLimitCcy: EUR + pspReference: 851617891188737F + resultCode: Success + balance: + currency: EUR + value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic-200: + summary: Example response for request 'basic' + value: + paymentMethods: + - details: + - details: + - key: ownerName + type: text + - key: bankLocationId + type: text + - key: bankAccountNumber + type: text + key: bankAccount + type: bankAccount + name: ACH Direct Debit + type: ach + - name: Adyen Voucher + type: adyen_test_voucher + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: Afterpay + type: afterpaytouch + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: AliPay + type: alipay + - name: AliPay HK + type: alipay_hk + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Credit Card via AsiaPay + type: asiapay + - name: China UnionPay + type: asiapay_unionpay + - name: Baby Gift Card + type: babygiftcard + - name: Baloto + type: baloto + - name: BancNet + type: bancnet + - name: Bank Transfer (BG) + type: bankTransfer_BG + - name: Bank Transfer (CH) + type: bankTransfer_CH + - name: Bank Transfer (DE) + type: bankTransfer_DE + - name: Bank Transfer (FI) + type: bankTransfer_FI + - name: Bank Transfer (GB) + type: bankTransfer_GB + - name: Bank Transfer (HU) + type: bankTransfer_HU + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bank Transfer (IE) + type: bankTransfer_IE + - name: Electronic Bank Transfer (MX) + type: bankTransfer_MX_linked + - name: Bank Transfer (MX) + type: bankTransfer_MX_offline + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Bank Transfer (PL) + type: bankTransfer_PL + - name: Bank Transfer (SE) + type: bankTransfer_SE + - name: Bank Transfer (US) + type: bankTransfer_US + - name: Payconiq by Bancontact + type: bcmc_mobile + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: 99Bill + type: bill99 + - details: + - items: + - id: AUB_DIRECT + name: AU Small Finance Bank + - id: ALB_DIRECT + name: 'Allahabad Bank ' + - id: APG_DIRECT + name: Andhra Pragathi Grameena Bank + - id: BDN_DIRECT + name: Bandhan bank + - id: BBK_DIRECT + name: Bank of Bahrain and Kuwait + - id: BBR_DIRECT + name: Bank of Baroda - Retail Banking + - id: BCB_DIRECT + name: 'Bassien Catholic Co-Operative Bank ' + - id: CNB_DIRECT + name: Canara Bank + - id: SYD_DIRECT + name: Canara Bank (e-Syndicate) + - id: CSB_DIRECT + name: Catholic Syrian Bank + - id: CBI_DIRECT + name: Central Bank of India + - id: CUB_DIRECT + name: City Union Bank + - id: COB_DIRECT + name: Cosmos Bank + - id: DEN_DIRECT + name: Dena Bank + - id: DBK_DIRECT + name: Deutsche Bank + - id: DCB_DIRECT + name: Development Credit Bank + - id: DLB_DIRECT + name: Dhanlakshmi Bank - Retail Net Banking + - id: ESF_DIRECT + name: ESAF Small Finance Bank + - id: EQB_DIRECT + name: Equitas Small Finance Bank + - id: FBK_DIRECT + name: Federal Bank + - id: FNC_DIRECT + name: Fincare Bank + - id: HDF_DIRECT + name: HDFC Bank + - id: ICI_DIRECT + name: 'ICICI Bank ' + - id: IDB_DIRECT + name: IDBI Bank - Retail Net Banking + - id: IDN_DIRECT + name: IDFC FIRST Bank + - id: INB_DIRECT + name: Indian Bank + - id: IOB_DIRECT + name: Indian Overseas Bank + - id: IDS_DIRECT + name: IndusInd Bank + - id: JKB_DIRECT + name: Jammu & Kashmir Bank + - id: JNB_DIRECT + name: Jana Small Finance Bank + - id: JSB_DIRECT + name: Janata Sahakari Bank Ltd Pune + - id: KJB_DIRECT + name: Kalyan Janata Sahakari Bank + - id: KBL_DIRECT + name: Karnataka Bank Ltd + - id: KVB_DIRECT + name: Karur Vysya Bank + - id: 162_DIRECT + name: Kotak Bank + - id: LVR_DIRECT + name: Laxmi Vilas Bank - Retail + - id: NKB_DIRECT + name: NKGSB Co-op Bank + - id: NEB_DIRECT + name: North East Small Finance Bank + - id: OBC_DIRECT + name: PNB (Erstwhile-Oriental Bank of Commerce) + - id: UNI_DIRECT + name: PNB (Erstwhile-United Bank of India) + - id: PMC_DIRECT + name: Punjab & Maharastra Co-op Bank + - id: PSB_DIRECT + name: Punjab & Sind Bank + - id: CPN_DIRECT + name: 'Punjab National Bank - Corporate ' + - id: PNB_DIRECT + name: Punjab National Bank - Retail Banking + - id: RBL_DIRECT + name: RBL Bank Limited + - id: SWB_DIRECT + name: Saraswat Bank + - id: SHB_DIRECT + name: Shivalik Mercantile Cooperative Bank Ltd + - id: SIB_DIRECT + name: South Indian Bank + - id: SCB_DIRECT + name: Standard Chartered Bank + - id: SBI_DIRECT + name: State Bank of India + - id: SRB_DIRECT + name: Suryoday Small Finance Bank + - id: TJB_DIRECT + name: TJSB Bank + - id: TNC_DIRECT + name: Tamil Nadu State Co-operative Bank + - id: TMB_DIRECT + name: Tamilnad Mercantile Bank Ltd + - id: TBB_DIRECT + name: Thane Bharat Sahakari Bank Ltd + - id: MSB_DIRECT + name: The Mehsana Urban Co Op Bank Ltd + - id: UCO_DIRECT + name: UCO Bank + - id: UBI_DIRECT + name: Union Bank of India + - id: ADB_DIRECT + name: Union Bank of India (Erstwhile Andhra Bank) + - id: CRP_DIRECT + name: Union Bank of India (Erstwhile Corporation Bank) + - id: VRB_DIRECT + name: Varachha Co-operative Bank Limited + - id: VJB_DIRECT + name: Vijaya Bank + - id: YBK_DIRECT + name: Yes Bank + - id: ZOB_DIRECT + name: Zoroastrian Co-operative Bank Limited + - id: DBS_DIRECT + name: digibank by DBS + key: issuer + type: select + name: Online Banking India + type: billdesk_online + - name: UPI + type: billdesk_upi + - details: + - items: + - id: DCW_DIRECT + name: DCB Cippy + - id: ICC_DIRECT + name: ICC Cash Card + - id: OXY_DIRECT + name: Oxigen Wallet + - id: PCH_DIRECT + name: Pay World Money + key: issuer + type: select + name: Wallets India + type: billdesk_wallet + - name: Blik + type: blik + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Boleto + type: boleto + - name: Boleto Bancario + type: boletobancario_santander + - name: Bradesco + type: bradesco + - name: Cash-Ticket + type: cashticket + - name: CashU + type: cashu + - name: CCAvenue + type: ccavenue + - name: Mula Checkout + type: cellulant + - name: Chasin Giftcard + type: chasingiftcard + - name: Clearpay + type: clearpay + - name: ClickandBuy + type: clickandbuy + - name: Paiement en 3 fois par Cartes Bancaires + type: cofinoga_3xcb + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: DANA + type: dana + - name: DineroMail + type: dineromail + - name: Online bank transfer. + type: directEbanking + - name: Direct Debit Brazil - Banco do Brazil + type: directdebit_BR_bancodobrasil + - name: Direct Debit Brazil - Bradesco + type: directdebit_BR_bradesco + - name: Direct Debit Brazil - Caixa Economica Federal + type: directdebit_BR_caixa + - name: Direct Debit Brazil - HSBC + type: directdebit_BR_hsbc + - name: Direct Debit Brazil - Itau + type: directdebit_BR_itau + - name: Direct Debit Brazil - Santander + type: directdebit_BR_santander + - name: BACS Direct Debit + type: directdebit_GB + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Alfamart + type: doku_alfamart + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BCA Bank Transfer + type: doku_bca_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BNI VA + type: doku_bni_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BRI VA + type: doku_bri_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: CIMB VA + type: doku_cimb_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Danamon VA + type: doku_danamon_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Indomaret + type: doku_indomaret + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Mandiri VA + type: doku_mandiri_va + - details: + - key: ovoId + type: text + name: OVO + type: doku_ovo + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Bank Transfer + type: doku_permata_lite_atm + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: DOKU wallet + type: doku_wallet + - details: + - items: + - id: '66' + name: Bank Nowy BFG S.A. + - id: '92' + name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" + - id: '11' + name: Bank transfer / postal + - id: '74' + name: "Banki Sp\xF3\u0142dzielcze" + - id: '73' + name: BLIK + - id: '90' + name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" + - id: '59' + name: CinkciarzPAY + - id: '87' + name: Credit Agricole PBL + - id: '83' + name: EnveloBank + - id: '76' + name: Getin Bank PBL + - id: '81' + name: Idea Cloud + - id: '7' + name: ING Corporate customers + - id: '93' + name: Kasa Stefczyka + - id: '44' + name: "Millennium - P\u0142atno\u015Bci Internetowe" + - id: '10' + name: Millennium Corporate customers + - id: '68' + name: mRaty + - id: '1' + name: mTransfer + - id: '91' + name: Nest Bank + - id: '80' + name: Noble Pay + - id: '50' + name: Pay Way Toyota Bank + - id: '45' + name: Pay with Alior Bank + - id: '36' + name: Pekao24Przelew + - id: '70' + name: Pocztowy24 + - id: '6' + name: Przelew24 + - id: '46' + name: "P\u0142ac\u0119 z Citi Handlowy" + - id: '38' + name: "P\u0142ac\u0119 z ING" + - id: '2' + name: "P\u0142ac\u0119 z Inteligo" + - id: '4' + name: "P\u0142ac\u0119 z iPKO" + - id: '75' + name: "P\u0142ac\u0119 z Plus Bank" + - id: '51' + name: "P\u0142a\u0107 z BO\u015A" + - id: '55' + name: Raty z Alior Bankiem PLN + - id: '89' + name: Santander + - id: '52' + name: SkyCash + key: issuer + type: select + name: Local Polish Payment Methods + type: dotpay + - name: Dragonpay Prepaid Credits + type: dragonpay_credits + - name: Online Banking + type: dragonpay_ebanking + - name: GCash + type: dragonpay_gcash + - name: Over The Counter Banks + type: dragonpay_otc_banking + - name: OTC non-Bank via Dragonpay + type: dragonpay_otc_non_banking + - name: Convenience Stores + type: dragonpay_otc_philippines + - name: 7/11 + type: dragonpay_seveneleven + - name: eagleeye_voucher + type: eagleeye_voucher + - name: Finnish E-Banking + type: ebanking_FI + - name: Pay-easy ATM + type: econtext_atm + - name: Online Banking + type: econtext_online + - name: 7-Eleven + type: econtext_seven_eleven + - name: Convenience Stores + type: econtext_stores + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Lastschrift (ELV) + type: elv + - details: + - items: + - id: '231' + name: POP Pankki + - id: '551' + name: "Komer\u010Dn\xED banka" + - id: '232' + name: Aktia + - id: '552' + name: Raiffeisen + - id: '233' + name: "S\xE4\xE4st\xF6pankki" + - id: '750' + name: Swedbank + - id: '211' + name: Nordea + - id: '553' + name: "\u010CSOB" + - id: '234' + name: S-Pankki + - id: '751' + name: SEB + - id: '554' + name: Moneta + - id: '235' + name: OmaSP + - id: '752' + name: Nordea + - id: '213' + name: Op-Pohjola + - id: '555' + name: UniCredit + - id: '753' + name: LHV + - id: '556' + name: Fio + - id: '557' + name: mBank + - id: '216' + name: Handelsbanken + - id: '558' + name: Air Bank + - id: '260' + name: "L\xE4nsf\xF6rs\xE4kringar" + - id: '240' + name: BankDeposit + - id: '265' + name: Sparbanken + - id: '640' + name: BankDeposit + - id: '200' + name: "\xC5landsbanken" + - id: '940' + name: Swedbank + - id: '500' + name: "\u010Cesk\xE1 spo\u0159itelna" + - id: '720' + name: Swedbank + - id: '941' + name: SEB + - id: '204' + name: Danske Bank + - id: '721' + name: SEB + - id: '942' + name: Citadele + - id: '205' + name: Handelsbanken + - id: '722' + name: DNB + - id: '943' + name: DNB + - id: '206' + name: Nordea + - id: '723' + name: "\u0160iauli\u0173 bankas" + - id: '207' + name: SEB + - id: '724' + name: Nordea + - id: '505' + name: "Komer\u010Dn\xED banka" + - id: '208' + name: Skandiabanken + - id: '209' + name: Swedbank + key: issuer + type: select + name: Bank Payment + type: entercash + - name: Nationale Entertainment Card + type: entertainmentcard + - details: + - items: + - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 + name: Dolomitenbank + - id: ee9fc487-ebe0-486c-8101-17dce5141a67 + name: Raiffeissen Bankengruppe + - id: 6765e225-a0dc-4481-9666-e26303d4f221 + name: Hypo Tirol Bank AG + - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc + name: Sparda Bank Wien + - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f + name: Schoellerbank AG + - id: e2e97aaa-de4c-4e18-9431-d99790773433 + name: Volksbank Gruppe + - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 + name: Immo-Bank + - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 + name: Bank Austria + - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 + name: Easybank AG + - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a + name: VR-BankBraunau + - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 + name: Volkskreditbank + - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 + name: Erste Bank und Sparkassen + - id: ba7199cc-f057-42f2-9856-2378abf21638 + name: BAWAG P.S.K. Gruppe + key: issuer + type: select + name: EPS + type: eps + - name: Expert Cadeaukaart + type: expertgiftcard + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 3x Oney + type: facilypay_3x + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 4x Oney + type: facilypay_4x + - name: Fashioncheque + type: fashioncheque + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: Fawry + type: fawry + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Fonq Giftcard + type: fonqgiftcard + - name: Gall & Gall + type: gallgall + - name: GCash + type: gcash + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - details: + - key: bic + type: text + name: GiroPay + type: giropay + - name: Givex + type: givex + - name: Globe GCash + type: globegcash + - name: Goldsmiths Card + type: goldsmithscard + - name: GoPay Wallet + type: gopay_wallet + - name: OVO + type: grabpay_ID + - name: GrabPay + type: grabpay_PH + - name: GrabPay + type: grabpay_SG + - name: Hallmark Card + type: hallmarkcard + - name: HDFC + type: hdfc + - name: Hunkemoller Member Card + type: hmclub + - name: Hunkemoller Lingerie Card + type: hmlingerie + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - name: igive + type: igive + - name: Korean Account Transfer (IniPay) + type: inicisIniPay_accounttransfer + - name: Korean Credit Cards (IniPay) + type: inicisIniPay_creditcard + - name: Korean Mobile Phone (IniPay) + type: inicisIniPay_mobilephone + - name: Korean Virtual Account (IniPay) + type: inicisIniPay_virtualaccount + - name: Korean Account Transfer (Mobile) + type: inicisMobile_accounttransfer + - name: Korean Credit Cards (Mobile) + type: inicisMobile_creditcard + - name: Korean Mobile Phone (Mobile) + type: inicisMobile_mobilephone + - name: Korean Virtual Account (Mobile) + type: inicisMobile_virtualaccount + - name: Korean Credit Cards + type: inicis_creditcard + - name: "Interac\xAE Online" + type: interac + - name: Instant EFT + type: ipay + - name: iPay88 + type: ipay88 + - name: isracard + type: isracard + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: KakaoPay + type: kakaopay + - name: Karen Millen Card + type: karenmillen + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Bank Transfer + type: kcp_banktransfer + - name: "Korea\u2013issued cards" + type: kcp_creditcard + - name: PayCo + type: kcp_payco + - name: Virtual Account via KCP + type: kcp_va + - name: Pay later with Klarna. + type: klarna + - name: Pay over time with Klarna. + type: klarna_account + - name: Klarna B2B + type: klarna_b2b + - name: Pay now with Klarna. + type: klarna_paynow + - name: Leisure Card + type: leisurecard + - name: China Credit Card + type: lianlianpay_creditcard + - name: China Debit Card + type: lianlianpay_debitcard + - details: + - key: telephoneNumber + type: tel + name: China Online Banking - Credit Card + type: lianlianpay_ebanking_credit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '4031000' + name: Bank of Beijing + - id: '01040000' + name: Bank of China + - id: '03020000' + name: China Citic Bank + - id: '01050000' + name: China Construction Bank + - id: '03030000' + name: China Everbright Bank + - id: 03080000 + name: China Merchants Bank + - id: '03050000' + name: China Minsheng Banking Group + - id: '03040000' + name: Hua Xia Bank Co + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03070000' + name: PingAn Bank + - id: '1000000' + name: Postal Savings Bank of China + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Debit Card + type: lianlianpay_ebanking_debit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '01050000' + name: China Construction Bank + - id: 03080000 + name: China Merchants Bank + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03100000' + name: Shanghai Pudong Development Bank + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Enterprise + type: lianlianpay_ebanking_enterprise + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - name: Love2Shop GiftCard + type: love2shop + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: mada + type: mada + - name: Mappin & Webb Card + type: mappinwebbcard + - name: MB WAY + type: mbway + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: Mercado Pago + type: mercadopago + - name: MobilePay + type: mobilepay + - name: AliPay via Razer Merchant Services + type: molpay_alipay + - name: 7-Eleven + type: molpay_cash + - name: CIMB Virtual Account + type: molpay_cimb_va + - name: Malaysia E-Banking via Razer Merchant Services + type: molpay_ebanking_MY + - details: + - items: + - id: vtcpay-vietinbank + name: Vietinbank + - id: vtcpay-bidv + name: BIDV + - id: vtcpay-agribank + name: Agribank + - id: vtcpay-mb + name: MB Bank + - id: vtcpay-sacombank + name: Sacombank + - id: vtcpay-dongabank + name: DongABank + - id: vtcpay-maritimebank + name: MaritimeBank + - id: vtcpay-vietcombank + name: Vietcombank + - id: vtcpay-acb + name: ACB + - id: vtcpay-techcombank + name: Techcombank + key: issuer + type: select + name: Vietnam E-Banking + type: molpay_ebanking_VN + - details: + - items: + - id: fpx_bimb + name: Bank Islam + - id: fpx_uob + name: UOB Bank + - id: fpx_cimbclicks + name: CIMB Clicks + - id: fpx_kfh + name: Kuwait Finance House + - id: fpx_rhb + name: RHB Now + - id: fpx_abmb + name: Alliance Bank + - id: fpx_amb + name: Am Online + - id: fpx_hsbc + name: HSBC + - id: fpx_abb + name: Affin Bank + - id: fpx_ocbc + name: OCBC Bank + - id: fpx_pbb + name: Public Bank + - id: fpx_scb + name: Standard Chartered Bank + - id: fpx_bsn + name: Bank Simpanan Nasional + - id: fpx_mb2u + name: Maybank2u + - id: fpx_hlb + name: Hong Leong Connect + - id: fpx_bmmb + name: Bank Muamalat + - id: fpx_bkrm + name: Bank Rakyat + key: issuer + type: select + name: Malaysia E-Banking + type: molpay_ebanking_fpx_MY + - name: eNETS Debit + type: molpay_enetsd + - name: epay + type: molpay_epay + - name: Esapay + type: molpay_esapay + - name: MyClear FPX + type: molpay_fpx + - name: Maybank2u + type: molpay_maybank2u + - name: Nganluong + type: molpay_nganluong + - name: Tesco Lotus + type: molpay_paysbuy + - name: MOLPoints + type: molpay_points + - name: RHB Now + type: molpay_rhb + - name: SAM by SingPost + type: molpay_singpost + - name: MOLWallet + type: molpay_wallet + - name: MoMo ATM + type: momo_atm + - name: Momo Wallet + type: momo_wallet + - name: Moneybookers + type: moneybookers + - name: Multibanco + type: multibanco + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: BankAxess + type: netaxept_bankaxess + - name: NETELLER + type: neteller + - name: Onebip + type: onebip + - name: One Two Three + type: onetwothree + - name: Local Polish Payment Methods + type: onlineBanking_PL + - details: + - items: + - id: '1' + name: Model Bank v2 + key: issuer + type: select + name: Online banking + type: openbanking_UK + - name: Oxxo + type: oxxo + - name: Pathe Giftcard + type: pathegiftcard + - name: PayBright + type: paybright + - name: PayMaya Wallet + type: paymaya_wallet + - name: PayPal + type: paypal + - name: Paysafecard + type: paysafecard + - name: Payshop + type: payshop + - name: PayD AMT via Paythru + type: paythru_amt + - name: EFT via Paythru + type: paythru_eft + - name: PayTM + type: paytm + - details: + - key: virtualPaymentAddress + type: text + name: PayU UPI + type: payu_IN_upi + - name: EFT Pro via PayU + type: payu_ZA_eftpro + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: pix + type: pix + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Podium Card + type: podiumcard + - name: POLi + type: poli + - name: PPS + type: pps + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Illicado Gift Card + type: prosodie_illicado + - name: PSE + type: pse + - details: + - items: + - id: '+7' + name: RU + - id: '+9955' + name: GE + - id: '+507' + name: PA + - id: '+44' + name: GB + - id: '+992' + name: TJ + - id: '+370' + name: LT + - id: '+972' + name: IL + - id: '+996' + name: KG + - id: '+380' + name: UA + - id: '+84' + name: VN + - id: '+90' + name: TR + - id: '+994' + name: AZ + - id: '+374' + name: AM + - id: '+371' + name: LV + - id: '+91' + name: IN + - id: '+66' + name: TH + - id: '+373' + name: MD + - id: '+1' + name: US + - id: '+81' + name: JP + - id: '+998' + name: UZ + - id: '+77' + name: KZ + - id: '+375' + name: BY + - id: '+372' + name: EE + - id: '+40' + name: RO + - id: '+82' + name: KR + key: qiwiwallet.telephoneNumberPrefix + type: select + - key: qiwiwallet.telephoneNumber + type: text + name: Qiwi Wallet + type: qiwiwallet + - name: RatePay Invoice + type: ratepay + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: SafetyPay + type: safetypay + - name: SafetyPay Cash + type: safetypay_cash + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: SEB Direktbetalning + type: sebdirectpayment + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: 7-Eleven + type: seveneleven + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: Swish + type: swish + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: TenPay + type: tenpay + - name: The Sting Giftcard + type: thestinggiftcard + - name: Trustly + type: trustly + - name: Online Banking by Trustpay + type: trustpay + - name: TWINT + type: twint + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - details: + - key: virtualPaymentAddress + type: text + name: UPI Collect + type: upi_collect + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: telephoneNumber + optional: true + type: tel + name: Vipps + type: vipps + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: VVV Giftcard + type: vvvgiftcard + - name: Webshop Giftcard + type: webshopgiftcard + - name: WeChat Pay + type: wechatpayMiniProgram + - name: WeChat Pay + type: wechatpayQR + - name: WeChat Pay + type: wechatpayWeb + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: WOS Card + type: woscard + - name: Alfa-Click + type: yandex_alfaclick + - name: Pay using bank card + type: yandex_bank_card + - name: Cash terminals + type: yandex_cash + - name: Pay using installments + type: yandex_installments + - name: YooMoney + type: yandex_money + - name: Promsvyazbank + type: yandex_promsvyazbank + - name: Sberbank Online + type: yandex_sberbank + - name: WebMoney + type: yandex_webmoney + - name: Your Gift + type: yourgift + - name: Zip + type: zip post-paymentMethods-filtered: summary: Get payment methods based on the country and amount value: @@ -8749,6 +10305,313 @@ components: amount: currency: EUR value: 1000 + post-paymentMethods-filtered-200: + summary: Example response for request 'filtered' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentMethods-include-oneclick: summary: Get payment methods including stored card details value: @@ -8758,6 +10621,313 @@ components: currency: EUR value: 1000 shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-paymentMethods-include-oneclick-200: + summary: Example response for request 'include-oneclick' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -8791,6 +10961,10 @@ components: shopperLocale: nl_NL merchantAccount: YOUR_MERCHANT_ACCOUNT sdkVersion: 1.7.0 + post-paymentSession-enableOneClick-200: + summary: Example response for request 'enableOneClick' + value: + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-paymentSession-ios: summary: Set up a payment session (iOS) value: @@ -8806,62 +10980,10 @@ components: shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-split: - summary: Split a payment between a sub-merchant and a platform account + post-paymentSession-web-200: + summary: Example response for request 'web' value: - amount: - currency: EUR - value: 6200 - additionalData: - split.api: '1' - split.nrOfItems: '2' - split.totalAmount: '6200' - split.currencyCode: EUR - split.item1.amount: '6000' - split.item1.type: MarketPlace - split.item1.account: '151272963' - split.item1.reference: '6124145' - split.item1.description: 'Porcelain Doll: Eliza (20cm)' - split.item2.amount: '200' - split.item2.type: Commission - split.item2.reference: '6124146' - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Android - token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK - returnUrl: app:// - countryCode: NL - shopperLocale: nl_NL - sessionValidity: '2017-04-06T13:09:13Z' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-payments-applepay: - summary: Make an Apple Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: applepay - applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -8923,131 +11045,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields: - summary: Make a payment with 3D Secure 2 native authentication - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4212345678901237 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - holderName: John Smith - browserInfo: - userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 - Firefox/3.0 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct: - summary: Make a card payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw: - summary: Tokenize card details for one-off payments - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - storePaymentMethod: true - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay: - summary: Make a giropay payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: giropay - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-googlepay: - summary: Make a Google Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: paywithgoogle - googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... - merchantAccount: YourMerchantAccount - post-payments-ideal: - summary: Make an iDEAL payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: ideal - issuer: '1121' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-klarna: summary: Make a Klarna payment value: @@ -9113,95 +11110,7 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-oneclick-securedfields: - summary: Make a one-off payment with a token and CVV (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - storedPaymentMethodId: '8416038790273850' - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: CardOnFile - post-payments-recurring: - summary: Make a card payment with a token - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - storedPaymentMethodId: '8316038796685850' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: Subscription post-payments-result-basic: summary: Verify payment results value: payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK - post-payments-sofort: - summary: Make a Sofort payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: directEbanking - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-split: - summary: Split a payment between a sub-merchant and a platform account - value: - paymentMethod: - type: scheme - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' - post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT diff --git a/yaml/CheckoutService-v66.yaml b/yaml/CheckoutService-v66.yaml index 31009b8..5b6f5f5 100644 --- a/yaml/CheckoutService-v66.yaml +++ b/yaml/CheckoutService-v66.yaml @@ -81,13 +81,21 @@ paths: $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-basic-200' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -124,6 +132,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -150,13 +161,21 @@ paths: $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-cancel-basic-200' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -193,6 +212,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -223,13 +245,21 @@ paths: $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-originKeys-basic-200' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -266,6 +296,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -295,19 +328,30 @@ paths: $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/CreatePaymentLinkRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentLinks-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '201': content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResource' description: Created - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -344,6 +388,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -367,13 +414,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -410,6 +464,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -441,13 +498,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -484,6 +548,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -521,13 +588,25 @@ paths: $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentMethods-basic-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + filtered-200: + $ref: '#/components/examples/post-paymentMethods-filtered-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -564,6 +643,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -592,13 +674,21 @@ paths: $ref: '#/components/examples/post-paymentMethods-balance-basic' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + plastix-200: + $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -629,12 +719,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -661,10 +751,6 @@ paths: content: application/json: examples: - split: - $ref: '#/components/examples/post-paymentSession-split' - web: - $ref: '#/components/examples/post-paymentSession-web' android: $ref: '#/components/examples/post-paymentSession-android' ios: @@ -673,19 +759,26 @@ paths: $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick-200: + $ref: '#/components/examples/post-paymentSession-enableOneClick-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -701,9 +794,6 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -716,12 +806,12 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -743,44 +833,18 @@ paths: content: application/json: examples: - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' - giropay: - $ref: '#/components/examples/post-payments-giropay' - card-3d-secure-securedfields: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' - enableOneClick-raw: - $ref: '#/components/examples/post-payments-enableOneClick-raw' - applepay: - $ref: '#/components/examples/post-payments-applepay' - ideal: - $ref: '#/components/examples/post-payments-ideal' - oneclick-securedfields: - $ref: '#/components/examples/post-payments-oneclick-securedfields' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' - recurring: - $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' - sofort: - $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' card-3d-secure-direct: $ref: '#/components/examples/post-payments-card-3d-secure-direct' klarna: $ref: '#/components/examples/post-payments-klarna' - split: - $ref: '#/components/examples/post-payments-split' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' schema: $ref: '#/components/schemas/PaymentRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -788,48 +852,39 @@ paths: schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -851,6 +906,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DetailsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -858,6 +915,9 @@ paths: schema: $ref: '#/components/schemas/PaymentDetailsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -885,6 +945,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -910,6 +973,8 @@ paths: $ref: '#/components/examples/post-payments-result-basic' schema: $ref: '#/components/schemas/PaymentVerificationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -917,6 +982,9 @@ paths: schema: $ref: '#/components/schemas/PaymentVerificationResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -947,12 +1015,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -3081,19 +3149,19 @@ components: type: string encryptedCardNumber: description: The encrypted card number. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryMonth: description: The encrypted card expiry month. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryYear: description: The encrypted card expiry year. - maxLength: 7000 + maxLength: 10000 type: string encryptedSecurityCode: description: The encrypted card verification code. - maxLength: 7000 + maxLength: 10000 type: string expiryMonth: description: The card expiry month. Only collect raw card data if you are @@ -3347,8 +3415,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -3572,50 +3646,16 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Success** \u2013 Indicates that the balance check was successful.\n\ + * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\ + \ have enough balance to pay the amount in the request, or that the currency\ + \ of the balance on the card did not match the currency of the requested\ + \ amount.\n* **Failed** \u2013 Indicates that the balance check failed." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success + - NotEnoughBalance + - Failed type: string transactionLimit: x-addedInVersion: 65 @@ -3624,6 +3664,7 @@ components: $ref: '#/components/schemas/Amount' required: - balance + - resultCode CheckoutBankTransferAction: additionalProperties: false properties: @@ -3680,7 +3721,11 @@ components: description: A unique reference of the cancellation request. type: string resultCode: - description: The result of the cancellation request. + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Received** \u2013 Indicates the cancellation has successfully been\ + \ received by Adyen, and will be processed." + enum: + - Received type: string required: - pspReference @@ -3756,55 +3801,16 @@ components: description: The remaining amount in the order. $ref: '#/components/schemas/Amount' resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the order creation request.\n The value is always\ + \ **Success**." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success type: string required: - remainingAmount - expiresAt - orderData + - resultCode CheckoutDonationAction: additionalProperties: false properties: @@ -5378,8 +5384,10 @@ components: properties: action: x-addedInVersion: 49 - description: Action to be taken for completing the payment. - $ref: '#/components/schemas/CheckoutThreeDS2ChallengeAction' + description: Action to be taken for completing the payment. When returned, + only the 3D Secure action is needed in most cases. + oneOf: + - $ref: '#/components/schemas/CheckoutRedirectAction' additionalData: additionalProperties: type: string @@ -6098,8 +6106,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -6753,8 +6767,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -8087,11 +8107,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -8636,6 +8656,21 @@ components: BasicAuth: scheme: basic type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string examples: generic-400: summary: Response code 400. Bad request. @@ -8675,10 +8710,38 @@ components: message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' + get-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A patch-paymentLinks-linkId-basic: summary: Update the status of a payment link value: status: expired + patch-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: expired + url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -8687,6 +8750,17 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178914061985' + resultCode: Success + expiresAt: '2021-04-09T14:16:46Z' + orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== + reference: shopper-reference-ekvL83 + remainingAmount: + currency: EUR + value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -8694,6 +8768,11 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8816178914079738' + resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -8701,6 +8780,13 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com + post-originKeys-basic-200: + summary: Example response for request 'basic' + value: + originKeys: + https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw + https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc + https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -8727,6 +8813,15 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP + post-paymentLinks-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 1250 + expiresAt: '2021-04-09T14:17:31Z' + reference: shopper-reference-ekvL83 + url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -8744,10 +8839,1471 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix-200: + summary: Example response for request 'plastix' + value: + additionalData: + nonScheme.transactionLimit: '5000' + nonScheme.transactionLimitCcy: EUR + pspReference: 851617891188737F + resultCode: Success + balance: + currency: EUR + value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic-200: + summary: Example response for request 'basic' + value: + paymentMethods: + - details: + - details: + - key: ownerName + type: text + - key: bankLocationId + type: text + - key: bankAccountNumber + type: text + key: bankAccount + type: bankAccount + name: ACH Direct Debit + type: ach + - name: Adyen Voucher + type: adyen_test_voucher + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: Afterpay + type: afterpaytouch + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: AliPay + type: alipay + - name: AliPay HK + type: alipay_hk + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Credit Card via AsiaPay + type: asiapay + - name: China UnionPay + type: asiapay_unionpay + - name: Baby Gift Card + type: babygiftcard + - name: Baloto + type: baloto + - name: BancNet + type: bancnet + - name: Bank Transfer (BG) + type: bankTransfer_BG + - name: Bank Transfer (CH) + type: bankTransfer_CH + - name: Bank Transfer (DE) + type: bankTransfer_DE + - name: Bank Transfer (FI) + type: bankTransfer_FI + - name: Bank Transfer (GB) + type: bankTransfer_GB + - name: Bank Transfer (HU) + type: bankTransfer_HU + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bank Transfer (IE) + type: bankTransfer_IE + - name: Electronic Bank Transfer (MX) + type: bankTransfer_MX_linked + - name: Bank Transfer (MX) + type: bankTransfer_MX_offline + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Bank Transfer (PL) + type: bankTransfer_PL + - name: Bank Transfer (SE) + type: bankTransfer_SE + - name: Bank Transfer (US) + type: bankTransfer_US + - name: Payconiq by Bancontact + type: bcmc_mobile + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: 99Bill + type: bill99 + - details: + - items: + - id: AUB_DIRECT + name: AU Small Finance Bank + - id: ALB_DIRECT + name: 'Allahabad Bank ' + - id: APG_DIRECT + name: Andhra Pragathi Grameena Bank + - id: BDN_DIRECT + name: Bandhan bank + - id: BBK_DIRECT + name: Bank of Bahrain and Kuwait + - id: BBR_DIRECT + name: Bank of Baroda - Retail Banking + - id: BCB_DIRECT + name: 'Bassien Catholic Co-Operative Bank ' + - id: CNB_DIRECT + name: Canara Bank + - id: SYD_DIRECT + name: Canara Bank (e-Syndicate) + - id: CSB_DIRECT + name: Catholic Syrian Bank + - id: CBI_DIRECT + name: Central Bank of India + - id: CUB_DIRECT + name: City Union Bank + - id: COB_DIRECT + name: Cosmos Bank + - id: DEN_DIRECT + name: Dena Bank + - id: DBK_DIRECT + name: Deutsche Bank + - id: DCB_DIRECT + name: Development Credit Bank + - id: DLB_DIRECT + name: Dhanlakshmi Bank - Retail Net Banking + - id: ESF_DIRECT + name: ESAF Small Finance Bank + - id: EQB_DIRECT + name: Equitas Small Finance Bank + - id: FBK_DIRECT + name: Federal Bank + - id: FNC_DIRECT + name: Fincare Bank + - id: HDF_DIRECT + name: HDFC Bank + - id: ICI_DIRECT + name: 'ICICI Bank ' + - id: IDB_DIRECT + name: IDBI Bank - Retail Net Banking + - id: IDN_DIRECT + name: IDFC FIRST Bank + - id: INB_DIRECT + name: Indian Bank + - id: IOB_DIRECT + name: Indian Overseas Bank + - id: IDS_DIRECT + name: IndusInd Bank + - id: JKB_DIRECT + name: Jammu & Kashmir Bank + - id: JNB_DIRECT + name: Jana Small Finance Bank + - id: JSB_DIRECT + name: Janata Sahakari Bank Ltd Pune + - id: KJB_DIRECT + name: Kalyan Janata Sahakari Bank + - id: KBL_DIRECT + name: Karnataka Bank Ltd + - id: KVB_DIRECT + name: Karur Vysya Bank + - id: 162_DIRECT + name: Kotak Bank + - id: LVR_DIRECT + name: Laxmi Vilas Bank - Retail + - id: NKB_DIRECT + name: NKGSB Co-op Bank + - id: NEB_DIRECT + name: North East Small Finance Bank + - id: OBC_DIRECT + name: PNB (Erstwhile-Oriental Bank of Commerce) + - id: UNI_DIRECT + name: PNB (Erstwhile-United Bank of India) + - id: PMC_DIRECT + name: Punjab & Maharastra Co-op Bank + - id: PSB_DIRECT + name: Punjab & Sind Bank + - id: CPN_DIRECT + name: 'Punjab National Bank - Corporate ' + - id: PNB_DIRECT + name: Punjab National Bank - Retail Banking + - id: RBL_DIRECT + name: RBL Bank Limited + - id: SWB_DIRECT + name: Saraswat Bank + - id: SHB_DIRECT + name: Shivalik Mercantile Cooperative Bank Ltd + - id: SIB_DIRECT + name: South Indian Bank + - id: SCB_DIRECT + name: Standard Chartered Bank + - id: SBI_DIRECT + name: State Bank of India + - id: SRB_DIRECT + name: Suryoday Small Finance Bank + - id: TJB_DIRECT + name: TJSB Bank + - id: TNC_DIRECT + name: Tamil Nadu State Co-operative Bank + - id: TMB_DIRECT + name: Tamilnad Mercantile Bank Ltd + - id: TBB_DIRECT + name: Thane Bharat Sahakari Bank Ltd + - id: MSB_DIRECT + name: The Mehsana Urban Co Op Bank Ltd + - id: UCO_DIRECT + name: UCO Bank + - id: UBI_DIRECT + name: Union Bank of India + - id: ADB_DIRECT + name: Union Bank of India (Erstwhile Andhra Bank) + - id: CRP_DIRECT + name: Union Bank of India (Erstwhile Corporation Bank) + - id: VRB_DIRECT + name: Varachha Co-operative Bank Limited + - id: VJB_DIRECT + name: Vijaya Bank + - id: YBK_DIRECT + name: Yes Bank + - id: ZOB_DIRECT + name: Zoroastrian Co-operative Bank Limited + - id: DBS_DIRECT + name: digibank by DBS + key: issuer + type: select + name: Online Banking India + type: billdesk_online + - name: UPI + type: billdesk_upi + - details: + - items: + - id: DCW_DIRECT + name: DCB Cippy + - id: ICC_DIRECT + name: ICC Cash Card + - id: OXY_DIRECT + name: Oxigen Wallet + - id: PCH_DIRECT + name: Pay World Money + key: issuer + type: select + name: Wallets India + type: billdesk_wallet + - name: Blik + type: blik + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Boleto + type: boleto + - name: Boleto Bancario + type: boletobancario_santander + - name: Bradesco + type: bradesco + - name: Cash-Ticket + type: cashticket + - name: CashU + type: cashu + - name: CCAvenue + type: ccavenue + - name: Mula Checkout + type: cellulant + - name: Chasin Giftcard + type: chasingiftcard + - name: Clearpay + type: clearpay + - name: ClickandBuy + type: clickandbuy + - name: Paiement en 3 fois par Cartes Bancaires + type: cofinoga_3xcb + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: DANA + type: dana + - name: DineroMail + type: dineromail + - name: Online bank transfer. + type: directEbanking + - name: Direct Debit Brazil - Banco do Brazil + type: directdebit_BR_bancodobrasil + - name: Direct Debit Brazil - Bradesco + type: directdebit_BR_bradesco + - name: Direct Debit Brazil - Caixa Economica Federal + type: directdebit_BR_caixa + - name: Direct Debit Brazil - HSBC + type: directdebit_BR_hsbc + - name: Direct Debit Brazil - Itau + type: directdebit_BR_itau + - name: Direct Debit Brazil - Santander + type: directdebit_BR_santander + - name: BACS Direct Debit + type: directdebit_GB + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Alfamart + type: doku_alfamart + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BCA Bank Transfer + type: doku_bca_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BNI VA + type: doku_bni_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BRI VA + type: doku_bri_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: CIMB VA + type: doku_cimb_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Danamon VA + type: doku_danamon_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Indomaret + type: doku_indomaret + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Mandiri VA + type: doku_mandiri_va + - details: + - key: ovoId + type: text + name: OVO + type: doku_ovo + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Bank Transfer + type: doku_permata_lite_atm + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: DOKU wallet + type: doku_wallet + - details: + - items: + - id: '66' + name: Bank Nowy BFG S.A. + - id: '92' + name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" + - id: '11' + name: Bank transfer / postal + - id: '74' + name: "Banki Sp\xF3\u0142dzielcze" + - id: '73' + name: BLIK + - id: '90' + name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" + - id: '59' + name: CinkciarzPAY + - id: '87' + name: Credit Agricole PBL + - id: '83' + name: EnveloBank + - id: '76' + name: Getin Bank PBL + - id: '81' + name: Idea Cloud + - id: '7' + name: ING Corporate customers + - id: '93' + name: Kasa Stefczyka + - id: '44' + name: "Millennium - P\u0142atno\u015Bci Internetowe" + - id: '10' + name: Millennium Corporate customers + - id: '68' + name: mRaty + - id: '1' + name: mTransfer + - id: '91' + name: Nest Bank + - id: '80' + name: Noble Pay + - id: '50' + name: Pay Way Toyota Bank + - id: '45' + name: Pay with Alior Bank + - id: '36' + name: Pekao24Przelew + - id: '70' + name: Pocztowy24 + - id: '6' + name: Przelew24 + - id: '46' + name: "P\u0142ac\u0119 z Citi Handlowy" + - id: '38' + name: "P\u0142ac\u0119 z ING" + - id: '2' + name: "P\u0142ac\u0119 z Inteligo" + - id: '4' + name: "P\u0142ac\u0119 z iPKO" + - id: '75' + name: "P\u0142ac\u0119 z Plus Bank" + - id: '51' + name: "P\u0142a\u0107 z BO\u015A" + - id: '55' + name: Raty z Alior Bankiem PLN + - id: '89' + name: Santander + - id: '52' + name: SkyCash + key: issuer + type: select + name: Local Polish Payment Methods + type: dotpay + - name: Dragonpay Prepaid Credits + type: dragonpay_credits + - name: Online Banking + type: dragonpay_ebanking + - name: GCash + type: dragonpay_gcash + - name: Over The Counter Banks + type: dragonpay_otc_banking + - name: OTC non-Bank via Dragonpay + type: dragonpay_otc_non_banking + - name: Convenience Stores + type: dragonpay_otc_philippines + - name: 7/11 + type: dragonpay_seveneleven + - name: eagleeye_voucher + type: eagleeye_voucher + - name: Finnish E-Banking + type: ebanking_FI + - name: Pay-easy ATM + type: econtext_atm + - name: Online Banking + type: econtext_online + - name: 7-Eleven + type: econtext_seven_eleven + - name: Convenience Stores + type: econtext_stores + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Lastschrift (ELV) + type: elv + - details: + - items: + - id: '231' + name: POP Pankki + - id: '551' + name: "Komer\u010Dn\xED banka" + - id: '232' + name: Aktia + - id: '552' + name: Raiffeisen + - id: '233' + name: "S\xE4\xE4st\xF6pankki" + - id: '750' + name: Swedbank + - id: '211' + name: Nordea + - id: '553' + name: "\u010CSOB" + - id: '234' + name: S-Pankki + - id: '751' + name: SEB + - id: '554' + name: Moneta + - id: '235' + name: OmaSP + - id: '752' + name: Nordea + - id: '213' + name: Op-Pohjola + - id: '555' + name: UniCredit + - id: '753' + name: LHV + - id: '556' + name: Fio + - id: '557' + name: mBank + - id: '216' + name: Handelsbanken + - id: '558' + name: Air Bank + - id: '260' + name: "L\xE4nsf\xF6rs\xE4kringar" + - id: '240' + name: BankDeposit + - id: '265' + name: Sparbanken + - id: '640' + name: BankDeposit + - id: '200' + name: "\xC5landsbanken" + - id: '940' + name: Swedbank + - id: '500' + name: "\u010Cesk\xE1 spo\u0159itelna" + - id: '720' + name: Swedbank + - id: '941' + name: SEB + - id: '204' + name: Danske Bank + - id: '721' + name: SEB + - id: '942' + name: Citadele + - id: '205' + name: Handelsbanken + - id: '722' + name: DNB + - id: '943' + name: DNB + - id: '206' + name: Nordea + - id: '723' + name: "\u0160iauli\u0173 bankas" + - id: '207' + name: SEB + - id: '724' + name: Nordea + - id: '505' + name: "Komer\u010Dn\xED banka" + - id: '208' + name: Skandiabanken + - id: '209' + name: Swedbank + key: issuer + type: select + name: Bank Payment + type: entercash + - name: Nationale Entertainment Card + type: entertainmentcard + - details: + - items: + - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 + name: Dolomitenbank + - id: ee9fc487-ebe0-486c-8101-17dce5141a67 + name: Raiffeissen Bankengruppe + - id: 6765e225-a0dc-4481-9666-e26303d4f221 + name: Hypo Tirol Bank AG + - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc + name: Sparda Bank Wien + - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f + name: Schoellerbank AG + - id: e2e97aaa-de4c-4e18-9431-d99790773433 + name: Volksbank Gruppe + - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 + name: Immo-Bank + - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 + name: Bank Austria + - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 + name: Easybank AG + - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a + name: VR-BankBraunau + - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 + name: Volkskreditbank + - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 + name: Erste Bank und Sparkassen + - id: ba7199cc-f057-42f2-9856-2378abf21638 + name: BAWAG P.S.K. Gruppe + key: issuer + type: select + name: EPS + type: eps + - name: Expert Cadeaukaart + type: expertgiftcard + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 3x Oney + type: facilypay_3x + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 4x Oney + type: facilypay_4x + - name: Fashioncheque + type: fashioncheque + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: Fawry + type: fawry + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Fonq Giftcard + type: fonqgiftcard + - name: Gall & Gall + type: gallgall + - name: GCash + type: gcash + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - details: + - key: bic + type: text + name: GiroPay + type: giropay + - name: Givex + type: givex + - name: Globe GCash + type: globegcash + - name: Goldsmiths Card + type: goldsmithscard + - name: GoPay Wallet + type: gopay_wallet + - name: OVO + type: grabpay_ID + - name: GrabPay + type: grabpay_PH + - name: GrabPay + type: grabpay_SG + - name: Hallmark Card + type: hallmarkcard + - name: HDFC + type: hdfc + - name: Hunkemoller Member Card + type: hmclub + - name: Hunkemoller Lingerie Card + type: hmlingerie + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - name: igive + type: igive + - name: Korean Account Transfer (IniPay) + type: inicisIniPay_accounttransfer + - name: Korean Credit Cards (IniPay) + type: inicisIniPay_creditcard + - name: Korean Mobile Phone (IniPay) + type: inicisIniPay_mobilephone + - name: Korean Virtual Account (IniPay) + type: inicisIniPay_virtualaccount + - name: Korean Account Transfer (Mobile) + type: inicisMobile_accounttransfer + - name: Korean Credit Cards (Mobile) + type: inicisMobile_creditcard + - name: Korean Mobile Phone (Mobile) + type: inicisMobile_mobilephone + - name: Korean Virtual Account (Mobile) + type: inicisMobile_virtualaccount + - name: Korean Credit Cards + type: inicis_creditcard + - name: "Interac\xAE Online" + type: interac + - name: Instant EFT + type: ipay + - name: iPay88 + type: ipay88 + - name: isracard + type: isracard + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: KakaoPay + type: kakaopay + - name: Karen Millen Card + type: karenmillen + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Bank Transfer + type: kcp_banktransfer + - name: "Korea\u2013issued cards" + type: kcp_creditcard + - name: PayCo + type: kcp_payco + - name: Virtual Account via KCP + type: kcp_va + - name: Pay later with Klarna. + type: klarna + - name: Pay over time with Klarna. + type: klarna_account + - name: Klarna B2B + type: klarna_b2b + - name: Pay now with Klarna. + type: klarna_paynow + - name: Leisure Card + type: leisurecard + - name: China Credit Card + type: lianlianpay_creditcard + - name: China Debit Card + type: lianlianpay_debitcard + - details: + - key: telephoneNumber + type: tel + name: China Online Banking - Credit Card + type: lianlianpay_ebanking_credit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '4031000' + name: Bank of Beijing + - id: '01040000' + name: Bank of China + - id: '03020000' + name: China Citic Bank + - id: '01050000' + name: China Construction Bank + - id: '03030000' + name: China Everbright Bank + - id: 03080000 + name: China Merchants Bank + - id: '03050000' + name: China Minsheng Banking Group + - id: '03040000' + name: Hua Xia Bank Co + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03070000' + name: PingAn Bank + - id: '1000000' + name: Postal Savings Bank of China + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Debit Card + type: lianlianpay_ebanking_debit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '01050000' + name: China Construction Bank + - id: 03080000 + name: China Merchants Bank + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03100000' + name: Shanghai Pudong Development Bank + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Enterprise + type: lianlianpay_ebanking_enterprise + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - name: Love2Shop GiftCard + type: love2shop + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: mada + type: mada + - name: Mappin & Webb Card + type: mappinwebbcard + - name: MB WAY + type: mbway + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: Mercado Pago + type: mercadopago + - name: MobilePay + type: mobilepay + - name: AliPay via Razer Merchant Services + type: molpay_alipay + - name: 7-Eleven + type: molpay_cash + - name: CIMB Virtual Account + type: molpay_cimb_va + - name: Malaysia E-Banking via Razer Merchant Services + type: molpay_ebanking_MY + - details: + - items: + - id: vtcpay-vietinbank + name: Vietinbank + - id: vtcpay-bidv + name: BIDV + - id: vtcpay-agribank + name: Agribank + - id: vtcpay-mb + name: MB Bank + - id: vtcpay-sacombank + name: Sacombank + - id: vtcpay-dongabank + name: DongABank + - id: vtcpay-maritimebank + name: MaritimeBank + - id: vtcpay-vietcombank + name: Vietcombank + - id: vtcpay-acb + name: ACB + - id: vtcpay-techcombank + name: Techcombank + key: issuer + type: select + name: Vietnam E-Banking + type: molpay_ebanking_VN + - details: + - items: + - id: fpx_bimb + name: Bank Islam + - id: fpx_uob + name: UOB Bank + - id: fpx_cimbclicks + name: CIMB Clicks + - id: fpx_kfh + name: Kuwait Finance House + - id: fpx_rhb + name: RHB Now + - id: fpx_abmb + name: Alliance Bank + - id: fpx_amb + name: Am Online + - id: fpx_hsbc + name: HSBC + - id: fpx_abb + name: Affin Bank + - id: fpx_ocbc + name: OCBC Bank + - id: fpx_pbb + name: Public Bank + - id: fpx_scb + name: Standard Chartered Bank + - id: fpx_bsn + name: Bank Simpanan Nasional + - id: fpx_mb2u + name: Maybank2u + - id: fpx_hlb + name: Hong Leong Connect + - id: fpx_bmmb + name: Bank Muamalat + - id: fpx_bkrm + name: Bank Rakyat + key: issuer + type: select + name: Malaysia E-Banking + type: molpay_ebanking_fpx_MY + - name: eNETS Debit + type: molpay_enetsd + - name: epay + type: molpay_epay + - name: Esapay + type: molpay_esapay + - name: MyClear FPX + type: molpay_fpx + - name: Maybank2u + type: molpay_maybank2u + - name: Nganluong + type: molpay_nganluong + - name: Tesco Lotus + type: molpay_paysbuy + - name: MOLPoints + type: molpay_points + - name: RHB Now + type: molpay_rhb + - name: SAM by SingPost + type: molpay_singpost + - name: MOLWallet + type: molpay_wallet + - name: MoMo ATM + type: momo_atm + - name: Momo Wallet + type: momo_wallet + - name: Moneybookers + type: moneybookers + - name: Multibanco + type: multibanco + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: BankAxess + type: netaxept_bankaxess + - name: NETELLER + type: neteller + - name: Onebip + type: onebip + - name: One Two Three + type: onetwothree + - name: Local Polish Payment Methods + type: onlineBanking_PL + - details: + - items: + - id: '1' + name: Model Bank v2 + key: issuer + type: select + name: Online banking + type: openbanking_UK + - name: Oxxo + type: oxxo + - name: Pathe Giftcard + type: pathegiftcard + - name: PayBright + type: paybright + - name: PayMaya Wallet + type: paymaya_wallet + - name: PayPal + type: paypal + - name: Paysafecard + type: paysafecard + - name: Payshop + type: payshop + - name: PayD AMT via Paythru + type: paythru_amt + - name: EFT via Paythru + type: paythru_eft + - name: PayTM + type: paytm + - details: + - key: virtualPaymentAddress + type: text + name: PayU UPI + type: payu_IN_upi + - name: EFT Pro via PayU + type: payu_ZA_eftpro + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: pix + type: pix + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Podium Card + type: podiumcard + - name: POLi + type: poli + - name: PPS + type: pps + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Illicado Gift Card + type: prosodie_illicado + - name: PSE + type: pse + - details: + - items: + - id: '+7' + name: RU + - id: '+9955' + name: GE + - id: '+507' + name: PA + - id: '+44' + name: GB + - id: '+992' + name: TJ + - id: '+370' + name: LT + - id: '+972' + name: IL + - id: '+996' + name: KG + - id: '+380' + name: UA + - id: '+84' + name: VN + - id: '+90' + name: TR + - id: '+994' + name: AZ + - id: '+374' + name: AM + - id: '+371' + name: LV + - id: '+91' + name: IN + - id: '+66' + name: TH + - id: '+373' + name: MD + - id: '+1' + name: US + - id: '+81' + name: JP + - id: '+998' + name: UZ + - id: '+77' + name: KZ + - id: '+375' + name: BY + - id: '+372' + name: EE + - id: '+40' + name: RO + - id: '+82' + name: KR + key: qiwiwallet.telephoneNumberPrefix + type: select + - key: qiwiwallet.telephoneNumber + type: text + name: Qiwi Wallet + type: qiwiwallet + - name: RatePay Invoice + type: ratepay + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: SafetyPay + type: safetypay + - name: SafetyPay Cash + type: safetypay_cash + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: SEB Direktbetalning + type: sebdirectpayment + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: 7-Eleven + type: seveneleven + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: Swish + type: swish + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: TenPay + type: tenpay + - name: The Sting Giftcard + type: thestinggiftcard + - name: Trustly + type: trustly + - name: Online Banking by Trustpay + type: trustpay + - name: TWINT + type: twint + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - details: + - key: virtualPaymentAddress + type: text + name: UPI Collect + type: upi_collect + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: telephoneNumber + optional: true + type: tel + name: Vipps + type: vipps + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: VVV Giftcard + type: vvvgiftcard + - name: Webshop Giftcard + type: webshopgiftcard + - name: WeChat Pay + type: wechatpayMiniProgram + - name: WeChat Pay + type: wechatpayQR + - name: WeChat Pay + type: wechatpayWeb + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: WOS Card + type: woscard + - name: Alfa-Click + type: yandex_alfaclick + - name: Pay using bank card + type: yandex_bank_card + - name: Cash terminals + type: yandex_cash + - name: Pay using installments + type: yandex_installments + - name: YooMoney + type: yandex_money + - name: Promsvyazbank + type: yandex_promsvyazbank + - name: Sberbank Online + type: yandex_sberbank + - name: WebMoney + type: yandex_webmoney + - name: Your Gift + type: yourgift + - name: Zip + type: zip post-paymentMethods-filtered: summary: Get payment methods based on the country and amount value: @@ -8757,6 +10313,313 @@ components: amount: currency: EUR value: 1000 + post-paymentMethods-filtered-200: + summary: Example response for request 'filtered' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentMethods-include-oneclick: summary: Get payment methods including stored card details value: @@ -8766,6 +10629,313 @@ components: currency: EUR value: 1000 shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-paymentMethods-include-oneclick-200: + summary: Example response for request 'include-oneclick' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -8799,6 +10969,10 @@ components: shopperLocale: nl_NL merchantAccount: YOUR_MERCHANT_ACCOUNT sdkVersion: 1.7.0 + post-paymentSession-enableOneClick-200: + summary: Example response for request 'enableOneClick' + value: + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-paymentSession-ios: summary: Set up a payment session (iOS) value: @@ -8814,62 +10988,10 @@ components: shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-split: - summary: Split a payment between a sub-merchant and a platform account + post-paymentSession-web-200: + summary: Example response for request 'web' value: - amount: - currency: EUR - value: 6200 - additionalData: - split.api: '1' - split.nrOfItems: '2' - split.totalAmount: '6200' - split.currencyCode: EUR - split.item1.amount: '6000' - split.item1.type: MarketPlace - split.item1.account: '151272963' - split.item1.reference: '6124145' - split.item1.description: 'Porcelain Doll: Eliza (20cm)' - split.item2.amount: '200' - split.item2.type: Commission - split.item2.reference: '6124146' - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Android - token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK - returnUrl: app:// - countryCode: NL - shopperLocale: nl_NL - sessionValidity: '2017-04-06T13:09:13Z' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-payments-applepay: - summary: Make an Apple Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: applepay - applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -8931,131 +11053,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields: - summary: Make a payment with 3D Secure 2 native authentication - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4212345678901237 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - holderName: John Smith - browserInfo: - userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 - Firefox/3.0 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct: - summary: Make a card payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw: - summary: Tokenize card details for one-off payments - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - storePaymentMethod: true - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay: - summary: Make a giropay payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: giropay - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-googlepay: - summary: Make a Google Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: paywithgoogle - googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... - merchantAccount: YourMerchantAccount - post-payments-ideal: - summary: Make an iDEAL payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: ideal - issuer: '1121' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-klarna: summary: Make a Klarna payment value: @@ -9121,95 +11118,7 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-oneclick-securedfields: - summary: Make a one-off payment with a token and CVV (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - storedPaymentMethodId: '8416038790273850' - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: CardOnFile - post-payments-recurring: - summary: Make a card payment with a token - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - storedPaymentMethodId: '8316038796685850' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: Subscription post-payments-result-basic: summary: Verify payment results value: payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK - post-payments-sofort: - summary: Make a Sofort payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: directEbanking - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-split: - summary: Split a payment between a sub-merchant and a platform account - value: - paymentMethod: - type: scheme - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' - post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT diff --git a/yaml/CheckoutService-v67.yaml b/yaml/CheckoutService-v67.yaml index f7b2ef0..79d4429 100644 --- a/yaml/CheckoutService-v67.yaml +++ b/yaml/CheckoutService-v67.yaml @@ -81,13 +81,21 @@ paths: $ref: '#/components/examples/post-orders-basic' schema: $ref: '#/components/schemas/CheckoutCreateOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-basic-200' schema: $ref: '#/components/schemas/CheckoutCreateOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -124,6 +132,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -150,13 +161,21 @@ paths: $ref: '#/components/examples/post-orders-cancel-basic' schema: $ref: '#/components/schemas/CheckoutCancelOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-orders-cancel-basic-200' schema: $ref: '#/components/schemas/CheckoutCancelOrderResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -193,6 +212,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -225,13 +247,21 @@ paths: $ref: '#/components/examples/post-originKeys-basic' schema: $ref: '#/components/schemas/CheckoutUtilityRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-originKeys-basic-200' schema: $ref: '#/components/schemas/CheckoutUtilityResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -268,6 +298,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -297,19 +330,30 @@ paths: $ref: '#/components/examples/post-paymentLinks-basic' schema: $ref: '#/components/schemas/CreatePaymentLinkRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentLinks-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '201': content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResource' description: Created - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -346,6 +390,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -369,13 +416,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -412,6 +466,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -443,13 +500,20 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' schema: $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -486,6 +550,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -523,13 +590,25 @@ paths: $ref: '#/components/examples/post-paymentMethods-basic' schema: $ref: '#/components/schemas/PaymentMethodsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-paymentMethods-basic-200' + include-oneclick-200: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + filtered-200: + $ref: '#/components/examples/post-paymentMethods-filtered-200' schema: $ref: '#/components/schemas/PaymentMethodsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -566,6 +645,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -594,13 +676,21 @@ paths: $ref: '#/components/examples/post-paymentMethods-balance-basic' schema: $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + plastix-200: + $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' schema: $ref: '#/components/schemas/CheckoutBalanceCheckResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -631,12 +721,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -663,10 +753,6 @@ paths: content: application/json: examples: - split: - $ref: '#/components/examples/post-paymentSession-split' - web: - $ref: '#/components/examples/post-paymentSession-web' android: $ref: '#/components/examples/post-paymentSession-android' ios: @@ -675,19 +761,26 @@ paths: $ref: '#/components/examples/post-paymentSession-enableOneClick' schema: $ref: '#/components/schemas/PaymentSetupRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: + examples: + web-200: + $ref: '#/components/examples/post-paymentSession-web-200' + enableOneClick-200: + $ref: '#/components/examples/post-paymentSession-enableOneClick-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -703,9 +796,6 @@ paths: '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. @@ -718,12 +808,12 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -745,44 +835,18 @@ paths: content: application/json: examples: - enableOneClick-SF: - $ref: '#/components/examples/post-payments-enableOneClick-SF' - giropay: - $ref: '#/components/examples/post-payments-giropay' - card-3d-secure-securedfields: - $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' - enableOneClick-raw: - $ref: '#/components/examples/post-payments-enableOneClick-raw' - applepay: - $ref: '#/components/examples/post-payments-applepay' - ideal: - $ref: '#/components/examples/post-payments-ideal' - oneclick-securedfields: - $ref: '#/components/examples/post-payments-oneclick-securedfields' - subscription-first-transaction: - $ref: '#/components/examples/post-payments-subscription-first-transaction' - recurring: - $ref: '#/components/examples/post-payments-recurring' - oneclick-direct: - $ref: '#/components/examples/post-payments-oneclick-direct' - card-direct: - $ref: '#/components/examples/post-payments-card-direct' - googlepay: - $ref: '#/components/examples/post-payments-googlepay' - card-3d-secure-2-web: - $ref: '#/components/examples/post-payments-card-3d-secure-2-web' - sofort: - $ref: '#/components/examples/post-payments-sofort' - card-securedfields: - $ref: '#/components/examples/post-payments-card-securedfields' card-3d-secure-direct: $ref: '#/components/examples/post-payments-card-3d-secure-direct' klarna: $ref: '#/components/examples/post-payments-klarna' - split: - $ref: '#/components/examples/post-payments-split' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' schema: $ref: '#/components/schemas/PaymentRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -790,48 +854,39 @@ paths: schema: $ref: '#/components/schemas/PaymentResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: - examples: - generic-403: - $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -853,6 +908,8 @@ paths: application/json: schema: $ref: '#/components/schemas/DetailsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -860,6 +917,9 @@ paths: schema: $ref: '#/components/schemas/PaymentDetailsResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -887,6 +947,9 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -912,6 +975,8 @@ paths: $ref: '#/components/examples/post-payments-result-basic' schema: $ref: '#/components/schemas/PaymentVerificationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: @@ -919,6 +984,9 @@ paths: schema: $ref: '#/components/schemas/PaymentVerificationResponse' description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: @@ -949,12 +1017,12 @@ paths: '422': content: application/json: - examples: - generic-422: - $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: @@ -3083,19 +3151,19 @@ components: type: string encryptedCardNumber: description: The encrypted card number. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryMonth: description: The encrypted card expiry month. - maxLength: 7000 + maxLength: 10000 type: string encryptedExpiryYear: description: The encrypted card expiry year. - maxLength: 7000 + maxLength: 10000 type: string encryptedSecurityCode: description: The encrypted card verification code. - maxLength: 7000 + maxLength: 10000 type: string expiryMonth: description: The card expiry month. Only collect raw card data if you are @@ -3349,8 +3417,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -3574,50 +3648,16 @@ components: For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' type: string resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Success** \u2013 Indicates that the balance check was successful.\n\ + * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\ + \ have enough balance to pay the amount in the request, or that the currency\ + \ of the balance on the card did not match the currency of the requested\ + \ amount.\n* **Failed** \u2013 Indicates that the balance check failed." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success + - NotEnoughBalance + - Failed type: string transactionLimit: x-addedInVersion: 65 @@ -3626,6 +3666,7 @@ components: $ref: '#/components/schemas/Amount' required: - balance + - resultCode CheckoutBankTransferAction: additionalProperties: false properties: @@ -3682,7 +3723,11 @@ components: description: A unique reference of the cancellation request. type: string resultCode: - description: The result of the cancellation request. + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Received** \u2013 Indicates the cancellation has successfully been\ + \ received by Adyen, and will be processed." + enum: + - Received type: string required: - pspReference @@ -3758,55 +3803,16 @@ components: description: The remaining amount in the order. $ref: '#/components/schemas/Amount' resultCode: - description: "The result of the payment. For more information, see [Result\ - \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ - \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ - \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ - \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ - \ \u2013 The transaction does not require 3D Secure authentication. Returned\ - \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\ - * **Authorised** \u2013 The payment was successfully authorised. This\ - \ state serves as an indicator to proceed with the delivery of goods and\ - \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\ - \ payment has been cancelled (either by the shopper or the merchant) before\ - \ processing was completed. This is a final state.\n* **ChallengeShopper**\ - \ \u2013 The issuer requires further shopper interaction before the payment\ - \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ - \ \u2013 There was an error when the payment was being processed. The\ - \ reason is given in the `refusalReason` field. This is a final state.\n\ - * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ - \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ - \ possible to obtain the final status of the payment. This can happen\ - \ if the systems providing final status information for the payment are\ - \ unavailable, or if the shopper needs to take further action to complete\ - \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\ - \ contains additional information that you need to present to a shopper,\ - \ so that they can use it to complete a payment.\n* **Received** \u2013\ - \ Indicates the payment has successfully been received by Adyen, and will\ - \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ - \ \u2013 Indicates the shopper should be redirected to an external web\ - \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ - \ the payment was refused. The reason is given in the `refusalReason`\ - \ field. This is a final state." + description: "The result of the order creation request.\n The value is always\ + \ **Success**." enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - Success type: string required: - remainingAmount - expiresAt - orderData + - resultCode CheckoutDonationAction: additionalProperties: false properties: @@ -6052,8 +6058,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -6666,8 +6678,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -8000,11 +8018,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -8580,6 +8598,21 @@ components: BasicAuth: scheme: basic type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string examples: generic-400: summary: Response code 400. Bad request. @@ -8619,10 +8652,38 @@ components: message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' + get-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A patch-paymentLinks-linkId-basic: summary: Update the status of a payment link value: status: expired + patch-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: expired + url: https://test.adyen.link/PL61C53A8B97E6915A post-orders-basic: summary: Create an order value: @@ -8631,6 +8692,17 @@ components: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178914061985' + resultCode: Success + expiresAt: '2021-04-09T14:16:46Z' + orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== + reference: shopper-reference-ekvL83 + remainingAmount: + currency: EUR + value: 2500 post-orders-cancel-basic: summary: Cancel an order value: @@ -8638,6 +8710,11 @@ components: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8816178914079738' + resultCode: Received post-originKeys-basic: summary: Get origin keys value: @@ -8645,6 +8722,13 @@ components: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com + post-originKeys-basic-200: + summary: Example response for request 'basic' + value: + originKeys: + https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw + https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc + https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg post-paymentLinks-basic: summary: Create a payment link value: @@ -8671,6 +8755,15 @@ components: houseNumberOrName: '999' country: BR stateOrProvince: SP + post-paymentLinks-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 1250 + expiresAt: '2021-04-09T14:17:31Z' + reference: shopper-reference-ekvL83 + url: https://test.adyen.link/PL6DB3157D27FFBBCF post-paymentMethods-balance-basic: summary: Retrieve gift card balance value: @@ -8688,10 +8781,1471 @@ components: cvc: '73737' holderName: BALANCE EUR 888 merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix-200: + summary: Example response for request 'plastix' + value: + additionalData: + nonScheme.transactionLimit: '5000' + nonScheme.transactionLimitCcy: EUR + pspReference: 851617891188737F + resultCode: Success + balance: + currency: EUR + value: 888 post-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic-200: + summary: Example response for request 'basic' + value: + paymentMethods: + - details: + - details: + - key: ownerName + type: text + - key: bankLocationId + type: text + - key: bankAccountNumber + type: text + key: bankAccount + type: bankAccount + name: ACH Direct Debit + type: ach + - name: Adyen Voucher + type: adyen_test_voucher + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: Afterpay + type: afterpaytouch + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: AliPay + type: alipay + - name: AliPay HK + type: alipay_hk + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Credit Card via AsiaPay + type: asiapay + - name: China UnionPay + type: asiapay_unionpay + - name: Baby Gift Card + type: babygiftcard + - name: Baloto + type: baloto + - name: BancNet + type: bancnet + - name: Bank Transfer (BG) + type: bankTransfer_BG + - name: Bank Transfer (CH) + type: bankTransfer_CH + - name: Bank Transfer (DE) + type: bankTransfer_DE + - name: Bank Transfer (FI) + type: bankTransfer_FI + - name: Bank Transfer (GB) + type: bankTransfer_GB + - name: Bank Transfer (HU) + type: bankTransfer_HU + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bank Transfer (IE) + type: bankTransfer_IE + - name: Electronic Bank Transfer (MX) + type: bankTransfer_MX_linked + - name: Bank Transfer (MX) + type: bankTransfer_MX_offline + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Bank Transfer (PL) + type: bankTransfer_PL + - name: Bank Transfer (SE) + type: bankTransfer_SE + - name: Bank Transfer (US) + type: bankTransfer_US + - name: Payconiq by Bancontact + type: bcmc_mobile + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: 99Bill + type: bill99 + - details: + - items: + - id: AUB_DIRECT + name: AU Small Finance Bank + - id: ALB_DIRECT + name: 'Allahabad Bank ' + - id: APG_DIRECT + name: Andhra Pragathi Grameena Bank + - id: BDN_DIRECT + name: Bandhan bank + - id: BBK_DIRECT + name: Bank of Bahrain and Kuwait + - id: BBR_DIRECT + name: Bank of Baroda - Retail Banking + - id: BCB_DIRECT + name: 'Bassien Catholic Co-Operative Bank ' + - id: CNB_DIRECT + name: Canara Bank + - id: SYD_DIRECT + name: Canara Bank (e-Syndicate) + - id: CSB_DIRECT + name: Catholic Syrian Bank + - id: CBI_DIRECT + name: Central Bank of India + - id: CUB_DIRECT + name: City Union Bank + - id: COB_DIRECT + name: Cosmos Bank + - id: DEN_DIRECT + name: Dena Bank + - id: DBK_DIRECT + name: Deutsche Bank + - id: DCB_DIRECT + name: Development Credit Bank + - id: DLB_DIRECT + name: Dhanlakshmi Bank - Retail Net Banking + - id: ESF_DIRECT + name: ESAF Small Finance Bank + - id: EQB_DIRECT + name: Equitas Small Finance Bank + - id: FBK_DIRECT + name: Federal Bank + - id: FNC_DIRECT + name: Fincare Bank + - id: HDF_DIRECT + name: HDFC Bank + - id: ICI_DIRECT + name: 'ICICI Bank ' + - id: IDB_DIRECT + name: IDBI Bank - Retail Net Banking + - id: IDN_DIRECT + name: IDFC FIRST Bank + - id: INB_DIRECT + name: Indian Bank + - id: IOB_DIRECT + name: Indian Overseas Bank + - id: IDS_DIRECT + name: IndusInd Bank + - id: JKB_DIRECT + name: Jammu & Kashmir Bank + - id: JNB_DIRECT + name: Jana Small Finance Bank + - id: JSB_DIRECT + name: Janata Sahakari Bank Ltd Pune + - id: KJB_DIRECT + name: Kalyan Janata Sahakari Bank + - id: KBL_DIRECT + name: Karnataka Bank Ltd + - id: KVB_DIRECT + name: Karur Vysya Bank + - id: 162_DIRECT + name: Kotak Bank + - id: LVR_DIRECT + name: Laxmi Vilas Bank - Retail + - id: NKB_DIRECT + name: NKGSB Co-op Bank + - id: NEB_DIRECT + name: North East Small Finance Bank + - id: OBC_DIRECT + name: PNB (Erstwhile-Oriental Bank of Commerce) + - id: UNI_DIRECT + name: PNB (Erstwhile-United Bank of India) + - id: PMC_DIRECT + name: Punjab & Maharastra Co-op Bank + - id: PSB_DIRECT + name: Punjab & Sind Bank + - id: CPN_DIRECT + name: 'Punjab National Bank - Corporate ' + - id: PNB_DIRECT + name: Punjab National Bank - Retail Banking + - id: RBL_DIRECT + name: RBL Bank Limited + - id: SWB_DIRECT + name: Saraswat Bank + - id: SHB_DIRECT + name: Shivalik Mercantile Cooperative Bank Ltd + - id: SIB_DIRECT + name: South Indian Bank + - id: SCB_DIRECT + name: Standard Chartered Bank + - id: SBI_DIRECT + name: State Bank of India + - id: SRB_DIRECT + name: Suryoday Small Finance Bank + - id: TJB_DIRECT + name: TJSB Bank + - id: TNC_DIRECT + name: Tamil Nadu State Co-operative Bank + - id: TMB_DIRECT + name: Tamilnad Mercantile Bank Ltd + - id: TBB_DIRECT + name: Thane Bharat Sahakari Bank Ltd + - id: MSB_DIRECT + name: The Mehsana Urban Co Op Bank Ltd + - id: UCO_DIRECT + name: UCO Bank + - id: UBI_DIRECT + name: Union Bank of India + - id: ADB_DIRECT + name: Union Bank of India (Erstwhile Andhra Bank) + - id: CRP_DIRECT + name: Union Bank of India (Erstwhile Corporation Bank) + - id: VRB_DIRECT + name: Varachha Co-operative Bank Limited + - id: VJB_DIRECT + name: Vijaya Bank + - id: YBK_DIRECT + name: Yes Bank + - id: ZOB_DIRECT + name: Zoroastrian Co-operative Bank Limited + - id: DBS_DIRECT + name: digibank by DBS + key: issuer + type: select + name: Online Banking India + type: billdesk_online + - name: UPI + type: billdesk_upi + - details: + - items: + - id: DCW_DIRECT + name: DCB Cippy + - id: ICC_DIRECT + name: ICC Cash Card + - id: OXY_DIRECT + name: Oxigen Wallet + - id: PCH_DIRECT + name: Pay World Money + key: issuer + type: select + name: Wallets India + type: billdesk_wallet + - name: Blik + type: blik + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Boleto + type: boleto + - name: Boleto Bancario + type: boletobancario_santander + - name: Bradesco + type: bradesco + - name: Cash-Ticket + type: cashticket + - name: CashU + type: cashu + - name: CCAvenue + type: ccavenue + - name: Mula Checkout + type: cellulant + - name: Chasin Giftcard + type: chasingiftcard + - name: Clearpay + type: clearpay + - name: ClickandBuy + type: clickandbuy + - name: Paiement en 3 fois par Cartes Bancaires + type: cofinoga_3xcb + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: DANA + type: dana + - name: DineroMail + type: dineromail + - name: Online bank transfer. + type: directEbanking + - name: Direct Debit Brazil - Banco do Brazil + type: directdebit_BR_bancodobrasil + - name: Direct Debit Brazil - Bradesco + type: directdebit_BR_bradesco + - name: Direct Debit Brazil - Caixa Economica Federal + type: directdebit_BR_caixa + - name: Direct Debit Brazil - HSBC + type: directdebit_BR_hsbc + - name: Direct Debit Brazil - Itau + type: directdebit_BR_itau + - name: Direct Debit Brazil - Santander + type: directdebit_BR_santander + - name: BACS Direct Debit + type: directdebit_GB + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Alfamart + type: doku_alfamart + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BCA Bank Transfer + type: doku_bca_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BNI VA + type: doku_bni_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BRI VA + type: doku_bri_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: CIMB VA + type: doku_cimb_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Danamon VA + type: doku_danamon_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Indomaret + type: doku_indomaret + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Mandiri VA + type: doku_mandiri_va + - details: + - key: ovoId + type: text + name: OVO + type: doku_ovo + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Bank Transfer + type: doku_permata_lite_atm + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: DOKU wallet + type: doku_wallet + - details: + - items: + - id: '66' + name: Bank Nowy BFG S.A. + - id: '92' + name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" + - id: '11' + name: Bank transfer / postal + - id: '74' + name: "Banki Sp\xF3\u0142dzielcze" + - id: '73' + name: BLIK + - id: '90' + name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" + - id: '59' + name: CinkciarzPAY + - id: '87' + name: Credit Agricole PBL + - id: '83' + name: EnveloBank + - id: '76' + name: Getin Bank PBL + - id: '81' + name: Idea Cloud + - id: '7' + name: ING Corporate customers + - id: '93' + name: Kasa Stefczyka + - id: '44' + name: "Millennium - P\u0142atno\u015Bci Internetowe" + - id: '10' + name: Millennium Corporate customers + - id: '68' + name: mRaty + - id: '1' + name: mTransfer + - id: '91' + name: Nest Bank + - id: '80' + name: Noble Pay + - id: '50' + name: Pay Way Toyota Bank + - id: '45' + name: Pay with Alior Bank + - id: '36' + name: Pekao24Przelew + - id: '70' + name: Pocztowy24 + - id: '6' + name: Przelew24 + - id: '46' + name: "P\u0142ac\u0119 z Citi Handlowy" + - id: '38' + name: "P\u0142ac\u0119 z ING" + - id: '2' + name: "P\u0142ac\u0119 z Inteligo" + - id: '4' + name: "P\u0142ac\u0119 z iPKO" + - id: '75' + name: "P\u0142ac\u0119 z Plus Bank" + - id: '51' + name: "P\u0142a\u0107 z BO\u015A" + - id: '55' + name: Raty z Alior Bankiem PLN + - id: '89' + name: Santander + - id: '52' + name: SkyCash + key: issuer + type: select + name: Local Polish Payment Methods + type: dotpay + - name: Dragonpay Prepaid Credits + type: dragonpay_credits + - name: Online Banking + type: dragonpay_ebanking + - name: GCash + type: dragonpay_gcash + - name: Over The Counter Banks + type: dragonpay_otc_banking + - name: OTC non-Bank via Dragonpay + type: dragonpay_otc_non_banking + - name: Convenience Stores + type: dragonpay_otc_philippines + - name: 7/11 + type: dragonpay_seveneleven + - name: eagleeye_voucher + type: eagleeye_voucher + - name: Finnish E-Banking + type: ebanking_FI + - name: Pay-easy ATM + type: econtext_atm + - name: Online Banking + type: econtext_online + - name: 7-Eleven + type: econtext_seven_eleven + - name: Convenience Stores + type: econtext_stores + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Lastschrift (ELV) + type: elv + - details: + - items: + - id: '231' + name: POP Pankki + - id: '551' + name: "Komer\u010Dn\xED banka" + - id: '232' + name: Aktia + - id: '552' + name: Raiffeisen + - id: '233' + name: "S\xE4\xE4st\xF6pankki" + - id: '750' + name: Swedbank + - id: '211' + name: Nordea + - id: '553' + name: "\u010CSOB" + - id: '234' + name: S-Pankki + - id: '751' + name: SEB + - id: '554' + name: Moneta + - id: '235' + name: OmaSP + - id: '752' + name: Nordea + - id: '213' + name: Op-Pohjola + - id: '555' + name: UniCredit + - id: '753' + name: LHV + - id: '556' + name: Fio + - id: '557' + name: mBank + - id: '216' + name: Handelsbanken + - id: '558' + name: Air Bank + - id: '260' + name: "L\xE4nsf\xF6rs\xE4kringar" + - id: '240' + name: BankDeposit + - id: '265' + name: Sparbanken + - id: '640' + name: BankDeposit + - id: '200' + name: "\xC5landsbanken" + - id: '940' + name: Swedbank + - id: '500' + name: "\u010Cesk\xE1 spo\u0159itelna" + - id: '720' + name: Swedbank + - id: '941' + name: SEB + - id: '204' + name: Danske Bank + - id: '721' + name: SEB + - id: '942' + name: Citadele + - id: '205' + name: Handelsbanken + - id: '722' + name: DNB + - id: '943' + name: DNB + - id: '206' + name: Nordea + - id: '723' + name: "\u0160iauli\u0173 bankas" + - id: '207' + name: SEB + - id: '724' + name: Nordea + - id: '505' + name: "Komer\u010Dn\xED banka" + - id: '208' + name: Skandiabanken + - id: '209' + name: Swedbank + key: issuer + type: select + name: Bank Payment + type: entercash + - name: Nationale Entertainment Card + type: entertainmentcard + - details: + - items: + - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 + name: Dolomitenbank + - id: ee9fc487-ebe0-486c-8101-17dce5141a67 + name: Raiffeissen Bankengruppe + - id: 6765e225-a0dc-4481-9666-e26303d4f221 + name: Hypo Tirol Bank AG + - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc + name: Sparda Bank Wien + - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f + name: Schoellerbank AG + - id: e2e97aaa-de4c-4e18-9431-d99790773433 + name: Volksbank Gruppe + - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 + name: Immo-Bank + - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 + name: Bank Austria + - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 + name: Easybank AG + - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a + name: VR-BankBraunau + - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 + name: Volkskreditbank + - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 + name: Erste Bank und Sparkassen + - id: ba7199cc-f057-42f2-9856-2378abf21638 + name: BAWAG P.S.K. Gruppe + key: issuer + type: select + name: EPS + type: eps + - name: Expert Cadeaukaart + type: expertgiftcard + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 3x Oney + type: facilypay_3x + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 4x Oney + type: facilypay_4x + - name: Fashioncheque + type: fashioncheque + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: Fawry + type: fawry + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Fonq Giftcard + type: fonqgiftcard + - name: Gall & Gall + type: gallgall + - name: GCash + type: gcash + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - details: + - key: bic + type: text + name: GiroPay + type: giropay + - name: Givex + type: givex + - name: Globe GCash + type: globegcash + - name: Goldsmiths Card + type: goldsmithscard + - name: GoPay Wallet + type: gopay_wallet + - name: OVO + type: grabpay_ID + - name: GrabPay + type: grabpay_PH + - name: GrabPay + type: grabpay_SG + - name: Hallmark Card + type: hallmarkcard + - name: HDFC + type: hdfc + - name: Hunkemoller Member Card + type: hmclub + - name: Hunkemoller Lingerie Card + type: hmlingerie + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - name: igive + type: igive + - name: Korean Account Transfer (IniPay) + type: inicisIniPay_accounttransfer + - name: Korean Credit Cards (IniPay) + type: inicisIniPay_creditcard + - name: Korean Mobile Phone (IniPay) + type: inicisIniPay_mobilephone + - name: Korean Virtual Account (IniPay) + type: inicisIniPay_virtualaccount + - name: Korean Account Transfer (Mobile) + type: inicisMobile_accounttransfer + - name: Korean Credit Cards (Mobile) + type: inicisMobile_creditcard + - name: Korean Mobile Phone (Mobile) + type: inicisMobile_mobilephone + - name: Korean Virtual Account (Mobile) + type: inicisMobile_virtualaccount + - name: Korean Credit Cards + type: inicis_creditcard + - name: "Interac\xAE Online" + type: interac + - name: Instant EFT + type: ipay + - name: iPay88 + type: ipay88 + - name: isracard + type: isracard + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: KakaoPay + type: kakaopay + - name: Karen Millen Card + type: karenmillen + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Bank Transfer + type: kcp_banktransfer + - name: "Korea\u2013issued cards" + type: kcp_creditcard + - name: PayCo + type: kcp_payco + - name: Virtual Account via KCP + type: kcp_va + - name: Pay later with Klarna. + type: klarna + - name: Pay over time with Klarna. + type: klarna_account + - name: Klarna B2B + type: klarna_b2b + - name: Pay now with Klarna. + type: klarna_paynow + - name: Leisure Card + type: leisurecard + - name: China Credit Card + type: lianlianpay_creditcard + - name: China Debit Card + type: lianlianpay_debitcard + - details: + - key: telephoneNumber + type: tel + name: China Online Banking - Credit Card + type: lianlianpay_ebanking_credit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '4031000' + name: Bank of Beijing + - id: '01040000' + name: Bank of China + - id: '03020000' + name: China Citic Bank + - id: '01050000' + name: China Construction Bank + - id: '03030000' + name: China Everbright Bank + - id: 03080000 + name: China Merchants Bank + - id: '03050000' + name: China Minsheng Banking Group + - id: '03040000' + name: Hua Xia Bank Co + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03070000' + name: PingAn Bank + - id: '1000000' + name: Postal Savings Bank of China + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Debit Card + type: lianlianpay_ebanking_debit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '01050000' + name: China Construction Bank + - id: 03080000 + name: China Merchants Bank + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03100000' + name: Shanghai Pudong Development Bank + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Enterprise + type: lianlianpay_ebanking_enterprise + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - name: Love2Shop GiftCard + type: love2shop + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: mada + type: mada + - name: Mappin & Webb Card + type: mappinwebbcard + - name: MB WAY + type: mbway + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: Mercado Pago + type: mercadopago + - name: MobilePay + type: mobilepay + - name: AliPay via Razer Merchant Services + type: molpay_alipay + - name: 7-Eleven + type: molpay_cash + - name: CIMB Virtual Account + type: molpay_cimb_va + - name: Malaysia E-Banking via Razer Merchant Services + type: molpay_ebanking_MY + - details: + - items: + - id: vtcpay-vietinbank + name: Vietinbank + - id: vtcpay-bidv + name: BIDV + - id: vtcpay-agribank + name: Agribank + - id: vtcpay-mb + name: MB Bank + - id: vtcpay-sacombank + name: Sacombank + - id: vtcpay-dongabank + name: DongABank + - id: vtcpay-maritimebank + name: MaritimeBank + - id: vtcpay-vietcombank + name: Vietcombank + - id: vtcpay-acb + name: ACB + - id: vtcpay-techcombank + name: Techcombank + key: issuer + type: select + name: Vietnam E-Banking + type: molpay_ebanking_VN + - details: + - items: + - id: fpx_bimb + name: Bank Islam + - id: fpx_uob + name: UOB Bank + - id: fpx_cimbclicks + name: CIMB Clicks + - id: fpx_kfh + name: Kuwait Finance House + - id: fpx_rhb + name: RHB Now + - id: fpx_abmb + name: Alliance Bank + - id: fpx_amb + name: Am Online + - id: fpx_hsbc + name: HSBC + - id: fpx_abb + name: Affin Bank + - id: fpx_ocbc + name: OCBC Bank + - id: fpx_pbb + name: Public Bank + - id: fpx_scb + name: Standard Chartered Bank + - id: fpx_bsn + name: Bank Simpanan Nasional + - id: fpx_mb2u + name: Maybank2u + - id: fpx_hlb + name: Hong Leong Connect + - id: fpx_bmmb + name: Bank Muamalat + - id: fpx_bkrm + name: Bank Rakyat + key: issuer + type: select + name: Malaysia E-Banking + type: molpay_ebanking_fpx_MY + - name: eNETS Debit + type: molpay_enetsd + - name: epay + type: molpay_epay + - name: Esapay + type: molpay_esapay + - name: MyClear FPX + type: molpay_fpx + - name: Maybank2u + type: molpay_maybank2u + - name: Nganluong + type: molpay_nganluong + - name: Tesco Lotus + type: molpay_paysbuy + - name: MOLPoints + type: molpay_points + - name: RHB Now + type: molpay_rhb + - name: SAM by SingPost + type: molpay_singpost + - name: MOLWallet + type: molpay_wallet + - name: MoMo ATM + type: momo_atm + - name: Momo Wallet + type: momo_wallet + - name: Moneybookers + type: moneybookers + - name: Multibanco + type: multibanco + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: BankAxess + type: netaxept_bankaxess + - name: NETELLER + type: neteller + - name: Onebip + type: onebip + - name: One Two Three + type: onetwothree + - name: Local Polish Payment Methods + type: onlineBanking_PL + - details: + - items: + - id: '1' + name: Model Bank v2 + key: issuer + type: select + name: Online banking + type: openbanking_UK + - name: Oxxo + type: oxxo + - name: Pathe Giftcard + type: pathegiftcard + - name: PayBright + type: paybright + - name: PayMaya Wallet + type: paymaya_wallet + - name: PayPal + type: paypal + - name: Paysafecard + type: paysafecard + - name: Payshop + type: payshop + - name: PayD AMT via Paythru + type: paythru_amt + - name: EFT via Paythru + type: paythru_eft + - name: PayTM + type: paytm + - details: + - key: virtualPaymentAddress + type: text + name: PayU UPI + type: payu_IN_upi + - name: EFT Pro via PayU + type: payu_ZA_eftpro + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: pix + type: pix + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Podium Card + type: podiumcard + - name: POLi + type: poli + - name: PPS + type: pps + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Illicado Gift Card + type: prosodie_illicado + - name: PSE + type: pse + - details: + - items: + - id: '+7' + name: RU + - id: '+9955' + name: GE + - id: '+507' + name: PA + - id: '+44' + name: GB + - id: '+992' + name: TJ + - id: '+370' + name: LT + - id: '+972' + name: IL + - id: '+996' + name: KG + - id: '+380' + name: UA + - id: '+84' + name: VN + - id: '+90' + name: TR + - id: '+994' + name: AZ + - id: '+374' + name: AM + - id: '+371' + name: LV + - id: '+91' + name: IN + - id: '+66' + name: TH + - id: '+373' + name: MD + - id: '+1' + name: US + - id: '+81' + name: JP + - id: '+998' + name: UZ + - id: '+77' + name: KZ + - id: '+375' + name: BY + - id: '+372' + name: EE + - id: '+40' + name: RO + - id: '+82' + name: KR + key: qiwiwallet.telephoneNumberPrefix + type: select + - key: qiwiwallet.telephoneNumber + type: text + name: Qiwi Wallet + type: qiwiwallet + - name: RatePay Invoice + type: ratepay + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: SafetyPay + type: safetypay + - name: SafetyPay Cash + type: safetypay_cash + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: SEB Direktbetalning + type: sebdirectpayment + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: 7-Eleven + type: seveneleven + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: Swish + type: swish + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: TenPay + type: tenpay + - name: The Sting Giftcard + type: thestinggiftcard + - name: Trustly + type: trustly + - name: Online Banking by Trustpay + type: trustpay + - name: TWINT + type: twint + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - details: + - key: virtualPaymentAddress + type: text + name: UPI Collect + type: upi_collect + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: telephoneNumber + optional: true + type: tel + name: Vipps + type: vipps + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: VVV Giftcard + type: vvvgiftcard + - name: Webshop Giftcard + type: webshopgiftcard + - name: WeChat Pay + type: wechatpayMiniProgram + - name: WeChat Pay + type: wechatpayQR + - name: WeChat Pay + type: wechatpayWeb + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: WOS Card + type: woscard + - name: Alfa-Click + type: yandex_alfaclick + - name: Pay using bank card + type: yandex_bank_card + - name: Cash terminals + type: yandex_cash + - name: Pay using installments + type: yandex_installments + - name: YooMoney + type: yandex_money + - name: Promsvyazbank + type: yandex_promsvyazbank + - name: Sberbank Online + type: yandex_sberbank + - name: WebMoney + type: yandex_webmoney + - name: Your Gift + type: yourgift + - name: Zip + type: zip post-paymentMethods-filtered: summary: Get payment methods based on the country and amount value: @@ -8701,6 +10255,313 @@ components: amount: currency: EUR value: 1000 + post-paymentMethods-filtered-200: + summary: Example response for request 'filtered' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentMethods-include-oneclick: summary: Get payment methods including stored card details value: @@ -8710,6 +10571,313 @@ components: currency: EUR value: 1000 shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-paymentMethods-include-oneclick-200: + summary: Example response for request 'include-oneclick' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift post-paymentSession-android: summary: Set up a payment session (Android) value: @@ -8743,6 +10911,10 @@ components: shopperLocale: nl_NL merchantAccount: YOUR_MERCHANT_ACCOUNT sdkVersion: 1.7.0 + post-paymentSession-enableOneClick-200: + summary: Example response for request 'enableOneClick' + value: + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-paymentSession-ios: summary: Set up a payment session (iOS) value: @@ -8758,62 +10930,10 @@ components: shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-split: - summary: Split a payment between a sub-merchant and a platform account + post-paymentSession-web-200: + summary: Example response for request 'web' value: - amount: - currency: EUR - value: 6200 - additionalData: - split.api: '1' - split.nrOfItems: '2' - split.totalAmount: '6200' - split.currencyCode: EUR - split.item1.amount: '6000' - split.item1.type: MarketPlace - split.item1.account: '151272963' - split.item1.reference: '6124145' - split.item1.description: 'Porcelain Doll: Eliza (20cm)' - split.item2.amount: '200' - split.item2.type: Commission - split.item2.reference: '6124146' - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Android - token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK - returnUrl: app:// - countryCode: NL - shopperLocale: nl_NL - sessionValidity: '2017-04-06T13:09:13Z' - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-paymentSession-web: - summary: Set up a payment session (Web) - value: - amount: - currency: EUR - value: 17408 - reference: Your order number - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - channel: Web - html: true - origin: https://www.yourwebsite.com - returnUrl: https://www.yourshop.com/checkout/result - countryCode: NL - shopperLocale: nl_NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - sdkVersion: 1.9.5 - post-payments-applepay: - summary: Make an Apple Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: applepay - applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication value: @@ -8875,131 +10995,6 @@ components: acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-3d-secure-securedfields: - summary: Make a payment with 3D Secure 2 native authentication - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4212345678901237 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - holderName: John Smith - browserInfo: - userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 - Firefox/3.0 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-direct: - summary: Make a card payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-card-securedfields: - summary: Make a card payment (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-SF: - summary: Tokenize card details for one-off payments (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - encryptedCardNumber: test_4111111111111111 - encryptedExpiryMonth: test_03 - encryptedExpiryYear: test_2030 - encryptedSecurityCode: test_737 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-enableOneClick-raw: - summary: Tokenize card details for one-off payments - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperInteraction: Ecommerce - recurringProcessingModel: CardOnFile - storePaymentMethod: true - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-giropay: - summary: Make a giropay payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: giropay - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-googlepay: - summary: Make a Google Pay payment - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: paywithgoogle - googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... - merchantAccount: YourMerchantAccount - post-payments-ideal: - summary: Make an iDEAL payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: ideal - issuer: '1121' - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-klarna: summary: Make a Klarna payment value: @@ -9065,95 +11060,7 @@ components: shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-oneclick-securedfields: - summary: Make a one-off payment with a token and CVV (using encrypted card details) - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - storedPaymentMethodId: '8416038790273850' - encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: CardOnFile - post-payments-recurring: - summary: Make a card payment with a token - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - storedPaymentMethodId: '8316038796685850' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - shopperInteraction: ContAuth - recurringProcessingModel: Subscription post-payments-result-basic: summary: Verify payment results value: payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK - post-payments-sofort: - summary: Make a Sofort payment - value: - amount: - currency: EUR - value: 1000 - reference: Your order number - paymentMethod: - type: directEbanking - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-payments-split: - summary: Split a payment between a sub-merchant and a platform account - value: - paymentMethod: - type: scheme - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' - post-payments-subscription-first-transaction: - summary: Tokenize card details for a subscription - value: - amount: - currency: USD - value: 1000 - reference: Your order number - paymentMethod: - type: scheme - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - cvc: '737' - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - storePaymentMethod: true - shopperInteraction: Ecommerce - recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... - merchantAccount: YOUR_MERCHANT_ACCOUNT diff --git a/yaml/FundService-v3.yaml b/yaml/FundService-v3.yaml index d906118..a4db6e7 100644 --- a/yaml/FundService-v3.yaml +++ b/yaml/FundService-v3.yaml @@ -127,11 +127,6 @@ paths: requestBody: content: application/json: - examples: - basic: - $ref: '#/components/examples/post-accountHolderTransactionList-basic' - specific: - $ref: '#/components/examples/post-accountHolderTransactionList-specific' schema: $ref: '#/components/schemas/AccountHolderTransactionListRequest' responses: @@ -592,6 +587,7 @@ components: >* `FundTransfer` - a transfer of funds from one account to another.' items: enum: + - BalanceNotPaidOutTransfer - Chargeback - ChargebackCorrection - ChargebackCorrectionReceived @@ -1154,6 +1150,7 @@ components: `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.' enum: + - BalanceNotPaidOutTransfer - Chargeback - ChargebackCorrection - ChargebackCorrectionReceived @@ -1281,26 +1278,6 @@ components: summary: Review the account holder balance value: accountHolderCode: CODE_OF_ACCOUNT_HOLDER - post-accountHolderTransactionList-basic: - summary: Retrieve transactions page by page - value: - accountHolderCode: TestAccountHolder308260 - transactionListsPerAccount: - - TransactionListForAccount: - accountCode: '195752115' - page: 1 - post-accountHolderTransactionList-specific: - summary: Retrieve transactions with specific statuses. - value: - accountHolderCode: TestAccountHolder423978 - transactionStatuses: - - PendingCredit - - Credited - - Debited - transactionListsPerAccount: - - TransactionListForAccount: - accountCode: 2e64b396-1200-4474-b848-0cb06b52b3c7 - page: 2 post-payoutAccountHolder-oneOff: summary: One-off payout value: diff --git a/yaml/FundService-v5.yaml b/yaml/FundService-v5.yaml index 68053f9..def2d79 100644 --- a/yaml/FundService-v5.yaml +++ b/yaml/FundService-v5.yaml @@ -127,11 +127,6 @@ paths: requestBody: content: application/json: - examples: - basic: - $ref: '#/components/examples/post-accountHolderTransactionList-basic' - specific: - $ref: '#/components/examples/post-accountHolderTransactionList-specific' schema: $ref: '#/components/schemas/AccountHolderTransactionListRequest' responses: @@ -588,6 +583,7 @@ components: >* `FundTransfer` - a transfer of funds from one account to another.' items: enum: + - BalanceNotPaidOutTransfer - Chargeback - ChargebackCorrection - ChargebackCorrectionReceived @@ -1322,6 +1318,7 @@ components: `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.' enum: + - BalanceNotPaidOutTransfer - Chargeback - ChargebackCorrection - ChargebackCorrectionReceived @@ -1445,24 +1442,6 @@ components: summary: Review the account holder balance value: accountHolderCode: CODE_OF_ACCOUNT_HOLDER - post-accountHolderTransactionList-basic: - summary: Retrieve transactions page by page - value: - accountHolderCode: CODE_OF_ACCOUNT_HOLDER - transactionListsPerAccount: - - accountCode: '195752115' - page: 1 - post-accountHolderTransactionList-specific: - summary: Retrieve transactions with specific statuses. - value: - accountHolderCode: CODE_OF_ACCOUNT_HOLDER - transactionStatuses: - - PendingCredit - - Credited - - Debited - transactionListsPerAccount: - - accountCode: 2e64b396-1200-4474-b848-0cb06b52b3c7 - page: 2 post-payoutAccountHolder-oneOff: summary: One-off payout value: diff --git a/yaml/FundService-v6.yaml b/yaml/FundService-v6.yaml index 8847b37..8b8f8b2 100644 --- a/yaml/FundService-v6.yaml +++ b/yaml/FundService-v6.yaml @@ -127,11 +127,6 @@ paths: requestBody: content: application/json: - examples: - basic: - $ref: '#/components/examples/post-accountHolderTransactionList-basic' - specific: - $ref: '#/components/examples/post-accountHolderTransactionList-specific' schema: $ref: '#/components/schemas/AccountHolderTransactionListRequest' responses: @@ -588,6 +583,7 @@ components: >* `FundTransfer` - a transfer of funds from one account to another.' items: enum: + - BalanceNotPaidOutTransfer - Chargeback - ChargebackCorrection - ChargebackCorrectionReceived @@ -1322,6 +1318,7 @@ components: `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.' enum: + - BalanceNotPaidOutTransfer - Chargeback - ChargebackCorrection - ChargebackCorrectionReceived @@ -1445,24 +1442,6 @@ components: summary: Review the account holder balance value: accountHolderCode: CODE_OF_ACCOUNT_HOLDER - post-accountHolderTransactionList-basic: - summary: Retrieve transactions page by page - value: - accountHolderCode: CODE_OF_ACCOUNT_HOLDER - transactionListsPerAccount: - - accountCode: '195752115' - page: 1 - post-accountHolderTransactionList-specific: - summary: Retrieve transactions with specific statuses. - value: - accountHolderCode: CODE_OF_ACCOUNT_HOLDER - transactionStatuses: - - PendingCredit - - Credited - - Debited - transactionListsPerAccount: - - accountCode: 2e64b396-1200-4474-b848-0cb06b52b3c7 - page: 2 post-payoutAccountHolder-oneOff: summary: One-off payout value: diff --git a/yaml/HopService-v1.yaml b/yaml/HopService-v1.yaml index 180f39c..0cc2b96 100644 --- a/yaml/HopService-v1.yaml +++ b/yaml/HopService-v1.yaml @@ -134,6 +134,28 @@ paths: description: Internal Server Error - the server could not process the request. components: schemas: + CollectInformation: + properties: + bankDetails: + description: Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) + must be collected. Defaults to **true**. + type: boolean + businessDetails: + description: Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) + must be collected. Defaults to **true**. + type: boolean + individualDetails: + description: Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) + must be collected. Defaults to **true**. + type: boolean + pciQuestionnaire: + description: Indicates whether answers to a PCI questionnaire must be collected. + Defaults to **true**. + type: boolean + shareholderDetails: + description: Indicates whether [shareholder details](https://docs.adyen.com/platforms/verification-checks/identity-check) + must be collected. Defaults to **true**. + type: boolean ErrorFieldType: properties: errorCode: @@ -295,6 +317,12 @@ components: description: The account holder code you provided when you created the account holder. type: string + collectInformation: + description: Contains indicators whether the page should only collect information + for specific [KYC checks](https://docs.adyen.com/platforms/verification-checks). + By default, the page collects information for all KYC checks that apply + to the [legal entity type](https://docs.adyen.com/platforms/account-holders-and-accounts#legal-entity-types). + $ref: '#/components/schemas/CollectInformation' editMode: description: Indicates if editing checks is allowed even if all the checks have passed. diff --git a/yaml/HopService-v5.yaml b/yaml/HopService-v5.yaml index 6d11c59..9018502 100644 --- a/yaml/HopService-v5.yaml +++ b/yaml/HopService-v5.yaml @@ -134,6 +134,28 @@ paths: description: Internal Server Error - the server could not process the request. components: schemas: + CollectInformation: + properties: + bankDetails: + description: Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) + must be collected. Defaults to **true**. + type: boolean + businessDetails: + description: Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) + must be collected. Defaults to **true**. + type: boolean + individualDetails: + description: Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) + must be collected. Defaults to **true**. + type: boolean + pciQuestionnaire: + description: Indicates whether answers to a PCI questionnaire must be collected. + Defaults to **true**. + type: boolean + shareholderDetails: + description: Indicates whether [shareholder details](https://docs.adyen.com/platforms/verification-checks/identity-check) + must be collected. Defaults to **true**. + type: boolean ErrorFieldType: properties: errorCode: @@ -295,6 +317,12 @@ components: description: The account holder code you provided when you created the account holder. type: string + collectInformation: + description: Contains indicators whether the page should only collect information + for specific [KYC checks](https://docs.adyen.com/platforms/verification-checks). + By default, the page collects information for all KYC checks that apply + to the [legal entity type](https://docs.adyen.com/platforms/account-holders-and-accounts#legal-entity-types). + $ref: '#/components/schemas/CollectInformation' editMode: description: Indicates if editing checks is allowed even if all the checks have passed. diff --git a/yaml/HopService-v6.yaml b/yaml/HopService-v6.yaml index 7115230..45fdfa3 100644 --- a/yaml/HopService-v6.yaml +++ b/yaml/HopService-v6.yaml @@ -134,6 +134,28 @@ paths: description: Internal Server Error - the server could not process the request. components: schemas: + CollectInformation: + properties: + bankDetails: + description: Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) + must be collected. Defaults to **true**. + type: boolean + businessDetails: + description: Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) + must be collected. Defaults to **true**. + type: boolean + individualDetails: + description: Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) + must be collected. Defaults to **true**. + type: boolean + pciQuestionnaire: + description: Indicates whether answers to a PCI questionnaire must be collected. + Defaults to **true**. + type: boolean + shareholderDetails: + description: Indicates whether [shareholder details](https://docs.adyen.com/platforms/verification-checks/identity-check) + must be collected. Defaults to **true**. + type: boolean ErrorFieldType: properties: errorCode: @@ -295,6 +317,12 @@ components: description: The account holder code you provided when you created the account holder. type: string + collectInformation: + description: Contains indicators whether the page should only collect information + for specific [KYC checks](https://docs.adyen.com/platforms/verification-checks). + By default, the page collects information for all KYC checks that apply + to the [legal entity type](https://docs.adyen.com/platforms/account-holders-and-accounts#legal-entity-types). + $ref: '#/components/schemas/CollectInformation' editMode: description: Indicates if editing checks is allowed even if all the checks have passed. diff --git a/yaml/MarketPayNotificationService-v3.yaml b/yaml/MarketPayNotificationService-v3.yaml index f451c6d..6b3365f 100644 --- a/yaml/MarketPayNotificationService-v3.yaml +++ b/yaml/MarketPayNotificationService-v3.yaml @@ -406,6 +406,26 @@ paths: schema: $ref: '#/components/schemas/NotificationResponse' description: OK - the request has succeeded. + /TRANSFER_NOT_PAIDOUT_TRANSFERS: + post: + summary: Triggered when not paid out transfers are transferred to liable. + description: This notification is sent when not paidout transfers from an account + have been transferred to the configured liable account. + operationId: post-TRANSFER_NOT_PAIDOUT_TRANSFERS + x-groupName: Fund management + x-sortIndex: 9 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TransferNotPaidoutTransfersNotification' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. components: schemas: AccountCloseNotification: @@ -2284,11 +2304,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -2383,6 +2403,7 @@ components: `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.' enum: + - BalanceNotPaidOutTransfer - Chargeback - ChargebackCorrection - ChargebackCorrectionReceived @@ -2478,6 +2499,51 @@ components: - destinationAccountCode - amount - transferCode + TransferNotPaidoutTransfersNotification: + properties: + content: + description: Details of the fund transfer. + $ref: '#/components/schemas/TransferNotPaidoutTransfersNotificationContent' + eventType: + description: The event type of the notification. + type: string + executingUserKey: + description: The user or process that has triggered the notification. + type: string + live: + description: Indicates whether the notification originated from the live + environment or the test environment. If true, the notification originated + from the live environment. If false, the notification originated from + the test environment. + type: boolean + pspReference: + description: The PSP reference of the request from which the notification + originates. + type: string + required: + - executingUserKey + - pspReference + - eventType + - live + - content + TransferNotPaidoutTransfersNotificationContent: + properties: + amount: + description: The amount transferred. + $ref: '#/components/schemas/Amount' + destinationAccountCode: + description: The code of the Account to which funds were credited. + type: string + sourceAccountCode: + description: The code of the Account from which funds were debited. + type: string + status: + description: The status of the fund transfer. + $ref: '#/components/schemas/OperationStatus' + required: + - sourceAccountCode + - destinationAccountCode + - amount UpdateAccountHolderResponse: properties: accountHolderCode: diff --git a/yaml/MarketPayNotificationService-v4.yaml b/yaml/MarketPayNotificationService-v4.yaml index d5be739..4fef04e 100644 --- a/yaml/MarketPayNotificationService-v4.yaml +++ b/yaml/MarketPayNotificationService-v4.yaml @@ -406,6 +406,26 @@ paths: schema: $ref: '#/components/schemas/NotificationResponse' description: OK - the request has succeeded. + /TRANSFER_NOT_PAIDOUT_TRANSFERS: + post: + summary: Triggered when not paid out transfers are transferred to liable. + description: This notification is sent when not paidout transfers from an account + have been transferred to the configured liable account. + operationId: post-TRANSFER_NOT_PAIDOUT_TRANSFERS + x-groupName: Fund management + x-sortIndex: 9 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TransferNotPaidoutTransfersNotification' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. components: schemas: AccountCloseNotification: @@ -2404,11 +2424,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -2503,6 +2523,7 @@ components: `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.' enum: + - BalanceNotPaidOutTransfer - Chargeback - ChargebackCorrection - ChargebackCorrectionReceived @@ -2604,6 +2625,57 @@ components: - destinationAccountCode - amount - transferCode + TransferNotPaidoutTransfersNotification: + properties: + content: + description: Details of the fund transfer. + $ref: '#/components/schemas/TransferNotPaidoutTransfersNotificationContent' + eventDate: + x-addedInVersion: 4 + description: The date and time when an event has been completed. + format: date-time + type: string + eventType: + description: The event type of the notification. + type: string + executingUserKey: + description: The user or process that has triggered the notification. + type: string + live: + description: Indicates whether the notification originated from the live + environment or the test environment. If true, the notification originated + from the live environment. If false, the notification originated from + the test environment. + type: boolean + pspReference: + description: The PSP reference of the request from which the notification + originates. + type: string + required: + - executingUserKey + - pspReference + - eventType + - live + - eventDate + - content + TransferNotPaidoutTransfersNotificationContent: + properties: + amount: + description: The amount transferred. + $ref: '#/components/schemas/Amount' + destinationAccountCode: + description: The code of the Account to which funds were credited. + type: string + sourceAccountCode: + description: The code of the Account from which funds were debited. + type: string + status: + description: The status of the fund transfer. + $ref: '#/components/schemas/OperationStatus' + required: + - sourceAccountCode + - destinationAccountCode + - amount UpdateAccountHolderResponse: properties: accountHolderCode: diff --git a/yaml/MarketPayNotificationService-v5.yaml b/yaml/MarketPayNotificationService-v5.yaml index bc44465..e45cf1b 100644 --- a/yaml/MarketPayNotificationService-v5.yaml +++ b/yaml/MarketPayNotificationService-v5.yaml @@ -406,6 +406,26 @@ paths: schema: $ref: '#/components/schemas/NotificationResponse' description: OK - the request has succeeded. + /TRANSFER_NOT_PAIDOUT_TRANSFERS: + post: + summary: Triggered when not paid out transfers are transferred to liable. + description: This notification is sent when not paidout transfers from an account + have been transferred to the configured liable account. + operationId: post-TRANSFER_NOT_PAIDOUT_TRANSFERS + x-groupName: Fund management + x-sortIndex: 9 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TransferNotPaidoutTransfersNotification' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. components: schemas: AccountCloseNotification: @@ -2653,11 +2673,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -2832,6 +2852,7 @@ components: `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.' enum: + - BalanceNotPaidOutTransfer - Chargeback - ChargebackCorrection - ChargebackCorrectionReceived @@ -2944,6 +2965,68 @@ components: - destinationAccountCode - amount - transferCode + TransferNotPaidoutTransfersNotification: + properties: + content: + description: Details of the fund transfer. + $ref: '#/components/schemas/TransferNotPaidoutTransfersNotificationContent' + error: + x-addedInVersion: 5 + description: Error information of failed request. No value provided here + if no error occurred on processing. + $ref: '#/components/schemas/NotificationErrorContainer' + eventDate: + x-addedInVersion: 4 + description: The date and time when an event has been completed. + format: date-time + type: string + eventType: + description: The event type of the notification. + type: string + executingUserKey: + description: The user or process that has triggered the notification. + type: string + live: + description: Indicates whether the notification originated from the live + environment or the test environment. If true, the notification originated + from the live environment. If false, the notification originated from + the test environment. + type: boolean + pspReference: + description: The PSP reference of the request from which the notification + originates. + type: string + required: + - executingUserKey + - pspReference + - eventType + - live + - eventDate + - content + TransferNotPaidoutTransfersNotificationContent: + properties: + amount: + description: The amount transferred. + $ref: '#/components/schemas/Amount' + destinationAccountCode: + description: The code of the Account to which funds were credited. + type: string + invalidFields: + x-addedInVersion: 5 + description: Invalid fields list. + items: + $ref: '#/components/schemas/ErrorFieldType' + type: array + sourceAccountCode: + description: The code of the Account from which funds were debited. + type: string + status: + description: The status of the fund transfer. + $ref: '#/components/schemas/OperationStatus' + required: + - sourceAccountCode + - destinationAccountCode + - amount UpdateAccountHolderResponse: properties: accountHolderCode: diff --git a/yaml/MarketPayNotificationService-v6.yaml b/yaml/MarketPayNotificationService-v6.yaml index c6bbb9b..5a4c303 100644 --- a/yaml/MarketPayNotificationService-v6.yaml +++ b/yaml/MarketPayNotificationService-v6.yaml @@ -406,6 +406,26 @@ paths: schema: $ref: '#/components/schemas/NotificationResponse' description: OK - the request has succeeded. + /TRANSFER_NOT_PAIDOUT_TRANSFERS: + post: + summary: Triggered when not paid out transfers are transferred to liable. + description: This notification is sent when not paidout transfers from an account + have been transferred to the configured liable account. + operationId: post-TRANSFER_NOT_PAIDOUT_TRANSFERS + x-groupName: Fund management + x-sortIndex: 9 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TransferNotPaidoutTransfersNotification' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationResponse' + description: OK - the request has succeeded. components: schemas: AccountCloseNotification: @@ -2677,11 +2697,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -2856,6 +2876,7 @@ components: `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.' enum: + - BalanceNotPaidOutTransfer - Chargeback - ChargebackCorrection - ChargebackCorrectionReceived @@ -2968,6 +2989,68 @@ components: - destinationAccountCode - amount - transferCode + TransferNotPaidoutTransfersNotification: + properties: + content: + description: Details of the fund transfer. + $ref: '#/components/schemas/TransferNotPaidoutTransfersNotificationContent' + error: + x-addedInVersion: 5 + description: Error information of failed request. No value provided here + if no error occurred on processing. + $ref: '#/components/schemas/NotificationErrorContainer' + eventDate: + x-addedInVersion: 4 + description: The date and time when an event has been completed. + format: date-time + type: string + eventType: + description: The event type of the notification. + type: string + executingUserKey: + description: The user or process that has triggered the notification. + type: string + live: + description: Indicates whether the notification originated from the live + environment or the test environment. If true, the notification originated + from the live environment. If false, the notification originated from + the test environment. + type: boolean + pspReference: + description: The PSP reference of the request from which the notification + originates. + type: string + required: + - executingUserKey + - pspReference + - eventType + - live + - eventDate + - content + TransferNotPaidoutTransfersNotificationContent: + properties: + amount: + description: The amount transferred. + $ref: '#/components/schemas/Amount' + destinationAccountCode: + description: The code of the Account to which funds were credited. + type: string + invalidFields: + x-addedInVersion: 5 + description: Invalid fields list. + items: + $ref: '#/components/schemas/ErrorFieldType' + type: array + sourceAccountCode: + description: The code of the Account from which funds were debited. + type: string + status: + description: The status of the fund transfer. + $ref: '#/components/schemas/OperationStatus' + required: + - sourceAccountCode + - destinationAccountCode + - amount UpdateAccountHolderResponse: properties: accountHolderCode: diff --git a/yaml/NotificationConfigurationService-v1.yaml b/yaml/NotificationConfigurationService-v1.yaml index 5f2c43b..1847392 100644 --- a/yaml/NotificationConfigurationService-v1.yaml +++ b/yaml/NotificationConfigurationService-v1.yaml @@ -84,6 +84,9 @@ paths: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-createNotificationConfiguration-basic-200' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -341,6 +344,9 @@ paths: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic-200' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -579,6 +585,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string includeMode: description: 'Indicates whether the specified eventType is to be sent to @@ -649,6 +656,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string type: array notificationId: @@ -695,6 +703,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string type: array exchangeMessages: @@ -767,6 +776,23 @@ components: notifyPassword: testPassword sendActionHeader: true sslProtocol: SSL + post-createNotificationConfiguration-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178952143018' + submittedAsync: 'false' + configurationDetails: + active: 'true' + description: Test notification769551 + eventConfigs: + - NotificationEventConfiguration: + eventType: ACCOUNT_HOLDER_VERIFICATION + includeMode: INCLUDE + messageFormat: SOAP + notificationId: 28467 + notifyURL: https://www.adyen.com/notification-handler + sendActionHeader: 'true' + sslProtocol: SSLInsecureCiphers post-updateNotificationConfiguration-basic: summary: Update notification configurations value: @@ -786,3 +812,23 @@ components: notifyUsername: testUserName2 sendActionHeader: false sslProtocol: TLSv10 + post-updateNotificationConfiguration-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8516178951636344' + submittedAsync: 'false' + configurationDetails: + active: 'false' + description: new description799847 + eventConfigs: + - NotificationEventConfiguration: + eventType: ACCOUNT_CREATED + includeMode: INCLUDE + - NotificationEventConfiguration: + eventType: ACCOUNT_HOLDER_CREATED + includeMode: EXCLUDE + messageFormat: JSON + notificationId: 21259 + notifyURL: http://www.adyen.com + sendActionHeader: 'false' + sslProtocol: TLSv10 diff --git a/yaml/NotificationConfigurationService-v2.yaml b/yaml/NotificationConfigurationService-v2.yaml index c0218f4..63db5ec 100644 --- a/yaml/NotificationConfigurationService-v2.yaml +++ b/yaml/NotificationConfigurationService-v2.yaml @@ -84,6 +84,9 @@ paths: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-createNotificationConfiguration-basic-200' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -341,6 +344,9 @@ paths: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic-200' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -579,6 +585,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string includeMode: description: 'Indicates whether the specified eventType is to be sent to @@ -649,6 +656,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string type: array notificationId: @@ -695,6 +703,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string type: array exchangeMessages: @@ -767,6 +776,23 @@ components: notifyPassword: testPassword sendActionHeader: true sslProtocol: SSL + post-createNotificationConfiguration-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178952143018' + submittedAsync: 'false' + configurationDetails: + active: 'true' + description: Test notification769551 + eventConfigs: + - NotificationEventConfiguration: + eventType: ACCOUNT_HOLDER_VERIFICATION + includeMode: INCLUDE + messageFormat: SOAP + notificationId: 28467 + notifyURL: https://www.adyen.com/notification-handler + sendActionHeader: 'true' + sslProtocol: SSLInsecureCiphers post-updateNotificationConfiguration-basic: summary: Update notification configurations value: @@ -786,3 +812,23 @@ components: notifyUsername: testUserName2 sendActionHeader: false sslProtocol: TLSv10 + post-updateNotificationConfiguration-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8516178951636344' + submittedAsync: 'false' + configurationDetails: + active: 'false' + description: new description799847 + eventConfigs: + - NotificationEventConfiguration: + eventType: ACCOUNT_CREATED + includeMode: INCLUDE + - NotificationEventConfiguration: + eventType: ACCOUNT_HOLDER_CREATED + includeMode: EXCLUDE + messageFormat: JSON + notificationId: 21259 + notifyURL: http://www.adyen.com + sendActionHeader: 'false' + sslProtocol: TLSv10 diff --git a/yaml/NotificationConfigurationService-v3.yaml b/yaml/NotificationConfigurationService-v3.yaml index 52aa124..b589ca5 100644 --- a/yaml/NotificationConfigurationService-v3.yaml +++ b/yaml/NotificationConfigurationService-v3.yaml @@ -84,6 +84,9 @@ paths: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-createNotificationConfiguration-basic-200' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -341,6 +344,9 @@ paths: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic-200' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -579,6 +585,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string includeMode: description: 'Indicates whether the specified eventType is to be sent to @@ -649,6 +656,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string type: array notificationId: @@ -695,6 +703,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string type: array exchangeMessages: @@ -767,6 +776,23 @@ components: notifyPassword: testPassword sendActionHeader: true sslProtocol: SSL + post-createNotificationConfiguration-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178952143018' + submittedAsync: 'false' + configurationDetails: + active: 'true' + description: Test notification769551 + eventConfigs: + - NotificationEventConfiguration: + eventType: ACCOUNT_HOLDER_VERIFICATION + includeMode: INCLUDE + messageFormat: SOAP + notificationId: 28467 + notifyURL: https://www.adyen.com/notification-handler + sendActionHeader: 'true' + sslProtocol: SSLInsecureCiphers post-updateNotificationConfiguration-basic: summary: Update notification configurations value: @@ -786,3 +812,23 @@ components: notifyUsername: testUserName2 sendActionHeader: false sslProtocol: TLSv10 + post-updateNotificationConfiguration-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8516178951636344' + submittedAsync: 'false' + configurationDetails: + active: 'false' + description: new description799847 + eventConfigs: + - NotificationEventConfiguration: + eventType: ACCOUNT_CREATED + includeMode: INCLUDE + - NotificationEventConfiguration: + eventType: ACCOUNT_HOLDER_CREATED + includeMode: EXCLUDE + messageFormat: JSON + notificationId: 21259 + notifyURL: http://www.adyen.com + sendActionHeader: 'false' + sslProtocol: TLSv10 diff --git a/yaml/NotificationConfigurationService-v4.yaml b/yaml/NotificationConfigurationService-v4.yaml index bacabbe..4c406b8 100644 --- a/yaml/NotificationConfigurationService-v4.yaml +++ b/yaml/NotificationConfigurationService-v4.yaml @@ -84,6 +84,9 @@ paths: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-createNotificationConfiguration-basic-200' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -341,6 +344,9 @@ paths: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic-200' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -579,6 +585,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string includeMode: description: 'Indicates whether the specified eventType is to be sent to @@ -649,6 +656,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string type: array notificationId: @@ -695,6 +703,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string type: array exchangeMessages: @@ -767,6 +776,23 @@ components: notifyPassword: testPassword sendActionHeader: true sslProtocol: SSL + post-createNotificationConfiguration-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178952143018' + submittedAsync: 'false' + configurationDetails: + active: 'true' + description: Test notification769551 + eventConfigs: + - NotificationEventConfiguration: + eventType: ACCOUNT_HOLDER_VERIFICATION + includeMode: INCLUDE + messageFormat: SOAP + notificationId: 28467 + notifyURL: https://www.adyen.com/notification-handler + sendActionHeader: 'true' + sslProtocol: SSLInsecureCiphers post-updateNotificationConfiguration-basic: summary: Update notification configurations value: @@ -786,3 +812,23 @@ components: notifyUsername: testUserName2 sendActionHeader: false sslProtocol: TLSv10 + post-updateNotificationConfiguration-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8516178951636344' + submittedAsync: 'false' + configurationDetails: + active: 'false' + description: new description799847 + eventConfigs: + - NotificationEventConfiguration: + eventType: ACCOUNT_CREATED + includeMode: INCLUDE + - NotificationEventConfiguration: + eventType: ACCOUNT_HOLDER_CREATED + includeMode: EXCLUDE + messageFormat: JSON + notificationId: 21259 + notifyURL: http://www.adyen.com + sendActionHeader: 'false' + sslProtocol: TLSv10 diff --git a/yaml/NotificationConfigurationService-v5.yaml b/yaml/NotificationConfigurationService-v5.yaml index 3cdcb0e..3e43dd4 100644 --- a/yaml/NotificationConfigurationService-v5.yaml +++ b/yaml/NotificationConfigurationService-v5.yaml @@ -84,6 +84,9 @@ paths: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-createNotificationConfiguration-basic-200' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -341,6 +344,9 @@ paths: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic-200' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -725,6 +731,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string includeMode: description: 'Indicates whether the specified eventType is to be sent to @@ -795,6 +802,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string type: array notificationId: @@ -841,6 +849,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string type: array exchangeMessages: @@ -906,6 +915,19 @@ components: notifyUsername: testUserName notifyPassword: testPassword sslProtocol: SSL + post-createNotificationConfiguration-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8516178952380553' + configurationDetails: + active: true + description: Unique description 123 + eventConfigs: + - eventType: ACCOUNT_HOLDER_VERIFICATION + includeMode: INCLUDE + notificationId: 28468 + notifyURL: https://www.adyen.com/notification-handler + sslProtocol: SSLInsecureCiphers post-updateNotificationConfiguration-basic: summary: Update notification configurations value: @@ -922,3 +944,18 @@ components: notifyURL: https://www.adyen.com/notification-handler notifyUsername: testUserName2 sslProtocol: TLSv10 + post-updateNotificationConfiguration-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8516178952580574' + configurationDetails: + active: false + description: Test notif config 756 + eventConfigs: + - eventType: ACCOUNT_CREATED + includeMode: INCLUDE + - eventType: ACCOUNT_HOLDER_CREATED + includeMode: EXCLUDE + notificationId: 21259 + notifyURL: https://www.adyen.com/notification-handler + sslProtocol: TLSv10 diff --git a/yaml/NotificationConfigurationService-v6.yaml b/yaml/NotificationConfigurationService-v6.yaml index ec95a9b..5469687 100644 --- a/yaml/NotificationConfigurationService-v6.yaml +++ b/yaml/NotificationConfigurationService-v6.yaml @@ -84,6 +84,9 @@ paths: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-createNotificationConfiguration-basic-200' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -341,6 +344,9 @@ paths: '200': content: application/json: + examples: + basic-200: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic-200' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. @@ -725,6 +731,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string includeMode: description: 'Indicates whether the specified eventType is to be sent to @@ -795,6 +802,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string type: array notificationId: @@ -841,6 +849,7 @@ components: - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS + - TRANSFER_NOT_PAIDOUT_TRANSFERS type: string type: array exchangeMessages: @@ -906,6 +915,19 @@ components: notifyUsername: testUserName notifyPassword: testPassword sslProtocol: SSL + post-createNotificationConfiguration-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8516178952380553' + configurationDetails: + active: true + description: Unique description 123 + eventConfigs: + - eventType: ACCOUNT_HOLDER_VERIFICATION + includeMode: INCLUDE + notificationId: 28468 + notifyURL: https://www.adyen.com/notification-handler + sslProtocol: SSLInsecureCiphers post-updateNotificationConfiguration-basic: summary: Update notification configurations value: @@ -922,3 +944,18 @@ components: notifyURL: https://www.adyen.com/notification-handler notifyUsername: testUserName2 sslProtocol: TLSv10 + post-updateNotificationConfiguration-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8516178952580574' + configurationDetails: + active: false + description: Test notif config 756 + eventConfigs: + - eventType: ACCOUNT_CREATED + includeMode: INCLUDE + - eventType: ACCOUNT_HOLDER_CREATED + includeMode: EXCLUDE + notificationId: 21259 + notifyURL: https://www.adyen.com/notification-handler + sslProtocol: TLSv10 diff --git a/yaml/PaymentService-v25.yaml b/yaml/PaymentService-v25.yaml index 54a8d0d..3b11ff6 100644 --- a/yaml/PaymentService-v25.yaml +++ b/yaml/PaymentService-v25.yaml @@ -79,17 +79,6 @@ paths: requestBody: content: application/json: - examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' - authorise-recurringoneclick: - $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -102,18 +91,12 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -132,9 +115,6 @@ paths: '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -300,6 +280,9 @@ paths: '200': content: application/json: + examples: + cancelOrRefund-200: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -373,6 +356,9 @@ paths: '200': content: application/json: + examples: + capture-200: + $ref: '#/components/examples/post-capture-capture-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -448,6 +434,9 @@ paths: '200': content: application/json: + examples: + refund-200: + $ref: '#/components/examples/post-refund-refund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -522,6 +511,11 @@ paths: '200': content: application/json: + examples: + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -2738,8 +2732,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -3021,8 +3021,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -4173,85 +4179,6 @@ components: message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' - post-authorise-authorise-3dsecure: - summary: Initiate a 3D Secure payment - value: - amount: - value: 1500 - currency: EUR - card: - number: '5212345678901234' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-card: - summary: Authorise a card payment - value: - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - amount: - value: 1500 - currency: EUR - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringcontauth: - summary: Authorise a recurring payment - value: - amount: - value: 2000 - currency: EUR - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: RECURRING - shopperInteraction: ContAuth - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringoneclick: - summary: Authorise a one-click payment - value: - amount: - value: 2000 - currency: EUR - card: - cvc: '737' - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: ONECLICK - shopperInteraction: Ecommerce - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringstore: - summary: Store card details for recurring payments - value: - amount: - value: 2000 - currency: EUR - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - recurring: - contract: RECURRING,ONECLICK - merchantAccount: YOUR_MERCHANT_ACCOUNT post-authorise3d-authorise3d: summary: Complete a 3D Secure payment value: @@ -4271,6 +4198,11 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT + post-cancelOrRefund-cancelOrRefund-200: + summary: Example response for request 'cancelOrRefund' + value: + pspReference: 851617892359708H + response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -4280,6 +4212,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-capture-capture-200: + summary: Example response for request 'capture' + value: + pspReference: 861617892359057J + response: '[capture-received]' post-refund-refund: summary: Refund a captured payment value: @@ -4289,11 +4226,21 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-refund-refund-200: + summary: Example response for request 'refund' + value: + pspReference: 861617892360059B + response: '[refund-received]' post-voidPendingRefund-voidpendingrefund-pspreference: summary: Cancel a POS refund request with PSP reference before it has been completed value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' + post-voidPendingRefund-voidpendingrefund-pspreference-200: + summary: Example response for request 'voidpendingrefund-pspreference' + value: + pspReference: 861617892360062F + response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: summary: Cancels a POS refund request with tender reference before it has been completed @@ -4301,3 +4248,8 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT tenderReference: 5Iw8001176969533005 uniqueTerminalId: VX820-123456789 + post-voidPendingRefund-voidpendingrefund-tenderreference-200: + summary: Example response for request 'voidpendingrefund-tenderreference' + value: + pspReference: 881617892360409G + response: '[voidPendingRefund-received]' diff --git a/yaml/PaymentService-v30.yaml b/yaml/PaymentService-v30.yaml index 5dd866b..fc8195e 100644 --- a/yaml/PaymentService-v30.yaml +++ b/yaml/PaymentService-v30.yaml @@ -87,6 +87,9 @@ paths: '200': content: application/json: + examples: + adjustAuthorisation-200: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -147,19 +150,6 @@ paths: requestBody: content: application/json: - examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' - authorise-recurringoneclick: - $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -172,18 +162,12 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -202,9 +186,6 @@ paths: '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -370,6 +351,9 @@ paths: '200': content: application/json: + examples: + cancelOrRefund-200: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -443,6 +427,9 @@ paths: '200': content: application/json: + examples: + capture-200: + $ref: '#/components/examples/post-capture-capture-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -518,6 +505,9 @@ paths: '200': content: application/json: + examples: + refund-200: + $ref: '#/components/examples/post-refund-refund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -588,6 +578,9 @@ paths: '200': content: application/json: + examples: + technicalCancel-200: + $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -662,6 +655,11 @@ paths: '200': content: application/json: + examples: + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -2963,8 +2961,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -3263,8 +3267,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -4510,112 +4520,11 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-3dsecure: - summary: Initiate a 3D Secure payment + post-adjustAuthorisation-adjustAuthorisation-200: + summary: Example response for request 'adjustAuthorisation' value: - amount: - value: 1500 - currency: EUR - card: - number: '5212345678901234' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-card: - summary: Authorise a card payment - value: - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - amount: - value: 1500 - currency: EUR - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringcontauth: - summary: Authorise a recurring payment - value: - amount: - value: 2000 - currency: EUR - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: RECURRING - shopperInteraction: ContAuth - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringoneclick: - summary: Authorise a one-click payment - value: - amount: - value: 2000 - currency: EUR - card: - cvc: '737' - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: ONECLICK - shopperInteraction: Ecommerce - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringstore: - summary: Store card details for recurring payments - value: - amount: - value: 2000 - currency: EUR - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - recurring: - contract: RECURRING,ONECLICK - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-split: - summary: Split a payment between a sub-merchant and a platform account - value: - card: - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - additionalData: - split.api: '1' - split.nrOfItems: '2' - split.totalAmount: '6200' - split.currencyCode: EUR - split.item1.amount: '6000' - split.item1.type: MarketPlace - split.item1.account: '151272963' - split.item1.reference: '6124145' - split.item1.description: 'Porcelain Doll: Eliza (20cm)' - split.item2.amount: '200' - split.item2.type: Commission - split.item2.reference: '6124146' - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT + pspReference: 851617892360718D + response: '[adjustAuthorisation-received]' post-authorise3d-authorise3d: summary: Complete a 3D Secure payment value: @@ -4635,6 +4544,11 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT + post-cancelOrRefund-cancelOrRefund-200: + summary: Example response for request 'cancelOrRefund' + value: + pspReference: 851617892359708H + response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -4644,6 +4558,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-capture-capture-200: + summary: Example response for request 'capture' + value: + pspReference: 861617892359057J + response: '[capture-received]' post-refund-refund: summary: Refund a captured payment value: @@ -4653,17 +4572,32 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-refund-refund-200: + summary: Example response for request 'refund' + value: + pspReference: 861617892360059B + response: '[refund-received]' post-technicalCancel-technicalCancel: summary: Cancel a payment without a PSP reference value: originalMerchantReference: YOUR_MERCHANT_REFERENCE reference: YOUR_MODIFICATION_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-technicalCancel-technicalCancel-200: + summary: Example response for request 'technicalCancel' + value: + pspReference: 881617892361436J + response: '[technical-cancel-received]' post-voidPendingRefund-voidpendingrefund-pspreference: summary: Cancel a POS refund request with PSP reference before it has been completed value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' + post-voidPendingRefund-voidpendingrefund-pspreference-200: + summary: Example response for request 'voidpendingrefund-pspreference' + value: + pspReference: 861617892360062F + response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: summary: Cancels a POS refund request with tender reference before it has been completed @@ -4671,3 +4605,8 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT tenderReference: 5Iw8001176969533005 uniqueTerminalId: VX820-123456789 + post-voidPendingRefund-voidpendingrefund-tenderreference-200: + summary: Example response for request 'voidpendingrefund-tenderreference' + value: + pspReference: 881617892360409G + response: '[voidPendingRefund-received]' diff --git a/yaml/PaymentService-v40.yaml b/yaml/PaymentService-v40.yaml index 92e390d..3b0dd44 100644 --- a/yaml/PaymentService-v40.yaml +++ b/yaml/PaymentService-v40.yaml @@ -87,6 +87,9 @@ paths: '200': content: application/json: + examples: + adjustAuthorisation-200: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -147,21 +150,6 @@ paths: requestBody: content: application/json: - examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' - authorise-3d-secure-2: - $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' - authorise-recurringoneclick: - $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -174,18 +162,12 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -204,9 +186,6 @@ paths: '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -442,6 +421,9 @@ paths: '200': content: application/json: + examples: + cancelOrRefund-200: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -515,6 +497,9 @@ paths: '200': content: application/json: + examples: + capture-200: + $ref: '#/components/examples/post-capture-capture-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -573,9 +558,6 @@ paths: requestBody: content: application/json: - examples: - donate: - $ref: '#/components/examples/post-donate-donate' schema: $ref: '#/components/schemas/DonationRequest' responses: @@ -588,9 +570,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -657,6 +636,9 @@ paths: '200': content: application/json: + examples: + refund-200: + $ref: '#/components/examples/post-refund-refund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -791,6 +773,9 @@ paths: '200': content: application/json: + examples: + technicalCancel-200: + $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -865,6 +850,11 @@ paths: '200': content: application/json: + examples: + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -3622,8 +3612,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -3959,8 +3955,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -4288,8 +4290,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -5412,11 +5420,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -5848,148 +5856,11 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-3d-secure-2: - summary: Make a card payment with 3D Secure 2 native authentication + post-adjustAuthorisation-adjustAuthorisation-200: + summary: Example response for request 'adjustAuthorisation' value: - amount: - currency: USD - value: 1500 - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: YOUR_REFERENCE_NUMBER - threeDS2RequestData: - deviceChannel: browser - notificationURL: https://www.example.com/YOUR_3DS_NOTIFICATION_URL - browserInfo: - userAgent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 - (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8 - language: en - colorDepth: 24 - screenHeight: 723 - screenWidth: 1536 - timeZoneOffset: 0 - javaEnabled: false - billingAddress: - country: US - city: New York - street: Redwood Block - houseNumberOrName: 37C - stateOrProvince: NY - postalCode: '10039' - accountInfo: - accountCreationDate: '2019-01-17T13:42:40+01:00' - shopperEmail: s.hopper@test.com - shopperIP: 192.0.2.1 - card: - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - number: '4917610000000000' - post-authorise-authorise-3dsecure: - summary: Initiate a 3D Secure payment - value: - amount: - value: 1500 - currency: EUR - card: - number: '5212345678901234' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-card: - summary: Authorise a card payment - value: - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - amount: - value: 1500 - currency: EUR - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringcontauth: - summary: Authorise a recurring payment - value: - amount: - value: 2000 - currency: EUR - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: RECURRING - shopperInteraction: ContAuth - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringoneclick: - summary: Authorise a one-click payment - value: - amount: - value: 2000 - currency: EUR - card: - cvc: '737' - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: ONECLICK - shopperInteraction: Ecommerce - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringstore: - summary: Store card details for recurring payments - value: - amount: - value: 2000 - currency: EUR - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - recurring: - contract: RECURRING,ONECLICK - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-split: - summary: Split a payment between a sub-merchant and a platform account - value: - card: - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' + pspReference: 851617892360718D + response: '[adjustAuthorisation-received]' post-authorise3d-authorise3d: summary: Complete a 3D Secure payment value: @@ -6016,6 +5887,11 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT + post-cancelOrRefund-cancelOrRefund-200: + summary: Example response for request 'cancelOrRefund' + value: + pspReference: 851617892359708H + response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -6025,16 +5901,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-donate-donate: - summary: Create a payment for the specified donation + post-capture-capture-200: + summary: Example response for request 'capture' value: - originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE - modificationAmount: - value: 500 - currency: EUR - reference: YOUR_DONATION_REFERENCE - donationAccount: AdyenGivingDemo - merchantAccount: YOUR_MERCHANT_ACCOUNT + pspReference: 861617892359057J + response: '[capture-received]' post-refund-refund: summary: Refund a captured payment value: @@ -6044,6 +5915,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-refund-refund-200: + summary: Example response for request 'refund' + value: + pspReference: 861617892360059B + response: '[refund-received]' post-retrieve3ds2Result-retrieve3ds2Result: summary: Retrieve authentication details after doing a 3D Secure 2 authentication only @@ -6056,11 +5932,21 @@ components: originalMerchantReference: YOUR_MERCHANT_REFERENCE reference: YOUR_MODIFICATION_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-technicalCancel-technicalCancel-200: + summary: Example response for request 'technicalCancel' + value: + pspReference: 881617892361436J + response: '[technical-cancel-received]' post-voidPendingRefund-voidpendingrefund-pspreference: summary: Cancel a POS refund request with PSP reference before it has been completed value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' + post-voidPendingRefund-voidpendingrefund-pspreference-200: + summary: Example response for request 'voidpendingrefund-pspreference' + value: + pspReference: 861617892360062F + response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: summary: Cancels a POS refund request with tender reference before it has been completed @@ -6068,3 +5954,8 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT tenderReference: 5Iw8001176969533005 uniqueTerminalId: VX820-123456789 + post-voidPendingRefund-voidpendingrefund-tenderreference-200: + summary: Example response for request 'voidpendingrefund-tenderreference' + value: + pspReference: 881617892360409G + response: '[voidPendingRefund-received]' diff --git a/yaml/PaymentService-v46.yaml b/yaml/PaymentService-v46.yaml index 2a7c5ac..13aa7d9 100644 --- a/yaml/PaymentService-v46.yaml +++ b/yaml/PaymentService-v46.yaml @@ -87,6 +87,9 @@ paths: '200': content: application/json: + examples: + adjustAuthorisation-200: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -147,21 +150,6 @@ paths: requestBody: content: application/json: - examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' - authorise-3d-secure-2: - $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' - authorise-recurringoneclick: - $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -174,18 +162,12 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -204,9 +186,6 @@ paths: '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -442,6 +421,9 @@ paths: '200': content: application/json: + examples: + cancelOrRefund-200: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -515,6 +497,9 @@ paths: '200': content: application/json: + examples: + capture-200: + $ref: '#/components/examples/post-capture-capture-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -573,9 +558,6 @@ paths: requestBody: content: application/json: - examples: - donate: - $ref: '#/components/examples/post-donate-donate' schema: $ref: '#/components/schemas/DonationRequest' responses: @@ -588,9 +570,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -657,6 +636,9 @@ paths: '200': content: application/json: + examples: + refund-200: + $ref: '#/components/examples/post-refund-refund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -791,6 +773,9 @@ paths: '200': content: application/json: + examples: + technicalCancel-200: + $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -865,6 +850,11 @@ paths: '200': content: application/json: + examples: + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -3642,8 +3632,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -3979,8 +3975,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -4308,8 +4310,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -5445,11 +5453,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -5891,148 +5899,11 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-3d-secure-2: - summary: Make a card payment with 3D Secure 2 native authentication + post-adjustAuthorisation-adjustAuthorisation-200: + summary: Example response for request 'adjustAuthorisation' value: - amount: - currency: USD - value: 1500 - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: YOUR_REFERENCE_NUMBER - threeDS2RequestData: - deviceChannel: browser - notificationURL: https://www.example.com/YOUR_3DS_NOTIFICATION_URL - browserInfo: - userAgent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 - (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8 - language: en - colorDepth: 24 - screenHeight: 723 - screenWidth: 1536 - timeZoneOffset: 0 - javaEnabled: false - billingAddress: - country: US - city: New York - street: Redwood Block - houseNumberOrName: 37C - stateOrProvince: NY - postalCode: '10039' - accountInfo: - accountCreationDate: '2019-01-17T13:42:40+01:00' - shopperEmail: s.hopper@test.com - shopperIP: 192.0.2.1 - card: - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - number: '4917610000000000' - post-authorise-authorise-3dsecure: - summary: Initiate a 3D Secure payment - value: - amount: - value: 1500 - currency: EUR - card: - number: '5212345678901234' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-card: - summary: Authorise a card payment - value: - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - amount: - value: 1500 - currency: EUR - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringcontauth: - summary: Authorise a recurring payment - value: - amount: - value: 2000 - currency: EUR - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: RECURRING - shopperInteraction: ContAuth - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringoneclick: - summary: Authorise a one-click payment - value: - amount: - value: 2000 - currency: EUR - card: - cvc: '737' - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: ONECLICK - shopperInteraction: Ecommerce - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringstore: - summary: Store card details for recurring payments - value: - amount: - value: 2000 - currency: EUR - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - recurring: - contract: RECURRING,ONECLICK - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-split: - summary: Split a payment between a sub-merchant and a platform account - value: - card: - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' + pspReference: 851617892360718D + response: '[adjustAuthorisation-received]' post-authorise3d-authorise3d: summary: Complete a 3D Secure payment value: @@ -6059,6 +5930,11 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT + post-cancelOrRefund-cancelOrRefund-200: + summary: Example response for request 'cancelOrRefund' + value: + pspReference: 851617892359708H + response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -6068,16 +5944,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-donate-donate: - summary: Create a payment for the specified donation + post-capture-capture-200: + summary: Example response for request 'capture' value: - originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE - modificationAmount: - value: 500 - currency: EUR - reference: YOUR_DONATION_REFERENCE - donationAccount: AdyenGivingDemo - merchantAccount: YOUR_MERCHANT_ACCOUNT + pspReference: 861617892359057J + response: '[capture-received]' post-refund-refund: summary: Refund a captured payment value: @@ -6087,6 +5958,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-refund-refund-200: + summary: Example response for request 'refund' + value: + pspReference: 861617892360059B + response: '[refund-received]' post-retrieve3ds2Result-retrieve3ds2Result: summary: Retrieve authentication details after doing a 3D Secure 2 authentication only @@ -6099,11 +5975,21 @@ components: originalMerchantReference: YOUR_MERCHANT_REFERENCE reference: YOUR_MODIFICATION_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-technicalCancel-technicalCancel-200: + summary: Example response for request 'technicalCancel' + value: + pspReference: 881617892361436J + response: '[technical-cancel-received]' post-voidPendingRefund-voidpendingrefund-pspreference: summary: Cancel a POS refund request with PSP reference before it has been completed value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' + post-voidPendingRefund-voidpendingrefund-pspreference-200: + summary: Example response for request 'voidpendingrefund-pspreference' + value: + pspReference: 861617892360062F + response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: summary: Cancels a POS refund request with tender reference before it has been completed @@ -6111,3 +5997,8 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT tenderReference: 5Iw8001176969533005 uniqueTerminalId: VX820-123456789 + post-voidPendingRefund-voidpendingrefund-tenderreference-200: + summary: Example response for request 'voidpendingrefund-tenderreference' + value: + pspReference: 881617892360409G + response: '[voidPendingRefund-received]' diff --git a/yaml/PaymentService-v49.yaml b/yaml/PaymentService-v49.yaml index abd71c6..a0794c7 100644 --- a/yaml/PaymentService-v49.yaml +++ b/yaml/PaymentService-v49.yaml @@ -87,6 +87,9 @@ paths: '200': content: application/json: + examples: + adjustAuthorisation-200: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -147,21 +150,6 @@ paths: requestBody: content: application/json: - examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' - authorise-3d-secure-2: - $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' - authorise-recurringoneclick: - $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -174,18 +162,12 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -204,9 +186,6 @@ paths: '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -442,6 +421,9 @@ paths: '200': content: application/json: + examples: + cancelOrRefund-200: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -515,6 +497,9 @@ paths: '200': content: application/json: + examples: + capture-200: + $ref: '#/components/examples/post-capture-capture-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -573,9 +558,6 @@ paths: requestBody: content: application/json: - examples: - donate: - $ref: '#/components/examples/post-donate-donate' schema: $ref: '#/components/schemas/DonationRequest' responses: @@ -588,9 +570,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -657,6 +636,9 @@ paths: '200': content: application/json: + examples: + refund-200: + $ref: '#/components/examples/post-refund-refund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -791,6 +773,9 @@ paths: '200': content: application/json: + examples: + technicalCancel-200: + $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -865,6 +850,11 @@ paths: '200': content: application/json: + examples: + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -3642,8 +3632,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -3979,8 +3975,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -4308,8 +4310,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -5445,11 +5453,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -5935,148 +5943,11 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-3d-secure-2: - summary: Make a card payment with 3D Secure 2 native authentication + post-adjustAuthorisation-adjustAuthorisation-200: + summary: Example response for request 'adjustAuthorisation' value: - amount: - currency: USD - value: 1500 - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: YOUR_REFERENCE_NUMBER - threeDS2RequestData: - deviceChannel: browser - notificationURL: https://www.example.com/YOUR_3DS_NOTIFICATION_URL - browserInfo: - userAgent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 - (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8 - language: en - colorDepth: 24 - screenHeight: 723 - screenWidth: 1536 - timeZoneOffset: 0 - javaEnabled: false - billingAddress: - country: US - city: New York - street: Redwood Block - houseNumberOrName: 37C - stateOrProvince: NY - postalCode: '10039' - accountInfo: - accountCreationDate: '2019-01-17T13:42:40+01:00' - shopperEmail: s.hopper@test.com - shopperIP: 192.0.2.1 - card: - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - number: '4917610000000000' - post-authorise-authorise-3dsecure: - summary: Initiate a 3D Secure payment - value: - amount: - value: 1500 - currency: EUR - card: - number: '5212345678901234' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-card: - summary: Authorise a card payment - value: - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - amount: - value: 1500 - currency: EUR - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringcontauth: - summary: Authorise a recurring payment - value: - amount: - value: 2000 - currency: EUR - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: RECURRING - shopperInteraction: ContAuth - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringoneclick: - summary: Authorise a one-click payment - value: - amount: - value: 2000 - currency: EUR - card: - cvc: '737' - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: ONECLICK - shopperInteraction: Ecommerce - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringstore: - summary: Store card details for recurring payments - value: - amount: - value: 2000 - currency: EUR - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - recurring: - contract: RECURRING,ONECLICK - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-split: - summary: Split a payment between a sub-merchant and a platform account - value: - card: - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' + pspReference: 851617892360718D + response: '[adjustAuthorisation-received]' post-authorise3d-authorise3d: summary: Complete a 3D Secure payment value: @@ -6103,6 +5974,11 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT + post-cancelOrRefund-cancelOrRefund-200: + summary: Example response for request 'cancelOrRefund' + value: + pspReference: 851617892359708H + response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -6112,16 +5988,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-donate-donate: - summary: Create a payment for the specified donation + post-capture-capture-200: + summary: Example response for request 'capture' value: - originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE - modificationAmount: - value: 500 - currency: EUR - reference: YOUR_DONATION_REFERENCE - donationAccount: AdyenGivingDemo - merchantAccount: YOUR_MERCHANT_ACCOUNT + pspReference: 861617892359057J + response: '[capture-received]' post-refund-refund: summary: Refund a captured payment value: @@ -6131,6 +6002,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-refund-refund-200: + summary: Example response for request 'refund' + value: + pspReference: 861617892360059B + response: '[refund-received]' post-retrieve3ds2Result-retrieve3ds2Result: summary: Retrieve authentication details after doing a 3D Secure 2 authentication only @@ -6143,11 +6019,21 @@ components: originalMerchantReference: YOUR_MERCHANT_REFERENCE reference: YOUR_MODIFICATION_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-technicalCancel-technicalCancel-200: + summary: Example response for request 'technicalCancel' + value: + pspReference: 881617892361436J + response: '[technical-cancel-received]' post-voidPendingRefund-voidpendingrefund-pspreference: summary: Cancel a POS refund request with PSP reference before it has been completed value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' + post-voidPendingRefund-voidpendingrefund-pspreference-200: + summary: Example response for request 'voidpendingrefund-pspreference' + value: + pspReference: 861617892360062F + response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: summary: Cancels a POS refund request with tender reference before it has been completed @@ -6155,3 +6041,8 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT tenderReference: 5Iw8001176969533005 uniqueTerminalId: VX820-123456789 + post-voidPendingRefund-voidpendingrefund-tenderreference-200: + summary: Example response for request 'voidpendingrefund-tenderreference' + value: + pspReference: 881617892360409G + response: '[voidPendingRefund-received]' diff --git a/yaml/PaymentService-v50.yaml b/yaml/PaymentService-v50.yaml index 292cac6..0743038 100644 --- a/yaml/PaymentService-v50.yaml +++ b/yaml/PaymentService-v50.yaml @@ -87,6 +87,9 @@ paths: '200': content: application/json: + examples: + adjustAuthorisation-200: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -147,21 +150,6 @@ paths: requestBody: content: application/json: - examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' - authorise-3d-secure-2: - $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' - authorise-recurringoneclick: - $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -174,18 +162,12 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -204,9 +186,6 @@ paths: '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -442,6 +421,9 @@ paths: '200': content: application/json: + examples: + cancelOrRefund-200: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -515,6 +497,9 @@ paths: '200': content: application/json: + examples: + capture-200: + $ref: '#/components/examples/post-capture-capture-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -573,9 +558,6 @@ paths: requestBody: content: application/json: - examples: - donate: - $ref: '#/components/examples/post-donate-donate' schema: $ref: '#/components/schemas/DonationRequest' responses: @@ -588,9 +570,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -657,6 +636,9 @@ paths: '200': content: application/json: + examples: + refund-200: + $ref: '#/components/examples/post-refund-refund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -791,6 +773,9 @@ paths: '200': content: application/json: + examples: + technicalCancel-200: + $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -865,6 +850,11 @@ paths: '200': content: application/json: + examples: + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -3659,8 +3649,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -4002,8 +3998,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -4337,8 +4339,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -5480,11 +5488,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -5988,148 +5996,11 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-3d-secure-2: - summary: Make a card payment with 3D Secure 2 native authentication + post-adjustAuthorisation-adjustAuthorisation-200: + summary: Example response for request 'adjustAuthorisation' value: - amount: - currency: USD - value: 1500 - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: YOUR_REFERENCE_NUMBER - threeDS2RequestData: - deviceChannel: browser - notificationURL: https://www.example.com/YOUR_3DS_NOTIFICATION_URL - browserInfo: - userAgent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 - (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8 - language: en - colorDepth: 24 - screenHeight: 723 - screenWidth: 1536 - timeZoneOffset: 0 - javaEnabled: false - billingAddress: - country: US - city: New York - street: Redwood Block - houseNumberOrName: 37C - stateOrProvince: NY - postalCode: '10039' - accountInfo: - accountCreationDate: '2019-01-17T13:42:40+01:00' - shopperEmail: s.hopper@test.com - shopperIP: 192.0.2.1 - card: - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - number: '4917610000000000' - post-authorise-authorise-3dsecure: - summary: Initiate a 3D Secure payment - value: - amount: - value: 1500 - currency: EUR - card: - number: '5212345678901234' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-card: - summary: Authorise a card payment - value: - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - amount: - value: 1500 - currency: EUR - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringcontauth: - summary: Authorise a recurring payment - value: - amount: - value: 2000 - currency: EUR - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: RECURRING - shopperInteraction: ContAuth - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringoneclick: - summary: Authorise a one-click payment - value: - amount: - value: 2000 - currency: EUR - card: - cvc: '737' - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: ONECLICK - shopperInteraction: Ecommerce - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringstore: - summary: Store card details for recurring payments - value: - amount: - value: 2000 - currency: EUR - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - recurring: - contract: RECURRING,ONECLICK - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-split: - summary: Split a payment between a sub-merchant and a platform account - value: - card: - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' + pspReference: 851617892360718D + response: '[adjustAuthorisation-received]' post-authorise3d-authorise3d: summary: Complete a 3D Secure payment value: @@ -6156,6 +6027,11 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT + post-cancelOrRefund-cancelOrRefund-200: + summary: Example response for request 'cancelOrRefund' + value: + pspReference: 851617892359708H + response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -6165,16 +6041,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-donate-donate: - summary: Create a payment for the specified donation + post-capture-capture-200: + summary: Example response for request 'capture' value: - originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE - modificationAmount: - value: 500 - currency: EUR - reference: YOUR_DONATION_REFERENCE - donationAccount: AdyenGivingDemo - merchantAccount: YOUR_MERCHANT_ACCOUNT + pspReference: 861617892359057J + response: '[capture-received]' post-refund-refund: summary: Refund a captured payment value: @@ -6184,6 +6055,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-refund-refund-200: + summary: Example response for request 'refund' + value: + pspReference: 861617892360059B + response: '[refund-received]' post-retrieve3ds2Result-retrieve3ds2Result: summary: Retrieve authentication details after doing a 3D Secure 2 authentication only @@ -6196,11 +6072,21 @@ components: originalMerchantReference: YOUR_MERCHANT_REFERENCE reference: YOUR_MODIFICATION_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-technicalCancel-technicalCancel-200: + summary: Example response for request 'technicalCancel' + value: + pspReference: 881617892361436J + response: '[technical-cancel-received]' post-voidPendingRefund-voidpendingrefund-pspreference: summary: Cancel a POS refund request with PSP reference before it has been completed value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' + post-voidPendingRefund-voidpendingrefund-pspreference-200: + summary: Example response for request 'voidpendingrefund-pspreference' + value: + pspReference: 861617892360062F + response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: summary: Cancels a POS refund request with tender reference before it has been completed @@ -6208,3 +6094,8 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT tenderReference: 5Iw8001176969533005 uniqueTerminalId: VX820-123456789 + post-voidPendingRefund-voidpendingrefund-tenderreference-200: + summary: Example response for request 'voidpendingrefund-tenderreference' + value: + pspReference: 881617892360409G + response: '[voidPendingRefund-received]' diff --git a/yaml/PaymentService-v51.yaml b/yaml/PaymentService-v51.yaml index 11c5ddc..963d270 100644 --- a/yaml/PaymentService-v51.yaml +++ b/yaml/PaymentService-v51.yaml @@ -87,6 +87,9 @@ paths: '200': content: application/json: + examples: + adjustAuthorisation-200: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -147,21 +150,6 @@ paths: requestBody: content: application/json: - examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' - authorise-3d-secure-2: - $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' - authorise-recurringoneclick: - $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -174,18 +162,12 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -204,9 +186,6 @@ paths: '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -442,6 +421,9 @@ paths: '200': content: application/json: + examples: + cancelOrRefund-200: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -515,6 +497,9 @@ paths: '200': content: application/json: + examples: + capture-200: + $ref: '#/components/examples/post-capture-capture-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -573,9 +558,6 @@ paths: requestBody: content: application/json: - examples: - donate: - $ref: '#/components/examples/post-donate-donate' schema: $ref: '#/components/schemas/DonationRequest' responses: @@ -588,9 +570,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -637,9 +616,6 @@ paths: requestBody: content: application/json: - examples: - getAuthenticationResult: - $ref: '#/components/examples/post-getAuthenticationResult-getAuthenticationResult' schema: $ref: '#/components/schemas/AuthenticationResultRequest' responses: @@ -652,9 +628,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -721,6 +694,9 @@ paths: '200': content: application/json: + examples: + refund-200: + $ref: '#/components/examples/post-refund-refund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -855,6 +831,9 @@ paths: '200': content: application/json: + examples: + technicalCancel-200: + $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -929,6 +908,11 @@ paths: '200': content: application/json: + examples: + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -3749,8 +3733,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -4098,8 +4088,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -4439,8 +4435,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -5582,11 +5584,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -6111,148 +6113,11 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-3d-secure-2: - summary: Make a card payment with 3D Secure 2 native authentication + post-adjustAuthorisation-adjustAuthorisation-200: + summary: Example response for request 'adjustAuthorisation' value: - amount: - currency: USD - value: 1500 - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: YOUR_REFERENCE_NUMBER - threeDS2RequestData: - deviceChannel: browser - notificationURL: https://www.example.com/YOUR_3DS_NOTIFICATION_URL - browserInfo: - userAgent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 - (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8 - language: en - colorDepth: 24 - screenHeight: 723 - screenWidth: 1536 - timeZoneOffset: 0 - javaEnabled: false - billingAddress: - country: US - city: New York - street: Redwood Block - houseNumberOrName: 37C - stateOrProvince: NY - postalCode: '10039' - accountInfo: - accountCreationDate: '2019-01-17T13:42:40+01:00' - shopperEmail: s.hopper@test.com - shopperIP: 192.0.2.1 - card: - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - number: '4917610000000000' - post-authorise-authorise-3dsecure: - summary: Initiate a 3D Secure payment - value: - amount: - value: 1500 - currency: EUR - card: - number: '5212345678901234' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-card: - summary: Authorise a card payment - value: - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - amount: - value: 1500 - currency: EUR - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringcontauth: - summary: Authorise a recurring payment - value: - amount: - value: 2000 - currency: EUR - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: RECURRING - shopperInteraction: ContAuth - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringoneclick: - summary: Authorise a one-click payment - value: - amount: - value: 2000 - currency: EUR - card: - cvc: '737' - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: ONECLICK - shopperInteraction: Ecommerce - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringstore: - summary: Store card details for recurring payments - value: - amount: - value: 2000 - currency: EUR - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - recurring: - contract: RECURRING,ONECLICK - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-split: - summary: Split a payment between a sub-merchant and a platform account - value: - card: - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' + pspReference: 851617892360718D + response: '[adjustAuthorisation-received]' post-authorise3d-authorise3d: summary: Complete a 3D Secure payment value: @@ -6279,6 +6144,11 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT + post-cancelOrRefund-cancelOrRefund-200: + summary: Example response for request 'cancelOrRefund' + value: + pspReference: 851617892359708H + response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -6288,22 +6158,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-donate-donate: - summary: Create a payment for the specified donation + post-capture-capture-200: + summary: Example response for request 'capture' value: - originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE - modificationAmount: - value: 500 - currency: EUR - reference: YOUR_DONATION_REFERENCE - donationAccount: AdyenGivingDemo - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-getAuthenticationResult-getAuthenticationResult: - summary: Retrieve the authentication result after doing a 3D Secure authentication - only - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - pspReference: '9935272408535455' + pspReference: 861617892359057J + response: '[capture-received]' post-refund-refund: summary: Refund a captured payment value: @@ -6313,6 +6172,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-refund-refund-200: + summary: Example response for request 'refund' + value: + pspReference: 861617892360059B + response: '[refund-received]' post-retrieve3ds2Result-retrieve3ds2Result: summary: Retrieve authentication details after doing a 3D Secure 2 authentication only @@ -6325,11 +6189,21 @@ components: originalMerchantReference: YOUR_MERCHANT_REFERENCE reference: YOUR_MODIFICATION_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-technicalCancel-technicalCancel-200: + summary: Example response for request 'technicalCancel' + value: + pspReference: 881617892361436J + response: '[technical-cancel-received]' post-voidPendingRefund-voidpendingrefund-pspreference: summary: Cancel a POS refund request with PSP reference before it has been completed value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' + post-voidPendingRefund-voidpendingrefund-pspreference-200: + summary: Example response for request 'voidpendingrefund-pspreference' + value: + pspReference: 861617892360062F + response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: summary: Cancels a POS refund request with tender reference before it has been completed @@ -6337,3 +6211,8 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT tenderReference: 5Iw8001176969533005 uniqueTerminalId: VX820-123456789 + post-voidPendingRefund-voidpendingrefund-tenderreference-200: + summary: Example response for request 'voidpendingrefund-tenderreference' + value: + pspReference: 881617892360409G + response: '[voidPendingRefund-received]' diff --git a/yaml/PaymentService-v52.yaml b/yaml/PaymentService-v52.yaml index 96248ed..82ad229 100644 --- a/yaml/PaymentService-v52.yaml +++ b/yaml/PaymentService-v52.yaml @@ -87,6 +87,9 @@ paths: '200': content: application/json: + examples: + adjustAuthorisation-200: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -147,21 +150,6 @@ paths: requestBody: content: application/json: - examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' - authorise-3d-secure-2: - $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' - authorise-recurringoneclick: - $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -174,18 +162,12 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -204,9 +186,6 @@ paths: '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -442,6 +421,9 @@ paths: '200': content: application/json: + examples: + cancelOrRefund-200: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -515,6 +497,9 @@ paths: '200': content: application/json: + examples: + capture-200: + $ref: '#/components/examples/post-capture-capture-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -573,9 +558,6 @@ paths: requestBody: content: application/json: - examples: - donate: - $ref: '#/components/examples/post-donate-donate' schema: $ref: '#/components/schemas/DonationRequest' responses: @@ -588,9 +570,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -637,9 +616,6 @@ paths: requestBody: content: application/json: - examples: - getAuthenticationResult: - $ref: '#/components/examples/post-getAuthenticationResult-getAuthenticationResult' schema: $ref: '#/components/schemas/AuthenticationResultRequest' responses: @@ -652,9 +628,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -721,6 +694,9 @@ paths: '200': content: application/json: + examples: + refund-200: + $ref: '#/components/examples/post-refund-refund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -855,6 +831,9 @@ paths: '200': content: application/json: + examples: + technicalCancel-200: + $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -929,6 +908,11 @@ paths: '200': content: application/json: + examples: + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -3757,8 +3741,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -4106,8 +4096,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -4447,8 +4443,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -5590,11 +5592,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -6119,148 +6121,11 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-3d-secure-2: - summary: Make a card payment with 3D Secure 2 native authentication + post-adjustAuthorisation-adjustAuthorisation-200: + summary: Example response for request 'adjustAuthorisation' value: - amount: - currency: USD - value: 1500 - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: YOUR_REFERENCE_NUMBER - threeDS2RequestData: - deviceChannel: browser - notificationURL: https://www.example.com/YOUR_3DS_NOTIFICATION_URL - browserInfo: - userAgent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 - (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8 - language: en - colorDepth: 24 - screenHeight: 723 - screenWidth: 1536 - timeZoneOffset: 0 - javaEnabled: false - billingAddress: - country: US - city: New York - street: Redwood Block - houseNumberOrName: 37C - stateOrProvince: NY - postalCode: '10039' - accountInfo: - accountCreationDate: '2019-01-17T13:42:40+01:00' - shopperEmail: s.hopper@test.com - shopperIP: 192.0.2.1 - card: - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - number: '4917610000000000' - post-authorise-authorise-3dsecure: - summary: Initiate a 3D Secure payment - value: - amount: - value: 1500 - currency: EUR - card: - number: '5212345678901234' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-card: - summary: Authorise a card payment - value: - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - amount: - value: 1500 - currency: EUR - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringcontauth: - summary: Authorise a recurring payment - value: - amount: - value: 2000 - currency: EUR - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: RECURRING - shopperInteraction: ContAuth - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringoneclick: - summary: Authorise a one-click payment - value: - amount: - value: 2000 - currency: EUR - card: - cvc: '737' - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: ONECLICK - shopperInteraction: Ecommerce - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringstore: - summary: Store card details for recurring payments - value: - amount: - value: 2000 - currency: EUR - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - recurring: - contract: RECURRING,ONECLICK - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-split: - summary: Split a payment between a sub-merchant and a platform account - value: - card: - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' + pspReference: 851617892360718D + response: '[adjustAuthorisation-received]' post-authorise3d-authorise3d: summary: Complete a 3D Secure payment value: @@ -6287,6 +6152,11 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT + post-cancelOrRefund-cancelOrRefund-200: + summary: Example response for request 'cancelOrRefund' + value: + pspReference: 851617892359708H + response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -6296,22 +6166,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-donate-donate: - summary: Create a payment for the specified donation + post-capture-capture-200: + summary: Example response for request 'capture' value: - originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE - modificationAmount: - value: 500 - currency: EUR - reference: YOUR_DONATION_REFERENCE - donationAccount: AdyenGivingDemo - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-getAuthenticationResult-getAuthenticationResult: - summary: Retrieve the authentication result after doing a 3D Secure authentication - only - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - pspReference: '9935272408535455' + pspReference: 861617892359057J + response: '[capture-received]' post-refund-refund: summary: Refund a captured payment value: @@ -6321,6 +6180,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-refund-refund-200: + summary: Example response for request 'refund' + value: + pspReference: 861617892360059B + response: '[refund-received]' post-retrieve3ds2Result-retrieve3ds2Result: summary: Retrieve authentication details after doing a 3D Secure 2 authentication only @@ -6333,11 +6197,21 @@ components: originalMerchantReference: YOUR_MERCHANT_REFERENCE reference: YOUR_MODIFICATION_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-technicalCancel-technicalCancel-200: + summary: Example response for request 'technicalCancel' + value: + pspReference: 881617892361436J + response: '[technical-cancel-received]' post-voidPendingRefund-voidpendingrefund-pspreference: summary: Cancel a POS refund request with PSP reference before it has been completed value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' + post-voidPendingRefund-voidpendingrefund-pspreference-200: + summary: Example response for request 'voidpendingrefund-pspreference' + value: + pspReference: 861617892360062F + response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: summary: Cancels a POS refund request with tender reference before it has been completed @@ -6345,3 +6219,8 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT tenderReference: 5Iw8001176969533005 uniqueTerminalId: VX820-123456789 + post-voidPendingRefund-voidpendingrefund-tenderreference-200: + summary: Example response for request 'voidpendingrefund-tenderreference' + value: + pspReference: 881617892360409G + response: '[voidPendingRefund-received]' diff --git a/yaml/PaymentService-v64.yaml b/yaml/PaymentService-v64.yaml index ea5c187..becc3a8 100644 --- a/yaml/PaymentService-v64.yaml +++ b/yaml/PaymentService-v64.yaml @@ -87,6 +87,9 @@ paths: '200': content: application/json: + examples: + adjustAuthorisation-200: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -147,21 +150,6 @@ paths: requestBody: content: application/json: - examples: - authorise-recurringcontauth: - $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' - authorise-card: - $ref: '#/components/examples/post-authorise-authorise-card' - authorise-split: - $ref: '#/components/examples/post-authorise-authorise-split' - authorise-3dsecure: - $ref: '#/components/examples/post-authorise-authorise-3dsecure' - authorise-3d-secure-2: - $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' - authorise-recurringstore: - $ref: '#/components/examples/post-authorise-authorise-recurringstore' - authorise-recurringoneclick: - $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' schema: $ref: '#/components/schemas/PaymentRequest' responses: @@ -174,18 +162,12 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: - examples: - generic-401: - $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. @@ -204,9 +186,6 @@ paths: '500': content: application/json: - examples: - generic-500: - $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -442,6 +421,9 @@ paths: '200': content: application/json: + examples: + cancelOrRefund-200: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -515,6 +497,9 @@ paths: '200': content: application/json: + examples: + capture-200: + $ref: '#/components/examples/post-capture-capture-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -573,9 +558,6 @@ paths: requestBody: content: application/json: - examples: - donate: - $ref: '#/components/examples/post-donate-donate' schema: $ref: '#/components/schemas/DonationRequest' responses: @@ -588,9 +570,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -637,9 +616,6 @@ paths: requestBody: content: application/json: - examples: - getAuthenticationResult: - $ref: '#/components/examples/post-getAuthenticationResult-getAuthenticationResult' schema: $ref: '#/components/schemas/AuthenticationResultRequest' responses: @@ -652,9 +628,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -721,6 +694,9 @@ paths: '200': content: application/json: + examples: + refund-200: + $ref: '#/components/examples/post-refund-refund-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -855,6 +831,9 @@ paths: '200': content: application/json: + examples: + technicalCancel-200: + $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -929,6 +908,11 @@ paths: '200': content: application/json: + examples: + voidpendingrefund-tenderreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + voidpendingrefund-pspreference-200: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. @@ -3772,8 +3756,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -4121,8 +4111,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -4462,8 +4458,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this @@ -5605,11 +5607,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -6134,148 +6136,11 @@ components: value: 1700 reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-3d-secure-2: - summary: Make a card payment with 3D Secure 2 native authentication + post-adjustAuthorisation-adjustAuthorisation-200: + summary: Example response for request 'adjustAuthorisation' value: - amount: - currency: USD - value: 1500 - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: YOUR_REFERENCE_NUMBER - threeDS2RequestData: - deviceChannel: browser - notificationURL: https://www.example.com/YOUR_3DS_NOTIFICATION_URL - browserInfo: - userAgent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 - (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36 - acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8 - language: en - colorDepth: 24 - screenHeight: 723 - screenWidth: 1536 - timeZoneOffset: 0 - javaEnabled: false - billingAddress: - country: US - city: New York - street: Redwood Block - houseNumberOrName: 37C - stateOrProvince: NY - postalCode: '10039' - accountInfo: - accountCreationDate: '2019-01-17T13:42:40+01:00' - shopperEmail: s.hopper@test.com - shopperIP: 192.0.2.1 - card: - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - number: '4917610000000000' - post-authorise-authorise-3dsecure: - summary: Initiate a 3D Secure payment - value: - amount: - value: 1500 - currency: EUR - card: - number: '5212345678901234' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-card: - summary: Authorise a card payment - value: - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - amount: - value: 1500 - currency: EUR - reference: YOUR_REFERENCE - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringcontauth: - summary: Authorise a recurring payment - value: - amount: - value: 2000 - currency: EUR - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: RECURRING - shopperInteraction: ContAuth - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringoneclick: - summary: Authorise a one-click payment - value: - amount: - value: 2000 - currency: EUR - card: - cvc: '737' - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - selectedRecurringDetailReference: LATEST - recurring: - contract: ONECLICK - shopperInteraction: Ecommerce - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-recurringstore: - summary: Store card details for recurring payments - value: - amount: - value: 2000 - currency: EUR - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - cvc: '737' - holderName: John Smith - reference: YOUR_REFERENCE - shopperEmail: s.hopper@test.com - shopperIP: 61.294.12.12 - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - recurring: - contract: RECURRING,ONECLICK - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-authorise-authorise-split: - summary: Split a payment between a sub-merchant and a platform account - value: - card: - number: '4111111111111111' - cvc: '737' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - amount: - value: 6200 - currency: EUR - reference: YOUR_ORDER_NUMBER - merchantAccount: YOUR_MERCHANT_ACCOUNT - splits: - - amount: - value: 6000 - type: MarketPlace - account: '151272963' - reference: '6124145' - description: 'Porcelain Doll: Eliza (20cm)' - - amount: - value: 200 - type: Commission - reference: '6124146' + pspReference: 851617892360718D + response: '[adjustAuthorisation-received]' post-authorise3d-authorise3d: summary: Complete a 3D Secure payment value: @@ -6302,6 +6167,11 @@ components: originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE reference: YourModificationReference merchantAccount: YOUR_MERCHANT_ACCOUNT + post-cancelOrRefund-cancelOrRefund-200: + summary: Example response for request 'cancelOrRefund' + value: + pspReference: 851617892359708H + response: '[cancelOrRefund-received]' post-capture-capture: summary: Capture an authorised payment value: @@ -6311,22 +6181,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT - post-donate-donate: - summary: Create a payment for the specified donation + post-capture-capture-200: + summary: Example response for request 'capture' value: - originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE - modificationAmount: - value: 500 - currency: EUR - reference: YOUR_DONATION_REFERENCE - donationAccount: AdyenGivingDemo - merchantAccount: YOUR_MERCHANT_ACCOUNT - post-getAuthenticationResult-getAuthenticationResult: - summary: Retrieve the authentication result after doing a 3D Secure authentication - only - value: - merchantAccount: YOUR_MERCHANT_ACCOUNT - pspReference: '9935272408535455' + pspReference: 861617892359057J + response: '[capture-received]' post-refund-refund: summary: Refund a captured payment value: @@ -6336,6 +6195,11 @@ components: currency: EUR reference: YOUR_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-refund-refund-200: + summary: Example response for request 'refund' + value: + pspReference: 861617892360059B + response: '[refund-received]' post-retrieve3ds2Result-retrieve3ds2Result: summary: Retrieve authentication details after doing a 3D Secure 2 authentication only @@ -6348,11 +6212,21 @@ components: originalMerchantReference: YOUR_MERCHANT_REFERENCE reference: YOUR_MODIFICATION_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT + post-technicalCancel-technicalCancel-200: + summary: Example response for request 'technicalCancel' + value: + pspReference: 881617892361436J + response: '[technical-cancel-received]' post-voidPendingRefund-voidpendingrefund-pspreference: summary: Cancel a POS refund request with PSP reference before it has been completed value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9914748988390044' + post-voidPendingRefund-voidpendingrefund-pspreference-200: + summary: Example response for request 'voidpendingrefund-pspreference' + value: + pspReference: 861617892360062F + response: '[voidPendingRefund-received]' post-voidPendingRefund-voidpendingrefund-tenderreference: summary: Cancels a POS refund request with tender reference before it has been completed @@ -6360,3 +6234,8 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT tenderReference: 5Iw8001176969533005 uniqueTerminalId: VX820-123456789 + post-voidPendingRefund-voidpendingrefund-tenderreference-200: + summary: Example response for request 'voidpendingrefund-tenderreference' + value: + pspReference: 881617892360409G + response: '[voidPendingRefund-received]' diff --git a/yaml/PayoutService-v30.yaml b/yaml/PayoutService-v30.yaml index f742173..7956c2a 100644 --- a/yaml/PayoutService-v30.yaml +++ b/yaml/PayoutService-v30.yaml @@ -73,6 +73,9 @@ paths: '200': content: application/json: + examples: + confirmThirdParty-200: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -132,6 +135,9 @@ paths: '200': content: application/json: + examples: + declineThirdParty-200: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -182,11 +188,6 @@ paths: requestBody: content: application/json: - examples: - payout-p2p: - $ref: '#/components/examples/post-payout-payout-p2p' - payout-b2c: - $ref: '#/components/examples/post-payout-payout-b2c' schema: $ref: '#/components/schemas/PayoutRequest' responses: @@ -199,9 +200,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -250,6 +248,9 @@ paths: '200': content: application/json: + examples: + storeDetail-200: + $ref: '#/components/examples/post-storeDetail-storeDetail-200' schema: $ref: '#/components/schemas/StoreDetailResponse' description: OK - the request has succeeded. @@ -304,14 +305,8 @@ paths: examples: storeDetailAndSubmitThirdParty-Neteller: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' - storeDetailAndSubmitThirdParty-Skrill: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' - storeDetailAndSubmitThirdParty-PayPal: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty' - storeDetailAndSubmitThirdParty-Paysafecard: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard' schema: $ref: '#/components/schemas/StoreDetailAndSubmitRequest' responses: @@ -324,9 +319,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -2426,8 +2418,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -3849,73 +3847,22 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' + post-confirmThirdParty-confirmThirdParty-200: + summary: Example response for request 'confirmThirdParty' + value: + pspReference: 991617894325358C + response: '[payout-confirm-received]' post-declineThirdParty-declineThirdParty: summary: Cancel a payout description: Cancel a previously submitted payout value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-payout-payout-b2c: - summary: Instant card payout (B2C) - description: Pay out to your sellers, customers, freelancers, etc + post-declineThirdParty-declineThirdParty-200: + summary: Example response for request 'declineThirdParty' value: - amount: - value: 2500 - currency: USD - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - billingAddress: - houseNumberOrName: '121' - street: Populierenlaan - city: Beverly Hills - postalCode: '90210' - stateOrProvince: CA - country: US - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: P9999999999999999 - shopperName: - firstName: John - lastName: Smith - dateOfBirth: '1990-01-01' - nationality: NL - post-payout-payout-p2p: - summary: Instant card payout (P2P) - description: Facilitate the transfer of money between two individuals - value: - amount: - value: 2500 - currency: USD - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - fundSource: - additionalData: - fundingSource: DEBIT - billingAddress: - country: US - postalCode: '90210' - city: Beverly Hills - card: - expiryMonth: '03' - expiryYear: '2030' - holderName: Payer Name - number: '4400000000000008' - shopperName: - firstName: Payer - lastName: Name - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: P9999999999999999 - shopperName: - firstName: John - lastName: Smith - shopperStatement: Payer Name - dateOfBirth: '1990-01-01' - nationality: NL + pspReference: 991617894325360J + response: '[payout-decline-received]' post-storeDetail-storeDetail: summary: Store payout details description: Store payment details under the PAYOUT recurring contract @@ -3947,6 +3894,12 @@ components: stateOrProvince: NY country: US postalCode: '12345' + post-storeDetail-storeDetail-200: + summary: Example response for request 'storeDetail' + value: + pspReference: 991617894326362D + recurringDetailReference: '9916178936754752' + resultCode: Success post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty: summary: Submit a payout and stores details description: Submit a payout and stores its details for subsequent payouts @@ -3998,82 +3951,6 @@ components: reference: Test Payout shopperEmail: test@company.com shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal: - summary: Submit a payout to PayPal - description: Submit a payout to PayPal and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 1750 - selectedBrand: paypal - additionalData: - tokenDataType: PayPal - emailId: EmailUsedForPayPalAccount@example.com - paypal.payerId: AK5HCWWRUV2KL - shopperName: - firstName: Test - gender: FEMALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard: - summary: Submit a payout to Paysafecard - description: Submit a payout to Paysafecard and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 1000 - selectedBrand: paysafecard - additionalData: - emailId: EmailUsedForPaysafecardAccount@example.com - shopperName: - firstName: Test - gender: MALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperIP: 61.294.12.12 - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill: - summary: Submit a payout to Skrill - description: Submit a payout to Skrill and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 100 - selectedBrand: moneybookers - additionalData: - tokenDataType: MoneyBookers - email: name@adyen.com - shopperName: - firstName: Test - gender: FEMALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-submitThirdParty-submitThirdParty: summary: Submit a payout description: Submit a payout using the previously stored payment details diff --git a/yaml/PayoutService-v40.yaml b/yaml/PayoutService-v40.yaml index 4c3f1d8..18c6a2e 100644 --- a/yaml/PayoutService-v40.yaml +++ b/yaml/PayoutService-v40.yaml @@ -73,6 +73,9 @@ paths: '200': content: application/json: + examples: + confirmThirdParty-200: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -132,6 +135,9 @@ paths: '200': content: application/json: + examples: + declineThirdParty-200: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -182,11 +188,6 @@ paths: requestBody: content: application/json: - examples: - payout-p2p: - $ref: '#/components/examples/post-payout-payout-p2p' - payout-b2c: - $ref: '#/components/examples/post-payout-payout-b2c' schema: $ref: '#/components/schemas/PayoutRequest' responses: @@ -199,9 +200,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -250,6 +248,9 @@ paths: '200': content: application/json: + examples: + storeDetail-200: + $ref: '#/components/examples/post-storeDetail-storeDetail-200' schema: $ref: '#/components/schemas/StoreDetailResponse' description: OK - the request has succeeded. @@ -304,14 +305,8 @@ paths: examples: storeDetailAndSubmitThirdParty-Neteller: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' - storeDetailAndSubmitThirdParty-Skrill: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' - storeDetailAndSubmitThirdParty-PayPal: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty' - storeDetailAndSubmitThirdParty-Paysafecard: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard' schema: $ref: '#/components/schemas/StoreDetailAndSubmitRequest' responses: @@ -324,9 +319,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -2823,8 +2815,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -3869,11 +3867,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -4490,73 +4488,22 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' + post-confirmThirdParty-confirmThirdParty-200: + summary: Example response for request 'confirmThirdParty' + value: + pspReference: 991617894325358C + response: '[payout-confirm-received]' post-declineThirdParty-declineThirdParty: summary: Cancel a payout description: Cancel a previously submitted payout value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-payout-payout-b2c: - summary: Instant card payout (B2C) - description: Pay out to your sellers, customers, freelancers, etc + post-declineThirdParty-declineThirdParty-200: + summary: Example response for request 'declineThirdParty' value: - amount: - value: 2500 - currency: USD - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - billingAddress: - houseNumberOrName: '121' - street: Populierenlaan - city: Beverly Hills - postalCode: '90210' - stateOrProvince: CA - country: US - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: P9999999999999999 - shopperName: - firstName: John - lastName: Smith - dateOfBirth: '1990-01-01' - nationality: NL - post-payout-payout-p2p: - summary: Instant card payout (P2P) - description: Facilitate the transfer of money between two individuals - value: - amount: - value: 2500 - currency: USD - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - fundSource: - additionalData: - fundingSource: DEBIT - billingAddress: - country: US - postalCode: '90210' - city: Beverly Hills - card: - expiryMonth: '03' - expiryYear: '2030' - holderName: Payer Name - number: '4400000000000008' - shopperName: - firstName: Payer - lastName: Name - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: P9999999999999999 - shopperName: - firstName: John - lastName: Smith - shopperStatement: Payer Name - dateOfBirth: '1990-01-01' - nationality: NL + pspReference: 991617894325360J + response: '[payout-decline-received]' post-storeDetail-storeDetail: summary: Store payout details description: Store payment details under the PAYOUT recurring contract @@ -4588,6 +4535,12 @@ components: stateOrProvince: NY country: US postalCode: '12345' + post-storeDetail-storeDetail-200: + summary: Example response for request 'storeDetail' + value: + pspReference: 991617894326362D + recurringDetailReference: '9916178936754752' + resultCode: Success post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty: summary: Submit a payout and stores details description: Submit a payout and stores its details for subsequent payouts @@ -4639,82 +4592,6 @@ components: reference: Test Payout shopperEmail: test@company.com shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal: - summary: Submit a payout to PayPal - description: Submit a payout to PayPal and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 1750 - selectedBrand: paypal - additionalData: - tokenDataType: PayPal - emailId: EmailUsedForPayPalAccount@example.com - paypal.payerId: AK5HCWWRUV2KL - shopperName: - firstName: Test - gender: FEMALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard: - summary: Submit a payout to Paysafecard - description: Submit a payout to Paysafecard and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 1000 - selectedBrand: paysafecard - additionalData: - emailId: EmailUsedForPaysafecardAccount@example.com - shopperName: - firstName: Test - gender: MALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperIP: 61.294.12.12 - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill: - summary: Submit a payout to Skrill - description: Submit a payout to Skrill and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 100 - selectedBrand: moneybookers - additionalData: - tokenDataType: MoneyBookers - email: name@adyen.com - shopperName: - firstName: Test - gender: FEMALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-submitThirdParty-submitThirdParty: summary: Submit a payout description: Submit a payout using the previously stored payment details diff --git a/yaml/PayoutService-v50.yaml b/yaml/PayoutService-v50.yaml index 65dc055..33b445a 100644 --- a/yaml/PayoutService-v50.yaml +++ b/yaml/PayoutService-v50.yaml @@ -73,6 +73,9 @@ paths: '200': content: application/json: + examples: + confirmThirdParty-200: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -132,6 +135,9 @@ paths: '200': content: application/json: + examples: + declineThirdParty-200: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -182,11 +188,6 @@ paths: requestBody: content: application/json: - examples: - payout-p2p: - $ref: '#/components/examples/post-payout-payout-p2p' - payout-b2c: - $ref: '#/components/examples/post-payout-payout-b2c' schema: $ref: '#/components/schemas/PayoutRequest' responses: @@ -199,9 +200,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -250,6 +248,9 @@ paths: '200': content: application/json: + examples: + storeDetail-200: + $ref: '#/components/examples/post-storeDetail-storeDetail-200' schema: $ref: '#/components/schemas/StoreDetailResponse' description: OK - the request has succeeded. @@ -304,14 +305,8 @@ paths: examples: storeDetailAndSubmitThirdParty-Neteller: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' - storeDetailAndSubmitThirdParty-Skrill: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' - storeDetailAndSubmitThirdParty-PayPal: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty' - storeDetailAndSubmitThirdParty-Paysafecard: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard' schema: $ref: '#/components/schemas/StoreDetailAndSubmitRequest' responses: @@ -324,9 +319,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -2840,8 +2832,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -3900,11 +3898,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -4570,73 +4568,22 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' + post-confirmThirdParty-confirmThirdParty-200: + summary: Example response for request 'confirmThirdParty' + value: + pspReference: 991617894325358C + response: '[payout-confirm-received]' post-declineThirdParty-declineThirdParty: summary: Cancel a payout description: Cancel a previously submitted payout value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-payout-payout-b2c: - summary: Instant card payout (B2C) - description: Pay out to your sellers, customers, freelancers, etc + post-declineThirdParty-declineThirdParty-200: + summary: Example response for request 'declineThirdParty' value: - amount: - value: 2500 - currency: USD - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - billingAddress: - houseNumberOrName: '121' - street: Populierenlaan - city: Beverly Hills - postalCode: '90210' - stateOrProvince: CA - country: US - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: P9999999999999999 - shopperName: - firstName: John - lastName: Smith - dateOfBirth: '1990-01-01' - nationality: NL - post-payout-payout-p2p: - summary: Instant card payout (P2P) - description: Facilitate the transfer of money between two individuals - value: - amount: - value: 2500 - currency: USD - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - fundSource: - additionalData: - fundingSource: DEBIT - billingAddress: - country: US - postalCode: '90210' - city: Beverly Hills - card: - expiryMonth: '03' - expiryYear: '2030' - holderName: Payer Name - number: '4400000000000008' - shopperName: - firstName: Payer - lastName: Name - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: P9999999999999999 - shopperName: - firstName: John - lastName: Smith - shopperStatement: Payer Name - dateOfBirth: '1990-01-01' - nationality: NL + pspReference: 991617894325360J + response: '[payout-decline-received]' post-storeDetail-storeDetail: summary: Store payout details description: Store payment details under the PAYOUT recurring contract @@ -4668,6 +4615,12 @@ components: stateOrProvince: NY country: US postalCode: '12345' + post-storeDetail-storeDetail-200: + summary: Example response for request 'storeDetail' + value: + pspReference: 991617894326362D + recurringDetailReference: '9916178936754752' + resultCode: Success post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty: summary: Submit a payout and stores details description: Submit a payout and stores its details for subsequent payouts @@ -4719,82 +4672,6 @@ components: reference: Test Payout shopperEmail: test@company.com shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal: - summary: Submit a payout to PayPal - description: Submit a payout to PayPal and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 1750 - selectedBrand: paypal - additionalData: - tokenDataType: PayPal - emailId: EmailUsedForPayPalAccount@example.com - paypal.payerId: AK5HCWWRUV2KL - shopperName: - firstName: Test - gender: FEMALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard: - summary: Submit a payout to Paysafecard - description: Submit a payout to Paysafecard and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 1000 - selectedBrand: paysafecard - additionalData: - emailId: EmailUsedForPaysafecardAccount@example.com - shopperName: - firstName: Test - gender: MALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperIP: 61.294.12.12 - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill: - summary: Submit a payout to Skrill - description: Submit a payout to Skrill and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 100 - selectedBrand: moneybookers - additionalData: - tokenDataType: MoneyBookers - email: name@adyen.com - shopperName: - firstName: Test - gender: FEMALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-submitThirdParty-submitThirdParty: summary: Submit a payout description: Submit a payout using the previously stored payment details diff --git a/yaml/PayoutService-v51.yaml b/yaml/PayoutService-v51.yaml index fcc5453..bc31541 100644 --- a/yaml/PayoutService-v51.yaml +++ b/yaml/PayoutService-v51.yaml @@ -73,6 +73,9 @@ paths: '200': content: application/json: + examples: + confirmThirdParty-200: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -132,6 +135,9 @@ paths: '200': content: application/json: + examples: + declineThirdParty-200: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -182,11 +188,6 @@ paths: requestBody: content: application/json: - examples: - payout-p2p: - $ref: '#/components/examples/post-payout-payout-p2p' - payout-b2c: - $ref: '#/components/examples/post-payout-payout-b2c' schema: $ref: '#/components/schemas/PayoutRequest' responses: @@ -199,9 +200,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -250,6 +248,9 @@ paths: '200': content: application/json: + examples: + storeDetail-200: + $ref: '#/components/examples/post-storeDetail-storeDetail-200' schema: $ref: '#/components/schemas/StoreDetailResponse' description: OK - the request has succeeded. @@ -304,14 +305,8 @@ paths: examples: storeDetailAndSubmitThirdParty-Neteller: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' - storeDetailAndSubmitThirdParty-Skrill: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' - storeDetailAndSubmitThirdParty-PayPal: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty' - storeDetailAndSubmitThirdParty-Paysafecard: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard' schema: $ref: '#/components/schemas/StoreDetailAndSubmitRequest' responses: @@ -324,9 +319,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -2846,8 +2838,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -3906,11 +3904,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -4576,73 +4574,22 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' + post-confirmThirdParty-confirmThirdParty-200: + summary: Example response for request 'confirmThirdParty' + value: + pspReference: 991617894325358C + response: '[payout-confirm-received]' post-declineThirdParty-declineThirdParty: summary: Cancel a payout description: Cancel a previously submitted payout value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-payout-payout-b2c: - summary: Instant card payout (B2C) - description: Pay out to your sellers, customers, freelancers, etc + post-declineThirdParty-declineThirdParty-200: + summary: Example response for request 'declineThirdParty' value: - amount: - value: 2500 - currency: USD - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - billingAddress: - houseNumberOrName: '121' - street: Populierenlaan - city: Beverly Hills - postalCode: '90210' - stateOrProvince: CA - country: US - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: P9999999999999999 - shopperName: - firstName: John - lastName: Smith - dateOfBirth: '1990-01-01' - nationality: NL - post-payout-payout-p2p: - summary: Instant card payout (P2P) - description: Facilitate the transfer of money between two individuals - value: - amount: - value: 2500 - currency: USD - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - fundSource: - additionalData: - fundingSource: DEBIT - billingAddress: - country: US - postalCode: '90210' - city: Beverly Hills - card: - expiryMonth: '03' - expiryYear: '2030' - holderName: Payer Name - number: '4400000000000008' - shopperName: - firstName: Payer - lastName: Name - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: P9999999999999999 - shopperName: - firstName: John - lastName: Smith - shopperStatement: Payer Name - dateOfBirth: '1990-01-01' - nationality: NL + pspReference: 991617894325360J + response: '[payout-decline-received]' post-storeDetail-storeDetail: summary: Store payout details description: Store payment details under the PAYOUT recurring contract @@ -4674,6 +4621,12 @@ components: stateOrProvince: NY country: US postalCode: '12345' + post-storeDetail-storeDetail-200: + summary: Example response for request 'storeDetail' + value: + pspReference: 991617894326362D + recurringDetailReference: '9916178936754752' + resultCode: Success post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty: summary: Submit a payout and stores details description: Submit a payout and stores its details for subsequent payouts @@ -4725,82 +4678,6 @@ components: reference: Test Payout shopperEmail: test@company.com shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal: - summary: Submit a payout to PayPal - description: Submit a payout to PayPal and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 1750 - selectedBrand: paypal - additionalData: - tokenDataType: PayPal - emailId: EmailUsedForPayPalAccount@example.com - paypal.payerId: AK5HCWWRUV2KL - shopperName: - firstName: Test - gender: FEMALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard: - summary: Submit a payout to Paysafecard - description: Submit a payout to Paysafecard and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 1000 - selectedBrand: paysafecard - additionalData: - emailId: EmailUsedForPaysafecardAccount@example.com - shopperName: - firstName: Test - gender: MALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperIP: 61.294.12.12 - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill: - summary: Submit a payout to Skrill - description: Submit a payout to Skrill and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 100 - selectedBrand: moneybookers - additionalData: - tokenDataType: MoneyBookers - email: name@adyen.com - shopperName: - firstName: Test - gender: FEMALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-submitThirdParty-submitThirdParty: summary: Submit a payout description: Submit a payout using the previously stored payment details diff --git a/yaml/PayoutService-v52.yaml b/yaml/PayoutService-v52.yaml index f0b1bbf..aca9f75 100644 --- a/yaml/PayoutService-v52.yaml +++ b/yaml/PayoutService-v52.yaml @@ -73,6 +73,9 @@ paths: '200': content: application/json: + examples: + confirmThirdParty-200: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -132,6 +135,9 @@ paths: '200': content: application/json: + examples: + declineThirdParty-200: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -182,11 +188,6 @@ paths: requestBody: content: application/json: - examples: - payout-p2p: - $ref: '#/components/examples/post-payout-payout-p2p' - payout-b2c: - $ref: '#/components/examples/post-payout-payout-b2c' schema: $ref: '#/components/schemas/PayoutRequest' responses: @@ -199,9 +200,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -250,6 +248,9 @@ paths: '200': content: application/json: + examples: + storeDetail-200: + $ref: '#/components/examples/post-storeDetail-storeDetail-200' schema: $ref: '#/components/schemas/StoreDetailResponse' description: OK - the request has succeeded. @@ -304,14 +305,8 @@ paths: examples: storeDetailAndSubmitThirdParty-Neteller: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' - storeDetailAndSubmitThirdParty-Skrill: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' - storeDetailAndSubmitThirdParty-PayPal: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty' - storeDetailAndSubmitThirdParty-Paysafecard: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard' schema: $ref: '#/components/schemas/StoreDetailAndSubmitRequest' responses: @@ -324,9 +319,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -2854,8 +2846,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -3914,11 +3912,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -4592,73 +4590,22 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' + post-confirmThirdParty-confirmThirdParty-200: + summary: Example response for request 'confirmThirdParty' + value: + pspReference: 991617894325358C + response: '[payout-confirm-received]' post-declineThirdParty-declineThirdParty: summary: Cancel a payout description: Cancel a previously submitted payout value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-payout-payout-b2c: - summary: Instant card payout (B2C) - description: Pay out to your sellers, customers, freelancers, etc + post-declineThirdParty-declineThirdParty-200: + summary: Example response for request 'declineThirdParty' value: - amount: - value: 2500 - currency: USD - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - billingAddress: - houseNumberOrName: '121' - street: Populierenlaan - city: Beverly Hills - postalCode: '90210' - stateOrProvince: CA - country: US - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: P9999999999999999 - shopperName: - firstName: John - lastName: Smith - dateOfBirth: '1990-01-01' - nationality: NL - post-payout-payout-p2p: - summary: Instant card payout (P2P) - description: Facilitate the transfer of money between two individuals - value: - amount: - value: 2500 - currency: USD - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - fundSource: - additionalData: - fundingSource: DEBIT - billingAddress: - country: US - postalCode: '90210' - city: Beverly Hills - card: - expiryMonth: '03' - expiryYear: '2030' - holderName: Payer Name - number: '4400000000000008' - shopperName: - firstName: Payer - lastName: Name - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: P9999999999999999 - shopperName: - firstName: John - lastName: Smith - shopperStatement: Payer Name - dateOfBirth: '1990-01-01' - nationality: NL + pspReference: 991617894325360J + response: '[payout-decline-received]' post-storeDetail-storeDetail: summary: Store payout details description: Store payment details under the PAYOUT recurring contract @@ -4690,6 +4637,12 @@ components: stateOrProvince: NY country: US postalCode: '12345' + post-storeDetail-storeDetail-200: + summary: Example response for request 'storeDetail' + value: + pspReference: 991617894326362D + recurringDetailReference: '9916178936754752' + resultCode: Success post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty: summary: Submit a payout and stores details description: Submit a payout and stores its details for subsequent payouts @@ -4741,82 +4694,6 @@ components: reference: Test Payout shopperEmail: test@company.com shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal: - summary: Submit a payout to PayPal - description: Submit a payout to PayPal and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 1750 - selectedBrand: paypal - additionalData: - tokenDataType: PayPal - emailId: EmailUsedForPayPalAccount@example.com - paypal.payerId: AK5HCWWRUV2KL - shopperName: - firstName: Test - gender: FEMALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard: - summary: Submit a payout to Paysafecard - description: Submit a payout to Paysafecard and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 1000 - selectedBrand: paysafecard - additionalData: - emailId: EmailUsedForPaysafecardAccount@example.com - shopperName: - firstName: Test - gender: MALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperIP: 61.294.12.12 - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill: - summary: Submit a payout to Skrill - description: Submit a payout to Skrill and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 100 - selectedBrand: moneybookers - additionalData: - tokenDataType: MoneyBookers - email: name@adyen.com - shopperName: - firstName: Test - gender: FEMALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-submitThirdParty-submitThirdParty: summary: Submit a payout description: Submit a payout using the previously stored payment details diff --git a/yaml/PayoutService-v64.yaml b/yaml/PayoutService-v64.yaml index 022af37..ef303bb 100644 --- a/yaml/PayoutService-v64.yaml +++ b/yaml/PayoutService-v64.yaml @@ -73,6 +73,9 @@ paths: '200': content: application/json: + examples: + confirmThirdParty-200: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -132,6 +135,9 @@ paths: '200': content: application/json: + examples: + declineThirdParty-200: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200' schema: $ref: '#/components/schemas/ModifyResponse' description: OK - the request has succeeded. @@ -182,11 +188,6 @@ paths: requestBody: content: application/json: - examples: - payout-p2p: - $ref: '#/components/examples/post-payout-payout-p2p' - payout-b2c: - $ref: '#/components/examples/post-payout-payout-b2c' schema: $ref: '#/components/schemas/PayoutRequest' responses: @@ -199,9 +200,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -250,6 +248,9 @@ paths: '200': content: application/json: + examples: + storeDetail-200: + $ref: '#/components/examples/post-storeDetail-storeDetail-200' schema: $ref: '#/components/schemas/StoreDetailResponse' description: OK - the request has succeeded. @@ -304,14 +305,8 @@ paths: examples: storeDetailAndSubmitThirdParty-Neteller: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' - storeDetailAndSubmitThirdParty-Skrill: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' - storeDetailAndSubmitThirdParty-PayPal: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' storeDetailAndSubmitThirdParty: $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty' - storeDetailAndSubmitThirdParty-Paysafecard: - $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard' schema: $ref: '#/components/schemas/StoreDetailAndSubmitRequest' responses: @@ -324,9 +319,6 @@ paths: '400': content: application/json: - examples: - generic-400: - $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. @@ -2869,8 +2861,14 @@ components: description: 'Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the - "177" error occurs: "Metadata size exceeds limit".' + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' type: object mpiData: description: Authentication data produced by an MPI (Mastercard SecureCode @@ -3929,11 +3927,11 @@ components: split to other operations such as captures and refunds. - This is required if `type` is **MarketPlace**. For the other types, we - also recommend sending a reference so you can reconcile the split and - the associated payment in the transaction overview and in the reports. - If the reference is not provided, the split is reported as part of the - aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.' type: string type: @@ -4607,73 +4605,22 @@ components: value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' + post-confirmThirdParty-confirmThirdParty-200: + summary: Example response for request 'confirmThirdParty' + value: + pspReference: 991617894325358C + response: '[payout-confirm-received]' post-declineThirdParty-declineThirdParty: summary: Cancel a payout description: Cancel a previously submitted payout value: merchantAccount: YOUR_MERCHANT_ACCOUNT originalReference: '9913140798220028' - post-payout-payout-b2c: - summary: Instant card payout (B2C) - description: Pay out to your sellers, customers, freelancers, etc + post-declineThirdParty-declineThirdParty-200: + summary: Example response for request 'declineThirdParty' value: - amount: - value: 2500 - currency: USD - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - billingAddress: - houseNumberOrName: '121' - street: Populierenlaan - city: Beverly Hills - postalCode: '90210' - stateOrProvince: CA - country: US - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: P9999999999999999 - shopperName: - firstName: John - lastName: Smith - dateOfBirth: '1990-01-01' - nationality: NL - post-payout-payout-p2p: - summary: Instant card payout (P2P) - description: Facilitate the transfer of money between two individuals - value: - amount: - value: 2500 - currency: USD - card: - number: '4111111111111111' - expiryMonth: '03' - expiryYear: '2030' - holderName: John Smith - fundSource: - additionalData: - fundingSource: DEBIT - billingAddress: - country: US - postalCode: '90210' - city: Beverly Hills - card: - expiryMonth: '03' - expiryYear: '2030' - holderName: Payer Name - number: '4400000000000008' - shopperName: - firstName: Payer - lastName: Name - merchantAccount: YOUR_MERCHANT_ACCOUNT - reference: P9999999999999999 - shopperName: - firstName: John - lastName: Smith - shopperStatement: Payer Name - dateOfBirth: '1990-01-01' - nationality: NL + pspReference: 991617894325360J + response: '[payout-decline-received]' post-storeDetail-storeDetail: summary: Store payout details description: Store payment details under the PAYOUT recurring contract @@ -4705,6 +4652,12 @@ components: stateOrProvince: NY country: US postalCode: '12345' + post-storeDetail-storeDetail-200: + summary: Example response for request 'storeDetail' + value: + pspReference: 991617894326362D + recurringDetailReference: '9916178936754752' + resultCode: Success post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty: summary: Submit a payout and stores details description: Submit a payout and stores its details for subsequent payouts @@ -4756,82 +4709,6 @@ components: reference: Test Payout shopperEmail: test@company.com shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal: - summary: Submit a payout to PayPal - description: Submit a payout to PayPal and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 1750 - selectedBrand: paypal - additionalData: - tokenDataType: PayPal - emailId: EmailUsedForPayPalAccount@example.com - paypal.payerId: AK5HCWWRUV2KL - shopperName: - firstName: Test - gender: FEMALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard: - summary: Submit a payout to Paysafecard - description: Submit a payout to Paysafecard and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 1000 - selectedBrand: paysafecard - additionalData: - emailId: EmailUsedForPaysafecardAccount@example.com - shopperName: - firstName: Test - gender: MALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j - shopperIP: 61.294.12.12 - post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill: - summary: Submit a payout to Skrill - description: Submit a payout to Skrill and stores its details for subsequent - payouts - value: - amount: - currency: EUR - value: 100 - selectedBrand: moneybookers - additionalData: - tokenDataType: MoneyBookers - email: name@adyen.com - shopperName: - firstName: Test - gender: FEMALE - lastName: Test2 - dateOfBirth: '1982-07-17' - entityType: NaturalPerson - nationality: NL - merchantAccount: YOUR_MERCHANT_ACCOUNT - recurring: - contract: PAYOUT - reference: Test Payout - shopperEmail: test@company.com - shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j post-submitThirdParty-submitThirdParty: summary: Submit a payout description: Submit a payout using the previously stored payment details