mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
17870 lines
677 KiB
YAML
17870 lines
677 KiB
YAML
openapi: 3.1.0
|
|
servers:
|
|
- url: https://checkout-test.adyen.com/v70
|
|
info:
|
|
version: '70'
|
|
x-publicVersion: true
|
|
title: Adyen Checkout API
|
|
description: 'Adyen Checkout API provides a simple and flexible way to initiate
|
|
and authorise online payments. You can use the same integration for payments made
|
|
with cards (including 3D Secure), mobile wallets, and local payment methods (for
|
|
example, iDEAL and Sofort).
|
|
|
|
|
|
This API reference provides information on available endpoints and how to interact
|
|
with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).
|
|
|
|
|
|
## Authentication
|
|
|
|
Each request to Checkout API must be signed with an API key. For this, [get your
|
|
API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key)
|
|
from your Customer Area, and set this key to the `X-API-Key` header value, for
|
|
example:
|
|
|
|
|
|
```
|
|
|
|
curl
|
|
|
|
-H "Content-Type: application/json" \
|
|
|
|
-H "X-API-Key: YOUR_API_KEY" \
|
|
|
|
...
|
|
|
|
```
|
|
|
|
## Versioning
|
|
|
|
Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning)
|
|
using a version suffix in the endpoint URL. This suffix has the following format:
|
|
"vXX", where XX is the version number.
|
|
|
|
|
|
For example:
|
|
|
|
```
|
|
|
|
https://checkout-test.adyen.com/v70/payments
|
|
|
|
```
|
|
|
|
|
|
## Going live
|
|
|
|
|
|
To access the live endpoints, you need an API key from your live Customer Area.
|
|
|
|
|
|
The live endpoint URLs contain a prefix which is unique to your company account,
|
|
for example:
|
|
|
|
```
|
|
|
|
https://{PREFIX}-checkout-live.adyenpayments.com/checkout/v70/payments
|
|
|
|
```
|
|
|
|
|
|
Get your `{PREFIX}` from your live Customer Area under **Developers** > **API
|
|
URLs** > **Prefix**.
|
|
|
|
|
|
When preparing to do live transactions with Checkout API, follow the [go-live
|
|
checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure
|
|
you''ve got all the required configuration in place.
|
|
|
|
|
|
## Release notes
|
|
|
|
Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=70)
|
|
to find out what changed in this version!'
|
|
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
|
contact:
|
|
name: Adyen Developer Experience team
|
|
url: https://github.com/Adyen/adyen-openapi
|
|
tags:
|
|
- name: Payments
|
|
- name: Donations
|
|
- name: Payment links
|
|
- name: Modifications
|
|
- name: Recurring
|
|
- name: Orders
|
|
- name: Utility
|
|
paths:
|
|
/applePay/sessions:
|
|
post:
|
|
tags:
|
|
- Utility
|
|
summary: Get an Apple Pay session
|
|
description: 'You need to use this endpoint if you have an API-only integration
|
|
with Apple Pay which uses Adyen''s Apple Pay certificate.
|
|
|
|
|
|
The endpoint returns the Apple Pay session data which you need to complete
|
|
the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation).'
|
|
operationId: post-applePay-sessions
|
|
x-sortIndex: 2
|
|
x-methodName: getApplePaySession
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-applePay-sessions-basic'
|
|
schema:
|
|
$ref: '#/components/schemas/ApplePaySessionRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-applePay-sessions-basic-200'
|
|
schema:
|
|
$ref: '#/components/schemas/ApplePaySessionResponse'
|
|
description: OK - the request has succeeded.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
/cancels:
|
|
post:
|
|
tags:
|
|
- Modifications
|
|
summary: Cancel an authorised payment
|
|
description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),
|
|
and returns a unique reference for this request. You get the outcome of the
|
|
request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).
|
|
|
|
|
|
If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference),
|
|
use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels)
|
|
endpoint instead.
|
|
|
|
|
|
If you want to cancel a payment but are not sure whether it has been captured,
|
|
use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)
|
|
endpoint instead.
|
|
|
|
|
|
For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).'
|
|
operationId: post-cancels
|
|
x-sortIndex: 3
|
|
x-methodName: cancelAuthorisedPayment
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
cancel-with-own-reference:
|
|
$ref: '#/components/examples/post-cancels-cancel-with-own-reference'
|
|
schema:
|
|
$ref: '#/components/schemas/StandalonePaymentCancelRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
cancel-with-own-reference:
|
|
$ref: '#/components/examples/post-cancels-cancel-with-own-reference-201'
|
|
schema:
|
|
$ref: '#/components/schemas/StandalonePaymentCancelResponse'
|
|
description: Created - the request has been fulfilled and has resulted in
|
|
one or more new resources being created.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/cardDetails:
|
|
post:
|
|
tags:
|
|
- Payments
|
|
summary: Get the brands and other details of a card
|
|
description: 'Use this endpoint to get information about the card or network
|
|
token that enables you to decideon the routing of the transaction and the
|
|
eligibility of the card for the type of transaction.
|
|
|
|
|
|
If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands)
|
|
in the request, the response also tells you if you support each [brand that
|
|
was identified on the card](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details).
|
|
|
|
|
|
If you have an API-only integration and collect card data, use this endpoint
|
|
to find out if the shopper''s card is co-branded. For co-branded cards, you
|
|
must let the shopper choose the brand to pay with if you support both brands.
|
|
|
|
|
|
'
|
|
operationId: post-cardDetails
|
|
x-sortIndex: 6
|
|
x-methodName: cardDetails
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-cardDetails-basic'
|
|
supported-brands:
|
|
$ref: '#/components/examples/post-cardDetails-supported-brands'
|
|
schema:
|
|
$ref: '#/components/schemas/CardDetailsRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-cardDetails-basic-200'
|
|
supported-brands:
|
|
$ref: '#/components/examples/post-cardDetails-supported-brands-200'
|
|
schema:
|
|
$ref: '#/components/schemas/CardDetailsResponse'
|
|
description: OK - the request has succeeded.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
/donationCampaigns:
|
|
post:
|
|
tags:
|
|
- Donations
|
|
summary: Get a list of donation campaigns.
|
|
description: Queries the available donation campaigns for a donation based on
|
|
the donation context (like merchant account, currency, and locale). The response
|
|
contains active donation campaigns.
|
|
x-addedInVersion: '67'
|
|
operationId: post-donationCampaigns
|
|
x-sortIndex: 1
|
|
x-methodName: donationCampaigns
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
donation-campaigns:
|
|
$ref: '#/components/examples/post-donationCampaigns-donation-campaigns'
|
|
schema:
|
|
$ref: '#/components/schemas/DonationCampaignsRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
donation-campaigns:
|
|
$ref: '#/components/examples/post-donationCampaigns-donation-campaigns-200'
|
|
schema:
|
|
$ref: '#/components/schemas/DonationCampaignsResponse'
|
|
description: OK - the request has succeeded.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/donations:
|
|
post:
|
|
tags:
|
|
- Donations
|
|
summary: Start a transaction for donations
|
|
description: 'Takes in the donation token generated by the `/payments` request
|
|
and uses it to make the donation for the donation account specified in the
|
|
request.
|
|
|
|
|
|
For more information, see [Donations](https://docs.adyen.com/online-payments/donations).'
|
|
operationId: post-donations
|
|
x-sortIndex: 2
|
|
x-methodName: donations
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
donations:
|
|
$ref: '#/components/examples/post-donations-donations'
|
|
donations-with-campaigns:
|
|
$ref: '#/components/examples/post-donations-donations-with-campaigns'
|
|
donations-with-token:
|
|
$ref: '#/components/examples/post-donations-donations-with-token'
|
|
schema:
|
|
$ref: '#/components/schemas/DonationPaymentRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
donations:
|
|
$ref: '#/components/examples/post-donations-donations-200'
|
|
donations-with-campaigns:
|
|
$ref: '#/components/examples/post-donations-donations-with-campaigns-200'
|
|
donations-with-token:
|
|
$ref: '#/components/examples/post-donations-donations-with-token-200'
|
|
schema:
|
|
$ref: '#/components/schemas/DonationPaymentResponse'
|
|
description: OK - the request has succeeded.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
donations-with-token:
|
|
$ref: '#/components/examples/post-donations-donations-with-token-422'
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/orders:
|
|
post:
|
|
tags:
|
|
- Orders
|
|
summary: Create an order
|
|
description: Creates an order to be used for partial payments. Make a POST `/orders`
|
|
call before making a `/payments` call when processing payments with different
|
|
payment methods.
|
|
operationId: post-orders
|
|
x-sortIndex: 2
|
|
x-methodName: orders
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-orders-basic'
|
|
schema:
|
|
$ref: '#/components/schemas/CreateOrderRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-orders-basic-200'
|
|
schema:
|
|
$ref: '#/components/schemas/CreateOrderResponse'
|
|
description: OK - the request has succeeded.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/orders/cancel:
|
|
post:
|
|
tags:
|
|
- Orders
|
|
summary: Cancel an order
|
|
description: Cancels an order. Cancellation of an order results in an automatic
|
|
rollback of all payments made in the order, either by canceling or refunding
|
|
the payment, depending on the type of payment method.
|
|
operationId: post-orders-cancel
|
|
x-sortIndex: 3
|
|
x-methodName: cancelOrder
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-orders-cancel-basic'
|
|
schema:
|
|
$ref: '#/components/schemas/CancelOrderRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-orders-cancel-basic-200'
|
|
schema:
|
|
$ref: '#/components/schemas/CancelOrderResponse'
|
|
description: OK - the request has succeeded.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/originKeys:
|
|
post:
|
|
tags:
|
|
- Utility
|
|
summary: Create originKey values for domains
|
|
description: "This operation takes the origin domains and returns a JSON object\
|
|
\ containing the corresponding origin keys for the domains. \n> If you're\
|
|
\ still using origin key for your Web Drop-in or Components integration, we\
|
|
\ recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key).\
|
|
\ This allows you to use a single key for all origins, add or remove origins\
|
|
\ without generating a new key, and detect the card type from the number entered\
|
|
\ in your payment form. "
|
|
deprecated: true
|
|
x-deprecatedInVersion: '67'
|
|
operationId: post-originKeys
|
|
x-sortIndex: 1
|
|
x-methodName: originKeys
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-originKeys-basic'
|
|
schema:
|
|
$ref: '#/components/schemas/UtilityRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-originKeys-basic-200'
|
|
schema:
|
|
$ref: '#/components/schemas/UtilityResponse'
|
|
description: OK - the request has succeeded.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/paymentLinks:
|
|
post:
|
|
tags:
|
|
- Payment links
|
|
summary: Create a payment link
|
|
description: 'Creates a payment link to a [Pay by Link](https://docs.adyen.com/unified-commerce/pay-by-link/)
|
|
page where the shopper can pay. The list of payment methods presented to the
|
|
shopper depends on the `currency` and `country` parameters sent in the request.
|
|
|
|
|
|
For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).'
|
|
operationId: post-paymentLinks
|
|
x-sortIndex: 1
|
|
x-methodName: paymentLinks
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-paymentLinks-basic'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentLinkRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-paymentLinks-basic-201'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentLinkResponse'
|
|
description: Created - the request has succeeded.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/paymentLinks/{linkId}:
|
|
get:
|
|
tags:
|
|
- Payment links
|
|
summary: Get a payment link
|
|
description: Retrieves the payment link details using the payment link `id`.
|
|
operationId: get-paymentLinks-linkId
|
|
x-sortIndex: 2
|
|
x-methodName: getPaymentLink
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
parameters:
|
|
- description: Unique identifier of the payment link.
|
|
name: linkId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/get-paymentLinks-linkId-basic-200'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentLinkResponse'
|
|
description: OK - the request has succeeded.
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-422'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unprocessable Entity - a request validation error.
|
|
'500':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
patch:
|
|
tags:
|
|
- Payment links
|
|
summary: Update the status of a payment link
|
|
description: Updates the status of a payment link. Use this endpoint to [force
|
|
the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).
|
|
operationId: patch-paymentLinks-linkId
|
|
x-sortIndex: 3
|
|
x-methodName: updatePaymentLink
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/patch-paymentLinks-linkId-basic'
|
|
schema:
|
|
$ref: '#/components/schemas/UpdatePaymentLinkRequest'
|
|
parameters:
|
|
- description: Unique identifier of the payment link.
|
|
name: linkId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/patch-paymentLinks-linkId-basic-200'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentLinkResponse'
|
|
description: OK - the request has succeeded.
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-422'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unprocessable Entity - a request validation error.
|
|
'500':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/paymentMethods:
|
|
post:
|
|
tags:
|
|
- Payments
|
|
summary: Get a list of available payment methods
|
|
description: Retrieves the list of available payment methods for the transaction,
|
|
based on the transaction information like amount, country, and currency.
|
|
operationId: post-paymentMethods
|
|
x-sortIndex: 2
|
|
x-methodName: paymentMethods
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-paymentMethods-basic'
|
|
filtered:
|
|
$ref: '#/components/examples/post-paymentMethods-filtered'
|
|
include-stored:
|
|
$ref: '#/components/examples/post-paymentMethods-include-stored'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentMethodsRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-paymentMethods-basic-200'
|
|
filtered:
|
|
$ref: '#/components/examples/post-paymentMethods-filtered-200'
|
|
include-stored:
|
|
$ref: '#/components/examples/post-paymentMethods-include-stored-200'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentMethodsResponse'
|
|
description: OK - the request has succeeded.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/paymentMethods/balance:
|
|
post:
|
|
tags:
|
|
- Orders
|
|
summary: Get the balance of a gift card
|
|
description: Retrieves the balance remaining on a shopper's gift card. To check
|
|
a gift card's balance, make a POST `/paymentMethods/balance` call and include
|
|
the gift card's details inside a `paymentMethod` object.
|
|
operationId: post-paymentMethods-balance
|
|
x-sortIndex: 1
|
|
x-methodName: getBalanceOfGiftCard
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-paymentMethods-balance-basic'
|
|
not-enough:
|
|
$ref: '#/components/examples/post-paymentMethods-balance-not-enough'
|
|
schema:
|
|
$ref: '#/components/schemas/BalanceCheckRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
basic:
|
|
$ref: '#/components/examples/post-paymentMethods-balance-basic-200'
|
|
not-enough:
|
|
$ref: '#/components/examples/post-paymentMethods-balance-not-enough-200'
|
|
schema:
|
|
$ref: '#/components/schemas/BalanceCheckResponse'
|
|
description: OK - the request has succeeded.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/payments:
|
|
post:
|
|
tags:
|
|
- Payments
|
|
summary: Start a transaction
|
|
description: "Sends payment parameters (like amount, country, and currency)\
|
|
\ together with other required input details collected from the shopper. To\
|
|
\ know more about required parameters for specific payment methods, refer\
|
|
\ to our [payment method guides](https://docs.adyen.com/payment-methods).\
|
|
\ \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n\
|
|
* For a direct flow, the response includes a `pspReference` and a `resultCode`\
|
|
\ with the payment result, for example **Authorised** or **Refused**. \n*\
|
|
\ For a redirect or additional action, the response contains an `action` object. "
|
|
operationId: post-payments
|
|
x-sortIndex: 3
|
|
x-methodName: payments
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
applepay:
|
|
$ref: '#/components/examples/post-payments-applepay'
|
|
card-3d-secure-2-web:
|
|
$ref: '#/components/examples/post-payments-card-3d-secure-2-web'
|
|
card-3d-secure-redirect:
|
|
$ref: '#/components/examples/post-payments-card-3d-secure-redirect'
|
|
card-direct:
|
|
$ref: '#/components/examples/post-payments-card-direct'
|
|
card-securedfields:
|
|
$ref: '#/components/examples/post-payments-card-securedfields'
|
|
enableOneClick-SF:
|
|
$ref: '#/components/examples/post-payments-enableOneClick-SF'
|
|
googlepay:
|
|
$ref: '#/components/examples/post-payments-googlepay'
|
|
ideal:
|
|
$ref: '#/components/examples/post-payments-ideal'
|
|
klarna:
|
|
$ref: '#/components/examples/post-payments-klarna'
|
|
oneclick-securedfields:
|
|
$ref: '#/components/examples/post-payments-oneclick-securedfields'
|
|
recurring:
|
|
$ref: '#/components/examples/post-payments-recurring'
|
|
split-balanceplatform:
|
|
$ref: '#/components/examples/post-payments-split-balanceplatform'
|
|
split-classic:
|
|
$ref: '#/components/examples/post-payments-split-classic'
|
|
subscription-first-transaction:
|
|
$ref: '#/components/examples/post-payments-subscription-first-transaction'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
card-3d-secure-2-web:
|
|
$ref: '#/components/examples/post-payments-card-3d-secure-2-web-200'
|
|
card-3d-secure-redirect:
|
|
$ref: '#/components/examples/post-payments-card-3d-secure-redirect-200'
|
|
card-direct:
|
|
$ref: '#/components/examples/post-payments-card-direct-200'
|
|
card-securedfields:
|
|
$ref: '#/components/examples/post-payments-card-securedfields-200'
|
|
enableOneClick-SF:
|
|
$ref: '#/components/examples/post-payments-enableOneClick-SF-200'
|
|
ideal:
|
|
$ref: '#/components/examples/post-payments-ideal-200'
|
|
split-balanceplatform:
|
|
$ref: '#/components/examples/post-payments-split-balanceplatform-200'
|
|
subscription-first-transaction:
|
|
$ref: '#/components/examples/post-payments-subscription-first-transaction-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:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/payments/details:
|
|
post:
|
|
tags:
|
|
- Payments
|
|
summary: Submit details for a payment
|
|
description: 'Submits details for a payment created using `/payments`. This
|
|
step is only needed when no final state has been reached on the `/payments`
|
|
request, for example when the shopper was redirected to another page to complete
|
|
the payment.
|
|
|
|
|
|
'
|
|
operationId: post-payments-details
|
|
x-sortIndex: 4
|
|
x-methodName: paymentsDetails
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
00.redirect:
|
|
$ref: '#/components/examples/post-payments-details-00.redirect'
|
|
3d-secure-2-native:
|
|
$ref: '#/components/examples/post-payments-details-3d-secure-2-native'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentDetailsRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
00.redirect:
|
|
$ref: '#/components/examples/post-payments-details-00.redirect-200'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentDetailsResponse'
|
|
description: OK - the request has succeeded.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/payments/{paymentPspReference}/amountUpdates:
|
|
post:
|
|
tags:
|
|
- Modifications
|
|
summary: Update an authorised amount
|
|
description: 'Increases or decreases the authorised payment amount and returns
|
|
a unique reference for this request. You get the outcome of the request asynchronously,
|
|
in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).
|
|
|
|
|
|
You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).
|
|
|
|
|
|
The amount you specify in the request is the updated amount, which is larger
|
|
or smaller than the initial authorised amount.
|
|
|
|
|
|
For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).'
|
|
operationId: post-payments-paymentPspReference-amountUpdates
|
|
x-sortIndex: 6
|
|
x-methodName: updateAuthorisedAmount
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
amount-update:
|
|
$ref: '#/components/examples/post-payments-paymentPspReference-amountUpdates-amount-update'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentAmountUpdateRequest'
|
|
parameters:
|
|
- description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
|
|
of the payment.
|
|
name: paymentPspReference
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
amount-update:
|
|
$ref: '#/components/examples/post-payments-paymentPspReference-amountUpdates-amount-update-201'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentAmountUpdateResponse'
|
|
description: Created - the request has been fulfilled and has resulted in
|
|
one or more new resources being created.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/payments/{paymentPspReference}/cancels:
|
|
post:
|
|
tags:
|
|
- Modifications
|
|
summary: Cancel an authorised payment
|
|
description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),
|
|
and returns a unique reference for this request. You get the outcome of the
|
|
request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).
|
|
|
|
|
|
If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference),
|
|
use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels)
|
|
endpoint instead.
|
|
|
|
|
|
If you want to cancel a payment but are not sure whether it has been captured,
|
|
use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)
|
|
endpoint instead.
|
|
|
|
|
|
For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).'
|
|
operationId: post-payments-paymentPspReference-cancels
|
|
x-sortIndex: 2
|
|
x-methodName: cancelAuthorisedPaymentByPspReference
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
cancel-with-psp-reference:
|
|
$ref: '#/components/examples/post-payments-paymentPspReference-cancels-cancel-with-psp-reference'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentCancelRequest'
|
|
parameters:
|
|
- description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
|
|
of the payment that you want to cancel. '
|
|
name: paymentPspReference
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
cancel-with-psp-reference:
|
|
$ref: '#/components/examples/post-payments-paymentPspReference-cancels-cancel-with-psp-reference-201'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentCancelResponse'
|
|
description: Created - the request has been fulfilled and has resulted in
|
|
one or more new resources being created.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/payments/{paymentPspReference}/captures:
|
|
post:
|
|
tags:
|
|
- Modifications
|
|
summary: Capture an authorised payment
|
|
description: " Captures an authorised payment and returns a unique reference\
|
|
\ for this request. You get the outcome of the request asynchronously, in\
|
|
\ a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\
|
|
\nYou can capture either the full authorised amount or a part of the authorised\
|
|
\ amount. By default, any unclaimed amount after a partial capture gets cancelled.\
|
|
\ This does not apply if you enabled multiple partial captures on your account\
|
|
\ and the payment method supports multiple partial captures. \n\n[Automatic\
|
|
\ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\
|
|
\ is the default setting for most payment methods. In these cases, you don't\
|
|
\ need to make capture requests. However, making capture requests for payments\
|
|
\ that are captured automatically does not result in double charges.\n\nFor\
|
|
\ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)."
|
|
operationId: post-payments-paymentPspReference-captures
|
|
x-sortIndex: 1
|
|
x-methodName: captureAuthorisedPayment
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
capture:
|
|
$ref: '#/components/examples/post-payments-paymentPspReference-captures-capture'
|
|
split-balanceplatform:
|
|
$ref: '#/components/examples/post-payments-paymentPspReference-captures-split-balanceplatform'
|
|
split-classic:
|
|
$ref: '#/components/examples/post-payments-paymentPspReference-captures-split-classic'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentCaptureRequest'
|
|
parameters:
|
|
- description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
|
|
of the payment that you want to capture.
|
|
name: paymentPspReference
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
capture:
|
|
$ref: '#/components/examples/post-payments-paymentPspReference-captures-capture-201'
|
|
split-balanceplatform:
|
|
$ref: '#/components/examples/post-payments-paymentPspReference-captures-split-balanceplatform-201'
|
|
split-classic:
|
|
$ref: '#/components/examples/post-payments-paymentPspReference-captures-split-classic-201'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentCaptureResponse'
|
|
description: Created - the request has been fulfilled and has resulted in
|
|
one or more new resources being created.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/payments/{paymentPspReference}/refunds:
|
|
post:
|
|
tags:
|
|
- Modifications
|
|
summary: Refund a captured payment
|
|
description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\
|
|
\ and returns a unique reference for this request. You get the outcome of\
|
|
\ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\
|
|
\nYou can refund either the full captured amount or a part of the captured\
|
|
\ amount. You can also perform multiple partial refunds, as long as their\
|
|
\ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\
|
|
\ support partial refunds. To learn if a payment method supports partial refunds,\
|
|
\ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\
|
|
\ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\
|
|
\ \n\nIf you want to refund a payment but are not sure whether it has been\
|
|
\ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\
|
|
\ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)."
|
|
operationId: post-payments-paymentPspReference-refunds
|
|
x-sortIndex: 4
|
|
x-methodName: refundCapturedPayment
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
refund:
|
|
$ref: '#/components/examples/post-payments-paymentPspReference-refunds-refund'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentRefundRequest'
|
|
parameters:
|
|
- description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
|
|
of the payment that you want to refund.
|
|
name: paymentPspReference
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
refund:
|
|
$ref: '#/components/examples/post-payments-paymentPspReference-refunds-refund-201'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentRefundResponse'
|
|
description: Created - the request has been fulfilled and has resulted in
|
|
one or more new resources being created.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/payments/{paymentPspReference}/reversals:
|
|
post:
|
|
tags:
|
|
- Modifications
|
|
summary: Refund or cancel a payment
|
|
description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds)
|
|
a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels)
|
|
a payment if it has not yet been captured. Returns a unique reference for
|
|
this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND**
|
|
webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).
|
|
|
|
|
|
The reversed amount is always the full payment amount.
|
|
|
|
> Do not use this request for payments that involve multiple partial captures.
|
|
|
|
|
|
For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).'
|
|
operationId: post-payments-paymentPspReference-reversals
|
|
x-sortIndex: 5
|
|
x-methodName: refundOrCancelPayment
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
reversal:
|
|
$ref: '#/components/examples/post-payments-paymentPspReference-reversals-reversal'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentReversalRequest'
|
|
parameters:
|
|
- description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
|
|
of the payment that you want to reverse. '
|
|
name: paymentPspReference
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
reversal:
|
|
$ref: '#/components/examples/post-payments-paymentPspReference-reversals-reversal-201'
|
|
schema:
|
|
$ref: '#/components/schemas/PaymentReversalResponse'
|
|
description: Created - the request has been fulfilled and has resulted in
|
|
one or more new resources being created.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/paypal/updateOrder:
|
|
post:
|
|
tags:
|
|
- Utility
|
|
summary: Updates the order for PayPal Express Checkout
|
|
description: Updates the order for PayPal Express Checkout. This can be used
|
|
to update the PayPal lightbox with an updated amount and delivery methods
|
|
based on the delivery address.
|
|
operationId: post-paypal-updateOrder
|
|
x-sortIndex: 3
|
|
x-methodName: updatesOrderForPaypalExpressCheckout
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
advanced-with-delivery:
|
|
$ref: '#/components/examples/post-paypal-updateOrder-advanced-with-delivery'
|
|
advanced-without-delivery:
|
|
$ref: '#/components/examples/post-paypal-updateOrder-advanced-without-delivery'
|
|
sessions-with-delivery:
|
|
$ref: '#/components/examples/post-paypal-updateOrder-sessions-with-delivery'
|
|
sessions-without-delivery:
|
|
$ref: '#/components/examples/post-paypal-updateOrder-sessions-without-delivery'
|
|
schema:
|
|
$ref: '#/components/schemas/PaypalUpdateOrderRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
advanced-with-delivery:
|
|
$ref: '#/components/examples/post-paypal-updateOrder-advanced-with-delivery-200'
|
|
advanced-without-delivery:
|
|
$ref: '#/components/examples/post-paypal-updateOrder-advanced-without-delivery-200'
|
|
sessions-with-delivery:
|
|
$ref: '#/components/examples/post-paypal-updateOrder-sessions-with-delivery-200'
|
|
sessions-without-delivery:
|
|
$ref: '#/components/examples/post-paypal-updateOrder-sessions-without-delivery-200'
|
|
schema:
|
|
$ref: '#/components/schemas/PaypalUpdateOrderResponse'
|
|
description: OK - the request has succeeded.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
'400':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-401'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Unauthorized - authentication required.
|
|
'403':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$ref: '#/components/examples/generic-403'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Forbidden - insufficient permissions to process the request.
|
|
'422':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
generic:
|
|
$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:
|
|
$ref: '#/components/examples/generic-500'
|
|
schema:
|
|
$ref: '#/components/schemas/ServiceError'
|
|
description: Internal Server Error - the server could not process the request.
|
|
/sessions:
|
|
post:
|
|
tags:
|
|
- Payments
|
|
summary: Create a payment session
|
|
description: 'Creates a payment session for [Drop-in](https://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web&integration=Drop-in),
|
|
[Components](https://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web&integration=Components),
|
|
and [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web&integration=Hosted+Checkout)
|
|
integrations.
|
|
|
|
|
|
The response contains encrypted payment session data. The front end then uses
|
|
the session data to make any required server-side calls for the payment flow.
|
|
|
|
|
|
You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION)
|
|
webhook.'
|
|
x-addedInVersion: '68'
|
|
operationId: post-sessions
|
|
x-sortIndex: 1
|
|
x-methodName: sessions
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
00.success:
|
|
$ref: '#/components/examples/post-sessions-00.success'
|
|
01.klarna:
|
|
$ref: '#/components/examples/post-sessions-01.klarna'
|
|
enableOneClick:
|
|
$ref: '#/components/examples/post-sessions-enableOneClick'
|
|
split:
|
|
$ref: '#/components/examples/post-sessions-split'
|
|
schema:
|
|
$ref: '#/components/schemas/CreateCheckoutSessionRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
00.success:
|
|
$ref: '#/components/examples/post-sessions-00.success-201'
|
|
01.klarna:
|
|
$ref: '#/components/examples/post-sessions-01.klarna-201'
|
|
enableOneClick:
|
|
$ref: '#/components/examples/post-sessions-enableOneClick-201'
|
|
split:
|
|
$ref: '#/components/examples/post-sessions-split-201'
|
|
schema:
|
|
$ref: '#/components/schemas/CreateCheckoutSessionResponse'
|
|
description: Created - the request has been fulfilled and has resulted in
|
|
one or more new resources being created.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
/sessions/{sessionId}:
|
|
get:
|
|
tags:
|
|
- Payments
|
|
summary: Get the result of a payment session
|
|
description: Returns the status of the payment session with the `sessionId`
|
|
and `sessionResult` specified in the path.
|
|
x-addedInVersion: '68'
|
|
operationId: get-sessions-sessionId
|
|
x-sortIndex: 2
|
|
x-methodName: getResultOfPaymentSession
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
parameters:
|
|
- description: A unique identifier of the session.
|
|
name: sessionId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: The `sessionResult` value from the Drop-in or Component.
|
|
name: sessionResult
|
|
in: query
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
success:
|
|
$ref: '#/components/examples/get-sessions-sessionId-success-200'
|
|
schema:
|
|
$ref: '#/components/schemas/SessionResultResponse'
|
|
description: OK - the request has succeeded.
|
|
/storedPaymentMethods:
|
|
get:
|
|
tags:
|
|
- Recurring
|
|
summary: Get tokens for stored payment details
|
|
description: 'Lists the tokens for stored payment details for the shopper identified
|
|
in the path, if there are any available. The token ID can be used with payment
|
|
requests for the shopper''s payment. A summary of the stored details is included.
|
|
|
|
|
|
'
|
|
x-addedInVersion: '70'
|
|
operationId: get-storedPaymentMethods
|
|
x-sortIndex: 2
|
|
x-methodName: getTokensForStoredPaymentDetails
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
parameters:
|
|
- description: 'Your reference to uniquely identify this shopper, for example
|
|
user ID or account ID. Minimum length: 3 characters.
|
|
|
|
> Your reference must not include personally identifiable information (PII),
|
|
for example name or email address.'
|
|
name: shopperReference
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- description: Your merchant account.
|
|
name: merchantAccount
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
success:
|
|
$ref: '#/components/examples/get-storedPaymentMethods-success-200'
|
|
schema:
|
|
$ref: '#/components/schemas/ListStoredPaymentMethodsResponse'
|
|
description: OK - the request has succeeded.
|
|
post:
|
|
tags:
|
|
- Recurring
|
|
summary: Create a token to store payment details
|
|
description: Creates a token to store the shopper's payment details. This token
|
|
can be used for the shopper's future payments.
|
|
operationId: post-storedPaymentMethods
|
|
x-sortIndex: 1
|
|
x-methodName: storedPaymentMethods
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
examples:
|
|
encrypted-card-details:
|
|
$ref: '#/components/examples/post-storedPaymentMethods-encrypted-card-details'
|
|
unencrypted-card-details:
|
|
$ref: '#/components/examples/post-storedPaymentMethods-unencrypted-card-details'
|
|
schema:
|
|
$ref: '#/components/schemas/StoredPaymentMethodRequest'
|
|
parameters:
|
|
- $ref: '#/components/parameters/Idempotency-Key'
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
examples:
|
|
encrypted-card-details:
|
|
$ref: '#/components/examples/post-storedPaymentMethods-encrypted-card-details-201'
|
|
unencrypted-card-details:
|
|
$ref: '#/components/examples/post-storedPaymentMethods-unencrypted-card-details-201'
|
|
schema:
|
|
$ref: '#/components/schemas/StoredPaymentMethodResource'
|
|
description: Created - the request has been fulfilled and has resulted in
|
|
one or more new resources being created.
|
|
headers:
|
|
Idempotency-Key:
|
|
$ref: '#/components/headers/Idempotency-Key'
|
|
/storedPaymentMethods/{storedPaymentMethodId}:
|
|
delete:
|
|
tags:
|
|
- Recurring
|
|
summary: Delete a token for stored payment details
|
|
description: Deletes the token identified in the path. The token can no longer
|
|
be used with payment requests.
|
|
x-addedInVersion: '70'
|
|
operationId: delete-storedPaymentMethods-storedPaymentMethodId
|
|
x-sortIndex: 4
|
|
x-methodName: deleteTokenForStoredPaymentDetails
|
|
security:
|
|
- BasicAuth: []
|
|
- ApiKeyAuth: []
|
|
parameters:
|
|
- description: The unique identifier of the token.
|
|
name: storedPaymentMethodId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: 'Your reference to uniquely identify this shopper, for example
|
|
user ID or account ID. Minimum length: 3 characters.
|
|
|
|
> Your reference must not include personally identifiable information (PII),
|
|
for example name or email address.'
|
|
name: shopperReference
|
|
in: query
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- description: Your merchant account.
|
|
name: merchantAccount
|
|
in: query
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'204':
|
|
description: 'No Content - look at the actual response code for the status
|
|
of the request. '
|
|
components:
|
|
schemas:
|
|
AccountInfo:
|
|
additionalProperties: false
|
|
properties:
|
|
accountAgeIndicator:
|
|
description: 'Indicator for the length of time since this shopper account
|
|
was created in the merchant''s environment.
|
|
|
|
Allowed values:
|
|
|
|
* notApplicable
|
|
|
|
* thisTransaction
|
|
|
|
* lessThan30Days
|
|
|
|
* from30To60Days
|
|
|
|
* moreThan60Days'
|
|
enum:
|
|
- notApplicable
|
|
- thisTransaction
|
|
- lessThan30Days
|
|
- from30To60Days
|
|
- moreThan60Days
|
|
type: string
|
|
accountChangeDate:
|
|
description: Date when the shopper's account was last changed.
|
|
format: date-time
|
|
type: string
|
|
accountChangeIndicator:
|
|
description: 'Indicator for the length of time since the shopper''s account
|
|
was last updated.
|
|
|
|
Allowed values:
|
|
|
|
* thisTransaction
|
|
|
|
* lessThan30Days
|
|
|
|
* from30To60Days
|
|
|
|
* moreThan60Days'
|
|
enum:
|
|
- thisTransaction
|
|
- lessThan30Days
|
|
- from30To60Days
|
|
- moreThan60Days
|
|
type: string
|
|
accountCreationDate:
|
|
description: Date when the shopper's account was created.
|
|
format: date-time
|
|
type: string
|
|
accountType:
|
|
x-addedInVersion: '50'
|
|
description: 'Indicates the type of account. For example, for a multi-account
|
|
card product.
|
|
|
|
Allowed values:
|
|
|
|
* notApplicable
|
|
|
|
* credit
|
|
|
|
* debit'
|
|
enum:
|
|
- notApplicable
|
|
- credit
|
|
- debit
|
|
type: string
|
|
addCardAttemptsDay:
|
|
description: Number of attempts the shopper tried to add a card to their
|
|
account in the last day.
|
|
format: int32
|
|
type: integer
|
|
deliveryAddressUsageDate:
|
|
description: Date the selected delivery address was first used.
|
|
format: date-time
|
|
type: string
|
|
deliveryAddressUsageIndicator:
|
|
description: 'Indicator for the length of time since this delivery address
|
|
was first used.
|
|
|
|
Allowed values:
|
|
|
|
* thisTransaction
|
|
|
|
* lessThan30Days
|
|
|
|
* from30To60Days
|
|
|
|
* moreThan60Days'
|
|
enum:
|
|
- thisTransaction
|
|
- lessThan30Days
|
|
- from30To60Days
|
|
- moreThan60Days
|
|
type: string
|
|
homePhone:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '68'
|
|
x-deprecatedMessage: Use `ThreeDS2RequestData.homePhone` instead.
|
|
description: Shopper's home phone number (including the country code).
|
|
type: string
|
|
mobilePhone:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '68'
|
|
x-deprecatedMessage: Use `ThreeDS2RequestData.mobilePhone` instead.
|
|
description: Shopper's mobile phone number (including the country code).
|
|
type: string
|
|
passwordChangeDate:
|
|
description: Date when the shopper last changed their password.
|
|
format: date-time
|
|
type: string
|
|
passwordChangeIndicator:
|
|
description: 'Indicator when the shopper has changed their password.
|
|
|
|
Allowed values:
|
|
|
|
* notApplicable
|
|
|
|
* thisTransaction
|
|
|
|
* lessThan30Days
|
|
|
|
* from30To60Days
|
|
|
|
* moreThan60Days'
|
|
enum:
|
|
- notApplicable
|
|
- thisTransaction
|
|
- lessThan30Days
|
|
- from30To60Days
|
|
- moreThan60Days
|
|
type: string
|
|
pastTransactionsDay:
|
|
description: Number of all transactions (successful and abandoned) from
|
|
this shopper in the past 24 hours.
|
|
format: int32
|
|
type: integer
|
|
pastTransactionsYear:
|
|
description: Number of all transactions (successful and abandoned) from
|
|
this shopper in the past year.
|
|
format: int32
|
|
type: integer
|
|
paymentAccountAge:
|
|
description: Date this payment method was added to the shopper's account.
|
|
format: date-time
|
|
type: string
|
|
paymentAccountIndicator:
|
|
description: 'Indicator for the length of time since this payment method
|
|
was added to this shopper''s account.
|
|
|
|
Allowed values:
|
|
|
|
* notApplicable
|
|
|
|
* thisTransaction
|
|
|
|
* lessThan30Days
|
|
|
|
* from30To60Days
|
|
|
|
* moreThan60Days'
|
|
enum:
|
|
- notApplicable
|
|
- thisTransaction
|
|
- lessThan30Days
|
|
- from30To60Days
|
|
- moreThan60Days
|
|
type: string
|
|
purchasesLast6Months:
|
|
description: Number of successful purchases in the last six months.
|
|
format: int32
|
|
type: integer
|
|
suspiciousActivity:
|
|
description: Whether suspicious activity was recorded on this account.
|
|
type: boolean
|
|
workPhone:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '68'
|
|
x-deprecatedMessage: Use `ThreeDS2RequestData.workPhone` instead.
|
|
description: Shopper's work phone number (including the country code).
|
|
type: string
|
|
type: object
|
|
AcctInfo:
|
|
additionalProperties: false
|
|
properties:
|
|
chAccAgeInd:
|
|
description: "Length of time that the cardholder has had the account with\
|
|
\ the 3DS Requestor. \nAllowed values:\n* **01** \u2014 No account\n*\
|
|
\ **02** \u2014 Created during this transaction\n* **03** \u2014 Less\
|
|
\ than 30 days\n* **04** \u2014 30\u201360 days\n* **05** \u2014 More\
|
|
\ than 60 days"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
- '05'
|
|
maxLength: 2
|
|
minLength: 2
|
|
type: string
|
|
chAccChange:
|
|
description: "Date that the cardholder\u2019s account with the 3DS Requestor\
|
|
\ was last changed, including Billing or Shipping address, new payment\
|
|
\ account, or new user(s) added. \nFormat: **YYYYMMDD**"
|
|
type: string
|
|
chAccChangeInd:
|
|
description: "Length of time since the cardholder\u2019s account information\
|
|
\ with the 3DS Requestor was last changed, including Billing or Shipping\
|
|
\ address, new payment account, or new user(s) added. \nAllowed values:\n\
|
|
* **01** \u2014 Changed during this transaction\n* **02** \u2014 Less\
|
|
\ than 30 days\n* **03** \u2014 30\u201360 days\n* **04** \u2014 More\
|
|
\ than 60 days"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
maxLength: 2
|
|
minLength: 2
|
|
type: string
|
|
chAccPwChange:
|
|
description: "Date that cardholder\u2019s account with the 3DS Requestor\
|
|
\ had a password change or account reset. \nFormat: **YYYYMMDD**"
|
|
type: string
|
|
chAccPwChangeInd:
|
|
description: "Indicates the length of time since the cardholder\u2019s account\
|
|
\ with the 3DS Requestor had a password change or account reset. \nAllowed\
|
|
\ values:\n* **01** \u2014 No change\n* **02** \u2014 Changed during this\
|
|
\ transaction\n* **03** \u2014 Less than 30 days\n* **04** \u2014 30\u2013\
|
|
60 days\n* **05** \u2014 More than 60 days"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
- '05'
|
|
maxLength: 2
|
|
minLength: 2
|
|
type: string
|
|
chAccString:
|
|
description: "Date that the cardholder opened the account with the 3DS Requestor.\
|
|
\ \nFormat: **YYYYMMDD**"
|
|
type: string
|
|
nbPurchaseAccount:
|
|
description: 'Number of purchases with this cardholder account during the
|
|
previous six months. Max length: 4 characters.'
|
|
type: string
|
|
paymentAccAge:
|
|
description: "String that the payment account was enrolled in the cardholder\u2019\
|
|
s account with the 3DS Requestor. \nFormat: **YYYYMMDD**"
|
|
type: string
|
|
paymentAccInd:
|
|
description: "Indicates the length of time that the payment account was\
|
|
\ enrolled in the cardholder\u2019s account with the 3DS Requestor. \n\
|
|
Allowed values:\n* **01** \u2014 No account (guest checkout)\n* **02**\
|
|
\ \u2014 During this transaction\n* **03** \u2014 Less than 30 days\n\
|
|
* **04** \u2014 30\u201360 days\n* **05** \u2014 More than 60 days"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
- '05'
|
|
maxLength: 2
|
|
minLength: 2
|
|
type: string
|
|
provisionAttemptsDay:
|
|
description: 'Number of Add Card attempts in the last 24 hours. Max length:
|
|
3 characters.'
|
|
type: string
|
|
shipAddressUsage:
|
|
description: "String when the shipping address used for this transaction\
|
|
\ was first used with the 3DS Requestor. \nFormat: **YYYYMMDD**"
|
|
type: string
|
|
shipAddressUsageInd:
|
|
description: "Indicates when the shipping address used for this transaction\
|
|
\ was first used with the 3DS Requestor. \nAllowed values:\n* **01** \u2014\
|
|
\ This transaction\n* **02** \u2014 Less than 30 days\n* **03** \u2014\
|
|
\ 30\u201360 days\n* **04** \u2014 More than 60 days"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
maxLength: 2
|
|
minLength: 2
|
|
type: string
|
|
shipNameIndicator:
|
|
description: "Indicates if the Cardholder Name on the account is identical\
|
|
\ to the shipping Name used for this transaction. \nAllowed values:\n\
|
|
* **01** \u2014 Account Name identical to shipping Name\n* **02** \u2014\
|
|
\ Account Name different to shipping Name"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
maxLength: 2
|
|
minLength: 2
|
|
type: string
|
|
suspiciousAccActivity:
|
|
description: "Indicates whether the 3DS Requestor has experienced suspicious\
|
|
\ activity (including previous fraud) on the cardholder account. \nAllowed\
|
|
\ values:\n* **01** \u2014 No suspicious activity has been observed\n\
|
|
* **02** \u2014 Suspicious activity has been observed"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
maxLength: 2
|
|
minLength: 2
|
|
type: string
|
|
txnActivityDay:
|
|
description: 'Number of transactions (successful and abandoned) for this
|
|
cardholder account with the 3DS Requestor across all payment accounts
|
|
in the previous 24 hours. Max length: 3 characters.'
|
|
maxLength: 3
|
|
type: string
|
|
txnActivityYear:
|
|
description: 'Number of transactions (successful and abandoned) for this
|
|
cardholder account with the 3DS Requestor across all payment accounts
|
|
in the previous year. Max length: 3 characters.'
|
|
maxLength: 3
|
|
type: string
|
|
type: object
|
|
AchDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
accountHolderType:
|
|
description: The account holder type (personal or business).
|
|
enum:
|
|
- business
|
|
- personal
|
|
type: string
|
|
bankAccountNumber:
|
|
description: The bank account number (without separators).
|
|
type: string
|
|
bankAccountType:
|
|
description: The bank account type (checking, savings...).
|
|
enum:
|
|
- balance
|
|
- checking
|
|
- deposit
|
|
- general
|
|
- other
|
|
- payment
|
|
- savings
|
|
type: string
|
|
bankLocationId:
|
|
description: The bank routing number of the account. The field value is
|
|
`nil` in most cases.
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
encryptedBankAccountNumber:
|
|
description: Encrypted bank account number. The bank account number (without
|
|
separators).
|
|
type: string
|
|
encryptedBankLocationId:
|
|
description: Encrypted location id. The bank routing number of the account.
|
|
The field value is `nil` in most cases.
|
|
type: string
|
|
ownerName:
|
|
description: "The name of the bank account holder.\nIf you submit a name\
|
|
\ with non-Latin characters, we automatically replace some of them with\
|
|
\ corresponding Latin characters to meet the FATF recommendations. For\
|
|
\ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\
|
|
\ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\
|
|
\ accept '\xF8'.\nAfter replacement, the ownerName must have at least\
|
|
\ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\
|
|
\ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\
|
|
\ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\
|
|
> If provided details don't match the required format, the response returns\
|
|
\ the error message: 203 'Invalid bank account holder name'."
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
transferInstrumentId:
|
|
description: The unique identifier of your user's verified transfer instrument,
|
|
which you can use to top up their balance accounts.
|
|
type: string
|
|
type:
|
|
default: ach
|
|
description: '**ach**'
|
|
enum:
|
|
- ach
|
|
- ach_plaid
|
|
type: string
|
|
title: ACH Direct Debit
|
|
type: object
|
|
AdditionalData3DSecure:
|
|
additionalProperties: false
|
|
properties:
|
|
allow3DS2:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '69'
|
|
x-deprecatedMessage: Use `authenticationData.threeDSRequestData.nativeThreeDS`
|
|
instead.
|
|
description: "Indicates if you are able to process 3D Secure 2 transactions\
|
|
\ natively on your payment page. Send this parameter when you are using\
|
|
\ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\
|
|
\n > This parameter only indicates readiness to support native 3D Secure\
|
|
\ 2 authentication. To specify if you _want_ to perform 3D Secure, use\
|
|
\ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\
|
|
\ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\
|
|
\ support native 3D Secure 2 authentication. Setting this to true does\
|
|
\ not mean always applying 3D Secure 2. Adyen selects redirect or native\
|
|
\ authentication based on your configuration to optimize authorization\
|
|
\ rates and improve the shopper's experience.\n* **false** \u2013 Not\
|
|
\ ready to support native 3D Secure 2 authentication. Adyen offers redirect\
|
|
\ 3D Secure 2 authentication instead, based on your configuration.\n"
|
|
type: string
|
|
challengeWindowSize:
|
|
description: "Dimensions of the 3DS2 challenge window to be displayed to\
|
|
\ the cardholder.\n\nPossible values:\n\n* **01** - size of 250x400 \n\
|
|
* **02** - size of 390x400\n* **03** - size of 500x600\n* **04** - size\
|
|
\ of 600x400\n* **05** - Fullscreen"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
- '05'
|
|
type: string
|
|
executeThreeD:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '69'
|
|
x-deprecatedMessage: Use [`authenticationData.attemptAuthentication`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments?target=_blank#request-authenticationData-attemptAuthentication)
|
|
instead
|
|
description: "Indicates if you want to perform 3D Secure authentication\
|
|
\ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\
|
|
\ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\
|
|
\ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\
|
|
\ 3D Secure authentication. Note that this setting results in refusals\
|
|
\ if the issuer mandates 3D Secure because of the PSD2 directive or other,\
|
|
\ national regulations. \n"
|
|
type: string
|
|
mpiImplementationType:
|
|
description: In case of Secure+, this field must be set to **CUPSecurePlus**.
|
|
type: string
|
|
scaExemption:
|
|
description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\
|
|
\ that you want to request for the transaction.\n\n Possible values:\n\
|
|
* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\
|
|
\ **transactionRiskAnalysis** "
|
|
type: string
|
|
threeDSVersion:
|
|
description: "Indicates your preference for the 3D Secure version. \n> If\
|
|
\ you use this parameter, you override the checks from Adyen's Authentication\
|
|
\ Engine. We recommend to use this field only if you have an extensive\
|
|
\ knowledge of 3D Secure.\n\nPossible values:\n* **2.1.0**: Apply 3D Secure\
|
|
\ version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the\
|
|
\ issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\
|
|
\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive\
|
|
\ a negative `transStatus` in the `ARes`, we will apply the fallback policy\
|
|
\ configured in your account.\n* If you the BIN is not enrolled, you will\
|
|
\ receive an error.\n\n"
|
|
type: string
|
|
type: object
|
|
AdditionalDataAirline:
|
|
additionalProperties: false
|
|
properties:
|
|
airline.agency_invoice_number:
|
|
description: 'The reference number for the invoice, issued by the agency.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 6 characters'
|
|
type: string
|
|
airline.agency_plan_name:
|
|
description: 'The two-letter agency plan identifier.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 2 characters
|
|
|
|
* maxLength: 2 characters'
|
|
type: string
|
|
airline.airline_code:
|
|
description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
|
|
3-digit accounting code (PAX) that identifies the carrier.
|
|
|
|
* Format: IATA 3-digit accounting code (PAX)
|
|
|
|
* Example: KLM = 074
|
|
|
|
* minLength: 3 characters
|
|
|
|
* maxLength: 3 characters
|
|
|
|
* Must not be all spaces
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
airline.airline_designator_code:
|
|
description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
|
|
2-letter accounting code (PAX) that identifies the carrier.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* Example: KLM = KL
|
|
|
|
* minLength: 2 characters
|
|
|
|
* maxLength: 2 characters
|
|
|
|
* Must not be all spaces
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
airline.boarding_fee:
|
|
description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* Encoding: Numeric
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 18 characters'
|
|
type: string
|
|
airline.computerized_reservation_system:
|
|
description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system)
|
|
used to make the reservation and purchase the ticket.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 4 characters
|
|
|
|
* maxLength: 4 characters'
|
|
type: string
|
|
airline.customer_reference_number:
|
|
description: 'The alphanumeric customer reference number.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* maxLength: 20 characters
|
|
|
|
* If you send more than 20 characters, the customer reference number is
|
|
truncated
|
|
|
|
* Must not be all spaces'
|
|
type: string
|
|
airline.document_type:
|
|
description: 'A code that identifies the type of item bought. The description
|
|
of the code can appear on credit card statements.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* Example: Passenger ticket = 01
|
|
|
|
* minLength: 2 characters
|
|
|
|
* maxLength: 2 characters'
|
|
type: string
|
|
airline.flight_date:
|
|
description: 'The flight departure date. Local time `(HH:mm)` is optional.
|
|
|
|
* Date format: `yyyy-MM-dd`
|
|
|
|
* Date and time format: `yyyy-MM-dd HH:mm`
|
|
|
|
* minLength: 10 characters
|
|
|
|
* maxLength: 16 characters'
|
|
type: string
|
|
airline.issue_date:
|
|
description: 'The date that the ticket was issued to the passenger.
|
|
|
|
* minLength: 6 characters
|
|
|
|
* maxLength: 6 characters
|
|
|
|
* Date format: YYMMDD'
|
|
type: string
|
|
airline.leg.carrier_code:
|
|
description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
|
|
2-letter accounting code (PAX) that identifies the carrier.
|
|
|
|
This field is required if the airline data includes leg details.
|
|
|
|
* Example: KLM = KL
|
|
|
|
* minLength: 2 characters
|
|
|
|
* maxLength: 2 characters
|
|
|
|
* Must not be all spaces
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
airline.leg.class_of_travel:
|
|
description: "A one-letter travel class identifier.\n The following are\
|
|
\ common:\n * F: first class\n* J: business class\n* Y: economy class\n\
|
|
* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\
|
|
* maxLength: 1 character\n* Must not be all spaces\n* Must not be all\
|
|
\ zeros."
|
|
type: string
|
|
airline.leg.date_of_travel:
|
|
description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\
|
|
\ format `yyyy-MM-dd HH:mm`.\n* Encoding: ASCII\n* minLength: 16 characters\n\
|
|
* maxLength: 16 characters"
|
|
type: string
|
|
airline.leg.depart_airport:
|
|
description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
|
|
three-letter airport code of the departure airport.
|
|
|
|
This field is required if the airline data includes leg details.
|
|
|
|
|
|
* Encoding: ASCII
|
|
|
|
* Example: Amsterdam = AMS
|
|
|
|
* minLength: 3 characters
|
|
|
|
* maxLength: 3 characters
|
|
|
|
* Must not be all spaces
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
airline.leg.depart_tax:
|
|
description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax)
|
|
charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* Encoding: Numeric
|
|
|
|
* minLength: 1
|
|
|
|
* maxLength: 12
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
airline.leg.destination_code:
|
|
description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
|
|
3-letter airport code of the destination airport.
|
|
|
|
This field is required if the airline data includes leg details.
|
|
|
|
* Example: Amsterdam = AMS
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 3 characters
|
|
|
|
* maxLength: 3 characters
|
|
|
|
* Must not be all spaces
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
airline.leg.fare_base_code:
|
|
description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code),
|
|
alphanumeric.
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 6 characters
|
|
|
|
* Must not be all spaces
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
airline.leg.flight_number:
|
|
description: 'The flight identifier.
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 5 characters
|
|
|
|
* Must not be all spaces
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
airline.leg.stop_over_code:
|
|
description: 'A one-letter code that indicates whether the passenger is
|
|
entitled to make a stopover. Can be a space, O if the passenger is entitled
|
|
to make a stopover, or X if they are not.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 1 character'
|
|
type: string
|
|
airline.passenger.date_of_birth:
|
|
description: 'The passenger''s date of birth.
|
|
|
|
|
|
Date format: `yyyy-MM-dd`
|
|
|
|
* minLength: 10
|
|
|
|
* maxLength: 10'
|
|
type: string
|
|
airline.passenger.first_name:
|
|
description: 'The passenger''s first name.
|
|
|
|
> This field is required if the airline data includes passenger details
|
|
or leg details.
|
|
|
|
* Encoding: ASCII'
|
|
type: string
|
|
airline.passenger.last_name:
|
|
description: 'The passenger''s last name.
|
|
|
|
> This field is required if the airline data includes passenger details
|
|
or leg details.
|
|
|
|
* Encoding: ASCII'
|
|
type: string
|
|
airline.passenger.phone_number:
|
|
description: 'The passenger''s phone number, including country code. This
|
|
is an alphanumeric field that can include the ''+'' and ''-'' signs.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 3 characters
|
|
|
|
* maxLength: 30 characters'
|
|
type: string
|
|
airline.passenger.traveller_type:
|
|
description: 'The IATA passenger type code (PTC).
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 3 characters
|
|
|
|
* maxLength: 6 characters'
|
|
type: string
|
|
airline.passenger_name:
|
|
description: "The passenger's name, initials, and title.\n* Format: last\
|
|
\ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\
|
|
* minLength: 1 character\n* maxLength: 20 characters\n* If you send more\
|
|
\ than 20 characters, the name is truncated\n* Must not be all spaces\
|
|
\ \n* Must not be all zeros."
|
|
type: string
|
|
airline.ticket_issue_address:
|
|
description: 'The address of the organization that issued the ticket.
|
|
|
|
* minLength: 0 characters
|
|
|
|
* maxLength: 16 characters'
|
|
type: string
|
|
airline.ticket_number:
|
|
description: 'The ticket''s unique identifier.
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 15 characters
|
|
|
|
* Must not be all spaces
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
airline.travel_agency_code:
|
|
description: 'The unique identifier from IATA or ARC for the travel agency
|
|
that issues the ticket.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 8 characters
|
|
|
|
* Must not be all spaces
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
airline.travel_agency_name:
|
|
description: 'The name of the travel agency.
|
|
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 25 characters
|
|
|
|
* Must not be all spaces
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
required:
|
|
- airline.passenger_name
|
|
type: object
|
|
AdditionalDataCarRental:
|
|
additionalProperties: false
|
|
properties:
|
|
carRental.checkOutDate:
|
|
description: 'The pick-up date.
|
|
|
|
* Date format: `yyyyMMdd`'
|
|
type: string
|
|
carRental.customerServiceTollFreeNumber:
|
|
description: 'The customer service phone number of the car rental company.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* maxLength: 17
|
|
|
|
* For US and CA numbers must be 10 characters in length
|
|
|
|
* Must not start with a space
|
|
|
|
* Must not contain any special characters such as + or -
|
|
|
|
*Must not be all zeros.'
|
|
type: string
|
|
carRental.daysRented:
|
|
description: 'Number of days for which the car is being rented.
|
|
|
|
* Format: Numeric
|
|
|
|
* maxLength: 4
|
|
|
|
* Must not be all spaces'
|
|
type: string
|
|
carRental.fuelCharges:
|
|
description: 'Any fuel charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* Format: Numeric
|
|
|
|
* maxLength: 12'
|
|
type: string
|
|
carRental.insuranceCharges:
|
|
description: 'Any insurance charges associated with the rental, in [minor
|
|
units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* Format: Numeric
|
|
|
|
* maxLength: 12
|
|
|
|
* Must not be all spaces
|
|
|
|
*Must not be all zeros.'
|
|
type: string
|
|
carRental.locationCity:
|
|
description: 'The city where the car is rented.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* maxLength: 18
|
|
|
|
* Must not start with a space or be all spaces
|
|
|
|
*Must not be all zeros.'
|
|
type: string
|
|
carRental.locationCountry:
|
|
description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
|
|
format.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* maxLength: 2'
|
|
type: string
|
|
carRental.locationStateProvince:
|
|
description: 'The state or province where the car is rented.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* maxLength: 2
|
|
|
|
* Must not start with a space or be all spaces
|
|
|
|
*Must not be all zeros.'
|
|
type: string
|
|
carRental.noShowIndicator:
|
|
description: 'Indicates if the customer didn''t pick up their rental car.
|
|
|
|
* Y - Customer did not pick up their car
|
|
|
|
* N - Not applicable'
|
|
type: string
|
|
carRental.oneWayDropOffCharges:
|
|
description: 'The charge for not returning a car to the original rental
|
|
location, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* maxLength: 12'
|
|
type: string
|
|
carRental.rate:
|
|
description: 'The daily rental rate, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* maxLength: 12'
|
|
type: string
|
|
carRental.rateIndicator:
|
|
description: 'Specifies whether the given rate is applied daily or weekly.
|
|
|
|
* D - Daily rate
|
|
|
|
* W - Weekly rate'
|
|
type: string
|
|
carRental.rentalAgreementNumber:
|
|
description: 'The rental agreement number for the car rental.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* maxLength: 9
|
|
|
|
* Must not start with a space or be all spaces
|
|
|
|
*Must not be all zeros.'
|
|
type: string
|
|
carRental.rentalClassId:
|
|
description: 'The classification of the rental car.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* maxLength: 4
|
|
|
|
* Must not start with a space or be all spaces
|
|
|
|
*Must not be all zeros.'
|
|
type: string
|
|
carRental.renterName:
|
|
description: 'The name of the person renting the car.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* maxLength: 26
|
|
|
|
* If you send more than 26 characters, the name is truncated
|
|
|
|
* Must not start with a space or be all spaces
|
|
|
|
*Must not be all zeros.'
|
|
type: string
|
|
carRental.returnCity:
|
|
description: 'The city where the car must be returned.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* maxLength: 18
|
|
|
|
* Must not start with a space or be all spaces
|
|
|
|
*Must not be all zeros.'
|
|
type: string
|
|
carRental.returnCountry:
|
|
description: 'The country where the car must be returned, in [ISO 3166-1
|
|
alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* maxLength: 2'
|
|
type: string
|
|
carRental.returnDate:
|
|
description: 'The last date to return the car by.
|
|
|
|
* Date format: `yyyyMMdd`
|
|
|
|
* maxLength: 8'
|
|
type: string
|
|
carRental.returnLocationId:
|
|
description: 'The agency code, phone number, or address abbreviation
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* maxLength: 10
|
|
|
|
* Must not start with a space or be all spaces
|
|
|
|
*Must not be all zeros.'
|
|
type: string
|
|
carRental.returnStateProvince:
|
|
description: 'The state or province where the car must be returned.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* maxLength: 3
|
|
|
|
* Must not start with a space or be all spaces
|
|
|
|
*Must not be all zeros.'
|
|
type: string
|
|
carRental.taxExemptIndicator:
|
|
description: 'Indicates if the goods or services were tax-exempt, or if
|
|
tax was not paid on them.
|
|
|
|
|
|
Values:
|
|
|
|
* Y - Goods or services were tax exempt
|
|
|
|
* N - Tax was not collected'
|
|
type: string
|
|
travelEntertainmentAuthData.duration:
|
|
description: 'Number of days the car is rented for. This should be included
|
|
in the auth message.
|
|
|
|
* Format: Numeric
|
|
|
|
* maxLength: 4'
|
|
type: string
|
|
travelEntertainmentAuthData.market:
|
|
description: 'Indicates what market-specific dataset will be submitted or
|
|
is being submitted. Value should be ''A'' for car rental. This should
|
|
be included in the auth message.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* maxLength: 1'
|
|
type: string
|
|
type: object
|
|
AdditionalDataCommon:
|
|
additionalProperties: false
|
|
properties:
|
|
RequestedTestAcquirerResponseCode:
|
|
description: 'Triggers test scenarios that allow to replicate certain acquirer
|
|
response codes. See [Testing result codes and refusal reasons](https://docs.adyen.com/development-resources/testing/result-codes/)
|
|
to learn about the possible values, and the `refusalReason` values you
|
|
can trigger. '
|
|
type: string
|
|
RequestedTestErrorResponseCode:
|
|
description: "Triggers test scenarios that allow to replicate certain communication\
|
|
\ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\
|
|
\ wasn't a connection available to service the outgoing communication.\n\
|
|
This is a transient, retriable error since no messaging could be initiated\
|
|
\ to an issuing system (or third-party acquiring system). Therefore, the\
|
|
\ header Transient-Error: true is returned in the response. A subsequent\
|
|
\ request using the same idempotency key will be processed as if it was\
|
|
\ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\
|
|
\ wrong during transmission of the message or receiving the response.\n\
|
|
This is a classified as non-transient because the message could have been\
|
|
\ received by the issuing party and been acted upon. No transient error\
|
|
\ header is returned. If using idempotency, the (error) response is stored\
|
|
\ as the final result for the idempotency key. Subsequent messages with\
|
|
\ the same idempotency key not be processed beyond returning the stored\
|
|
\ response."
|
|
type: string
|
|
allowPartialAuth:
|
|
description: "Set to true to authorise a part of the requested amount in\
|
|
\ case the cardholder does not have enough funds on their account. \n\
|
|
If a payment was partially authorised, the response includes resultCode:\
|
|
\ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\
|
|
To enable this functionality, contact our Support Team."
|
|
type: string
|
|
authorisationType:
|
|
description: "Flags a card payment request for either pre-authorisation\
|
|
\ or final authorisation. For more information, refer to [Authorisation\
|
|
\ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\
|
|
\nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\
|
|
\ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\
|
|
\ request to be handled as a final authorisation."
|
|
type: string
|
|
autoRescue:
|
|
description: Set to **true** to enable [Auto Rescue](https://docs.adyen.com/online-payments/auto-rescue/)
|
|
for a transaction. Use the `maxDaysToRescue` to specify a rescue window.
|
|
type: string
|
|
customRoutingFlag:
|
|
description: 'Allows you to determine or override the acquirer account that
|
|
should be used for the transaction.
|
|
|
|
|
|
If you need to process a payment with an acquirer different from a default
|
|
one, you can set up a corresponding configuration on the Adyen payments
|
|
platform. Then you can pass a custom routing flag in a payment request''s
|
|
additional data to target a specific acquirer.
|
|
|
|
|
|
To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).'
|
|
type: string
|
|
industryUsage:
|
|
description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\
|
|
\ this field denotes why the additional payment is made.\n\nPossible values:\n\
|
|
\n * **NoShow**: An incremental charge is carried out because of a no-show\
|
|
\ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\
|
|
\ charge is carried out to process an additional payment after the original\
|
|
\ services have been rendered and the respective payment has been processed."
|
|
enum:
|
|
- NoShow
|
|
- DelayedCharge
|
|
type: string
|
|
manualCapture:
|
|
description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture)
|
|
for the transaction.
|
|
type: string
|
|
maxDaysToRescue:
|
|
description: "The rescue window for a transaction, in days, when `autoRescue`\
|
|
\ is set to **true**. You can specify a value between 1 and 48.\n\n* For\
|
|
\ [cards](https://docs.adyen.com/online-payments/auto-rescue/cards/),\
|
|
\ the default is one calendar month.\n * For [SEPA](https://docs.adyen.com/online-payments/auto-rescue/sepa/),\
|
|
\ the default is 42 days."
|
|
type: string
|
|
networkTxReference:
|
|
description: 'Allows you to link the transaction to the original or previous
|
|
one in a subscription/card-on-file chain. This field is required for token-based
|
|
transactions where Adyen does not tokenize the card.
|
|
|
|
|
|
Transaction identifier from card schemes, for example, Mastercard Trace
|
|
ID or the Visa Transaction ID.
|
|
|
|
|
|
Submit the original transaction ID of the contract in your payment request
|
|
if you are not tokenizing card details with Adyen and are making a merchant-initiated
|
|
transaction (MIT) for subsequent charges.
|
|
|
|
|
|
Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel`
|
|
**Subscription** or **UnscheduledCardOnFile** to ensure that the transaction
|
|
is classified as MIT.'
|
|
type: string
|
|
overwriteBrand:
|
|
description: Boolean indicator that can be optionally used for performing
|
|
debit transactions on combo cards (for example, combo cards in Brazil).
|
|
This is not mandatory but we recommend that you set this to true if you
|
|
want to use the `selectedBrand` value to specify how to process the transaction.
|
|
type: string
|
|
subMerchantCity:
|
|
description: 'This field is required if the transaction is performed by
|
|
a registered payment facilitator. This field must contain the city of
|
|
the actual merchant''s address.
|
|
|
|
* Format: alpha-numeric.
|
|
|
|
* Maximum length: 13 characters.'
|
|
type: string
|
|
subMerchantCountry:
|
|
description: 'This field is required if the transaction is performed by
|
|
a registered payment facilitator. This field must contain the three-letter
|
|
country code of the actual merchant''s address.
|
|
|
|
* Format: alpha-numeric.
|
|
|
|
* Fixed length: 3 characters.'
|
|
type: string
|
|
subMerchantEmail:
|
|
description: 'This field is required for transactions performed by registered
|
|
payment facilitators. This field contains the email address of the sub-merchant.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* Maximum length: 40 characters'
|
|
type: string
|
|
subMerchantID:
|
|
description: 'This field contains an identifier of the actual merchant when
|
|
a transaction is submitted via a payment facilitator. The payment facilitator
|
|
must send in this unique ID.
|
|
|
|
|
|
A unique identifier per submerchant that is required if the transaction
|
|
is performed by a registered payment facilitator.
|
|
|
|
* Format: alpha-numeric.
|
|
|
|
* Fixed length: 15 characters.'
|
|
type: string
|
|
subMerchantName:
|
|
description: 'This field is required if the transaction is performed by
|
|
a registered payment facilitator. This field must contain the name of
|
|
the actual merchant.
|
|
|
|
* Format: alpha-numeric.
|
|
|
|
* Maximum length: 22 characters.'
|
|
type: string
|
|
subMerchantPhoneNumber:
|
|
description: 'This field is required for transactions performed by registered
|
|
payment facilitators. This field contains the phone number of the sub-merchant.*
|
|
Format: Alphanumeric
|
|
|
|
* Maximum length: 20 characters'
|
|
type: string
|
|
subMerchantPostalCode:
|
|
description: 'This field is required if the transaction is performed by
|
|
a registered payment facilitator. This field must contain the postal code
|
|
of the actual merchant''s address.
|
|
|
|
* Format: alpha-numeric.
|
|
|
|
* Maximum length: 10 characters.'
|
|
type: string
|
|
subMerchantState:
|
|
description: 'This field is required if the transaction is performed by
|
|
a registered payment facilitator, and if applicable to the country. This
|
|
field must contain the state code of the actual merchant''s address.
|
|
|
|
* Format: alpha-numeric.
|
|
|
|
* Maximum length: 3 characters.'
|
|
type: string
|
|
subMerchantStreet:
|
|
description: 'This field is required if the transaction is performed by
|
|
a registered payment facilitator. This field must contain the street of
|
|
the actual merchant''s address.
|
|
|
|
* Format: alpha-numeric.
|
|
|
|
* Maximum length: 60 characters.'
|
|
type: string
|
|
subMerchantTaxId:
|
|
description: 'This field is required if the transaction is performed by
|
|
a registered payment facilitator. This field must contain the tax ID of
|
|
the actual merchant.
|
|
|
|
* Format: alpha-numeric.
|
|
|
|
* Fixed length: 11 or 14 characters.'
|
|
type: string
|
|
type: object
|
|
AdditionalDataLevel23:
|
|
additionalProperties: false
|
|
properties:
|
|
enhancedSchemeData.customerReference:
|
|
description: "The reference number to identify the customer and their order.\
|
|
\ \n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with\
|
|
\ a space or be all spaces.\n* Must not be all zeros."
|
|
type: string
|
|
enhancedSchemeData.destinationCountryCode:
|
|
description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)
|
|
for the destination address.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* Fixed length: 3 characters'
|
|
type: string
|
|
enhancedSchemeData.destinationPostalCode:
|
|
description: 'The postal code of the destination address.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* Max length: 10 characters
|
|
|
|
* Must not start with a space.
|
|
|
|
* For the US, it must be in five or nine digits format. For example, 10001
|
|
or 10001-0000.
|
|
|
|
* For Canada, it must be in 6 digits format. For example, M4B 1G5.'
|
|
type: string
|
|
enhancedSchemeData.destinationStateProvinceCode:
|
|
description: 'The state or province code of the destination address.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* Max length: 3 characters
|
|
|
|
* Must not start with a space.'
|
|
type: string
|
|
enhancedSchemeData.dutyAmount:
|
|
description: 'The duty tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* For example, 2000 means USD 20.00.
|
|
|
|
* Encoding: Numeric
|
|
|
|
* Max length: 12 characters'
|
|
type: string
|
|
enhancedSchemeData.freightAmount:
|
|
description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* For example, 2000 means USD 20.00.
|
|
|
|
* Encoding: Numeric
|
|
|
|
* Max length: 12 characters'
|
|
type: string
|
|
enhancedSchemeData.itemDetailLine[itemNr].commodityCode:
|
|
description: 'The code that identifies the item in a standardized commodity
|
|
coding scheme. There are different commodity coding schemes:
|
|
|
|
* [UNSPSC commodity codes](https://www.unspsc.org/)
|
|
|
|
* [HS commodity codes](https://www.wcoomd.org/en/topics/nomenclature/overview.aspx)
|
|
|
|
* [NAICS commodity codes](https://www.census.gov/naics/)
|
|
|
|
* [NAPCS commodity codes](https://www.census.gov/naics/napcs/)
|
|
|
|
|
|
|
|
* Encoding: ASCII
|
|
|
|
* Max length: 12 characters
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
enhancedSchemeData.itemDetailLine[itemNr].description:
|
|
description: 'A description of the item.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* Max length: 26 characters
|
|
|
|
* Must not be a single character.
|
|
|
|
* Must not be blank.
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
enhancedSchemeData.itemDetailLine[itemNr].discountAmount:
|
|
description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* For example, 2000 means USD 20.00.
|
|
|
|
* Encoding: Numeric
|
|
|
|
* Max length: 12 characters'
|
|
type: string
|
|
enhancedSchemeData.itemDetailLine[itemNr].productCode:
|
|
description: "The product code. Must be a unique product code associated\
|
|
\ with the item or service. This can be your unique code for the item,\
|
|
\ or the manufacturer's product code. \n* Encoding: ASCII.\n* Max length:\
|
|
\ 12 characters\n* Must not start with a space or be all spaces.\n* Must\
|
|
\ not be all zeros."
|
|
type: string
|
|
enhancedSchemeData.itemDetailLine[itemNr].quantity:
|
|
description: 'The number of items. Must be an integer greater than zero.
|
|
|
|
* Encoding: Numeric
|
|
|
|
* Max length: 12 characters
|
|
|
|
* Must not start with a space or be all spaces.'
|
|
type: string
|
|
enhancedSchemeData.itemDetailLine[itemNr].totalAmount:
|
|
description: 'The total amount for the line item, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
See [Amount requirements for level 2/3 ESD](https://docs.adyen.com//payment-methods/cards/enhanced-scheme-data/l2-l3#amount-requirements)
|
|
to learn more about how to calculate the line item total.
|
|
|
|
* For example, 2000 means USD 20.00.
|
|
|
|
* Max length: 12 characters
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure:
|
|
description: 'The unit of measurement for an item.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* Max length: 3 characters
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
enhancedSchemeData.itemDetailLine[itemNr].unitPrice:
|
|
description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* For example, 2000 means USD 20.00.
|
|
|
|
* Encoding: Numeric
|
|
|
|
* Max length: 12 characters
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
enhancedSchemeData.orderDate:
|
|
description: 'The order date.
|
|
|
|
* Format: `ddMMyy`
|
|
|
|
* Encoding: ASCII
|
|
|
|
* Max length: 6 characters'
|
|
type: string
|
|
enhancedSchemeData.shipFromPostalCode:
|
|
description: 'The postal code of the address where the item is shipped from.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* Max length: 10 characters
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.For the US, it must be in five or nine digits
|
|
format. For example, 10001 or 10001-0000.
|
|
|
|
* For Canada, it must be in 6 digits format. For example, M4B 1G5.'
|
|
type: string
|
|
enhancedSchemeData.totalTaxAmount:
|
|
description: "The amount of state or provincial [tax included in the total\
|
|
\ transaction amount](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/l2-l3#requirements-to-send-level-2-3-esd),\
|
|
\ in [minor units](https://docs.adyen.com/development-resources/currency-codes).\
|
|
\ \n* For example, 2000 means USD 20.00.\n* Encoding: Numeric \n* Max\
|
|
\ length: 12 characters\n* Must not be all zeros."
|
|
type: string
|
|
type: object
|
|
AdditionalDataLodging:
|
|
additionalProperties: false
|
|
properties:
|
|
lodging.SpecialProgramCode:
|
|
description: 'A code that corresponds to the category of lodging charges
|
|
for the payment. Possible values:
|
|
|
|
* 1: Lodging
|
|
|
|
* 2: No show reservation
|
|
|
|
* 3: Advanced deposit'
|
|
type: string
|
|
lodging.checkInDate:
|
|
description: 'The arrival date.
|
|
|
|
* Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.'
|
|
type: string
|
|
lodging.checkOutDate:
|
|
description: 'The departure date.
|
|
|
|
* Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.'
|
|
type: string
|
|
lodging.customerServiceTollFreeNumber:
|
|
description: 'The toll-free phone number for the lodging.
|
|
|
|
* Format: numeric
|
|
|
|
* Max length: 17 characters.
|
|
|
|
* For US and CA numbers must be 10 characters in length
|
|
|
|
* Must not start with a space
|
|
|
|
* Must not contain any special characters such as + or -
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
lodging.fireSafetyActIndicator:
|
|
description: 'Identifies that the facility complies with the Hotel and Motel
|
|
Fire Safety Act of 1990. Must be ''Y'' or ''N''.
|
|
|
|
* Format: alphabetic
|
|
|
|
* Max length: 1 character'
|
|
type: string
|
|
lodging.folioCashAdvances:
|
|
description: 'The folio cash advances, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* Format: numeric
|
|
|
|
* Max length: 12 characters'
|
|
type: string
|
|
lodging.folioNumber:
|
|
description: "The card acceptor\u2019s internal invoice or billing ID reference\
|
|
\ number.\n* Max length: 25 characters\n* Must not start with a space\n\
|
|
* Must not contain any special characters\n* Must not be all zeros."
|
|
type: string
|
|
lodging.foodBeverageCharges:
|
|
description: 'Any charges for food and beverages associated with the booking,
|
|
in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* Format: numeric
|
|
|
|
* Max length: 12 characters'
|
|
type: string
|
|
lodging.noShowIndicator:
|
|
description: "Indicates if the customer didn't check in for their booking.\n\
|
|
\ Possible values: \n* **Y**: the customer didn't check in \n* **N**:\
|
|
\ the customer checked in"
|
|
type: string
|
|
lodging.prepaidExpenses:
|
|
description: 'The prepaid expenses for the booking.
|
|
|
|
* Format: numeric
|
|
|
|
* Max length: 12 characters'
|
|
type: string
|
|
lodging.propertyPhoneNumber:
|
|
description: 'The lodging property location''s phone number.
|
|
|
|
* Format: numeric
|
|
|
|
* Min length: 10 characters
|
|
|
|
* Max length: 17 characters
|
|
|
|
* For US and CA numbers must be 10 characters in length
|
|
|
|
* Must not start with a space
|
|
|
|
* Must not contain any special characters such as + or -
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
lodging.room1.numberOfNights:
|
|
description: 'The total number of nights the room is booked for.
|
|
|
|
* Format: numeric
|
|
|
|
* Must be a number between 0 and 99
|
|
|
|
* Max length: 4 characters'
|
|
type: string
|
|
lodging.room1.rate:
|
|
description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* Format: numeric
|
|
|
|
* Max length: 12 characters
|
|
|
|
* Must not be a negative number'
|
|
type: string
|
|
lodging.totalRoomTax:
|
|
description: 'The total room tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* Format: numeric
|
|
|
|
* Max length: 12 characters
|
|
|
|
* Must not be a negative number'
|
|
type: string
|
|
lodging.totalTax:
|
|
description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* Format: numeric
|
|
|
|
* Max length: 12 characters
|
|
|
|
* Must not be a negative number'
|
|
type: string
|
|
travelEntertainmentAuthData.duration:
|
|
description: 'The number of nights. This should be included in the auth
|
|
message.
|
|
|
|
* Format: numeric
|
|
|
|
* Max length: 4 characters'
|
|
type: string
|
|
travelEntertainmentAuthData.market:
|
|
description: 'Indicates what market-specific dataset will be submitted.
|
|
Must be ''H'' for Hotel. This should be included in the auth message.
|
|
|
|
|
|
* Format: alphanumeric
|
|
|
|
* Max length: 1 character'
|
|
type: string
|
|
type: object
|
|
AdditionalDataOpenInvoice:
|
|
additionalProperties: false
|
|
properties:
|
|
openinvoicedata.merchantData:
|
|
description: 'Holds different merchant data points like product, purchase,
|
|
customer, and so on. It takes data in a Base64 encoded string.
|
|
|
|
|
|
The `merchantData` parameter needs to be added to the `openinvoicedata`
|
|
signature at the end.
|
|
|
|
|
|
Since the field is optional, if it''s not included it does not impact
|
|
computing the merchant signature.
|
|
|
|
|
|
Applies only to Klarna.
|
|
|
|
|
|
You can contact Klarna for the format and structure of the string.'
|
|
type: string
|
|
openinvoicedata.numberOfLines:
|
|
description: 'The number of invoice lines included in `openinvoicedata`.
|
|
|
|
|
|
There needs to be at least one line, so `numberOfLines` needs to be at
|
|
least 1.'
|
|
type: string
|
|
openinvoicedata.recipientFirstName:
|
|
description: First name of the recipient. If the delivery address and the
|
|
billing address are different, specify the `recipientFirstName` and `recipientLastName`
|
|
to share the delivery address with Klarna. Otherwise, only the billing
|
|
address is shared with Klarna.
|
|
type: string
|
|
openinvoicedata.recipientLastName:
|
|
description: Last name of the recipient. If the delivery address and the
|
|
billing address are different, specify the `recipientFirstName` and `recipientLastName`
|
|
to share the delivery address with Klarna. Otherwise, only the billing
|
|
address is shared with Klarna.
|
|
type: string
|
|
openinvoicedataLine[itemNr].currencyCode:
|
|
description: The three-character ISO currency code.
|
|
type: string
|
|
openinvoicedataLine[itemNr].description:
|
|
description: A text description of the product the invoice line refers to.
|
|
type: string
|
|
openinvoicedataLine[itemNr].itemAmount:
|
|
description: 'The price for one item in the invoice line, represented in
|
|
minor units.
|
|
|
|
|
|
The due amount for the item, VAT excluded.'
|
|
type: string
|
|
openinvoicedataLine[itemNr].itemId:
|
|
description: A unique id for this item. Required for RatePay if the description
|
|
of each item is not unique.
|
|
type: string
|
|
openinvoicedataLine[itemNr].itemVatAmount:
|
|
description: The VAT due for one item in the invoice line, represented in
|
|
minor units.
|
|
type: string
|
|
openinvoicedataLine[itemNr].itemVatPercentage:
|
|
description: 'The VAT percentage for one item in the invoice line, represented
|
|
in minor units.
|
|
|
|
|
|
For example, 19% VAT is specified as 1900.'
|
|
type: string
|
|
openinvoicedataLine[itemNr].numberOfItems:
|
|
description: The number of units purchased of a specific product.
|
|
type: string
|
|
openinvoicedataLine[itemNr].returnShippingCompany:
|
|
description: Name of the shipping company handling the the return shipment.
|
|
type: string
|
|
openinvoicedataLine[itemNr].returnTrackingNumber:
|
|
description: The tracking number for the return of the shipment.
|
|
type: string
|
|
openinvoicedataLine[itemNr].returnTrackingUri:
|
|
description: URI where the customer can track the return of their shipment.
|
|
type: string
|
|
openinvoicedataLine[itemNr].shippingCompany:
|
|
description: Name of the shipping company handling the delivery.
|
|
type: string
|
|
openinvoicedataLine[itemNr].shippingMethod:
|
|
description: Shipping method.
|
|
type: string
|
|
openinvoicedataLine[itemNr].trackingNumber:
|
|
description: The tracking number for the shipment.
|
|
type: string
|
|
openinvoicedataLine[itemNr].trackingUri:
|
|
description: URI where the customer can track their shipment.
|
|
type: string
|
|
type: object
|
|
AdditionalDataOpi:
|
|
additionalProperties: false
|
|
properties:
|
|
opi.includeTransToken:
|
|
description: 'Optional boolean indicator. Set to **true** if you want an
|
|
ecommerce transaction to return an `opi.transToken` as additional data
|
|
in the response.
|
|
|
|
|
|
You can store this Oracle Payment Interface token in your Oracle Opera
|
|
database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
|
|
type: string
|
|
type: object
|
|
AdditionalDataRatepay:
|
|
additionalProperties: false
|
|
properties:
|
|
ratepay.installmentAmount:
|
|
description: Amount the customer has to pay each month.
|
|
type: string
|
|
ratepay.interestRate:
|
|
description: Interest rate of this installment.
|
|
type: string
|
|
ratepay.lastInstallmentAmount:
|
|
description: Amount of the last installment.
|
|
type: string
|
|
ratepay.paymentFirstday:
|
|
description: Calendar day of the first payment.
|
|
type: string
|
|
ratepaydata.deliveryDate:
|
|
description: Date the merchant delivered the goods to the customer.
|
|
type: string
|
|
ratepaydata.dueDate:
|
|
description: Date by which the customer must settle the payment.
|
|
type: string
|
|
ratepaydata.invoiceDate:
|
|
description: Invoice date, defined by the merchant. If not included, the
|
|
invoice date is set to the delivery date.
|
|
type: string
|
|
ratepaydata.invoiceId:
|
|
description: Identification name or number for the invoice, defined by the
|
|
merchant.
|
|
type: string
|
|
type: object
|
|
AdditionalDataRetry:
|
|
additionalProperties: false
|
|
properties:
|
|
retry.chainAttemptNumber:
|
|
description: 'The number of times the transaction (not order) has been retried
|
|
between different payment service providers. For instance, the `chainAttemptNumber`
|
|
set to 2 means that this transaction has been recently tried on another
|
|
provider before being sent to Adyen.
|
|
|
|
|
|
> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`,
|
|
and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference`
|
|
to facilitate linking payment attempts together.'
|
|
type: string
|
|
retry.orderAttemptNumber:
|
|
description: 'The index of the attempt to bill a particular order, which
|
|
is identified by the `merchantOrderReference` field. For example, if a
|
|
recurring transaction fails and is retried one day later, then the order
|
|
number for these attempts would be 1 and 2, respectively.
|
|
|
|
|
|
> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`,
|
|
and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference`
|
|
to facilitate linking payment attempts together.'
|
|
type: string
|
|
retry.skipRetry:
|
|
description: 'The Boolean value indicating whether Adyen should skip or
|
|
retry this transaction, if possible.
|
|
|
|
|
|
> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`,
|
|
and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference`
|
|
to facilitate linking payment attempts together.'
|
|
type: string
|
|
type: object
|
|
AdditionalDataRisk:
|
|
additionalProperties: false
|
|
properties:
|
|
riskdata.[customFieldName]:
|
|
description: The data for your custom risk field. For more information,
|
|
refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).
|
|
type: string
|
|
riskdata.basket.item[itemNr].amountPerItem:
|
|
description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
type: string
|
|
riskdata.basket.item[itemNr].brand:
|
|
description: Brand of the item.
|
|
type: string
|
|
riskdata.basket.item[itemNr].category:
|
|
description: Category of the item.
|
|
type: string
|
|
riskdata.basket.item[itemNr].color:
|
|
description: Color of the item.
|
|
type: string
|
|
riskdata.basket.item[itemNr].currency:
|
|
description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).
|
|
type: string
|
|
riskdata.basket.item[itemNr].itemID:
|
|
description: ID of the item.
|
|
type: string
|
|
riskdata.basket.item[itemNr].manufacturer:
|
|
description: Manufacturer of the item.
|
|
type: string
|
|
riskdata.basket.item[itemNr].productTitle:
|
|
description: A text description of the product the invoice line refers to.
|
|
type: string
|
|
riskdata.basket.item[itemNr].quantity:
|
|
description: Quantity of the item purchased.
|
|
type: string
|
|
riskdata.basket.item[itemNr].receiverEmail:
|
|
description: Email associated with the given product in the basket (usually
|
|
in electronic gift cards).
|
|
type: string
|
|
riskdata.basket.item[itemNr].size:
|
|
description: Size of the item.
|
|
type: string
|
|
riskdata.basket.item[itemNr].sku:
|
|
description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).'
|
|
type: string
|
|
riskdata.basket.item[itemNr].upc:
|
|
description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).'
|
|
type: string
|
|
riskdata.promotions.promotion[itemNr].promotionCode:
|
|
description: Code of the promotion.
|
|
type: string
|
|
riskdata.promotions.promotion[itemNr].promotionDiscountAmount:
|
|
description: The discount amount of the promotion, represented in [minor
|
|
units](https://docs.adyen.com/development-resources/currency-codes).
|
|
type: string
|
|
riskdata.promotions.promotion[itemNr].promotionDiscountCurrency:
|
|
description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).
|
|
type: string
|
|
riskdata.promotions.promotion[itemNr].promotionDiscountPercentage:
|
|
description: 'Promotion''s percentage discount. It is represented in percentage
|
|
value and there is no need to include the ''%'' sign.
|
|
|
|
|
|
e.g. for a promotion discount of 30%, the value of the field should be
|
|
30.'
|
|
type: string
|
|
riskdata.promotions.promotion[itemNr].promotionName:
|
|
description: Name of the promotion.
|
|
type: string
|
|
riskdata.riskProfileReference:
|
|
description: Reference number of the risk profile that you want to apply
|
|
to the payment. If not provided or left blank, the merchant-level account's
|
|
default risk profile will be applied to the payment. For more information,
|
|
see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).
|
|
type: string
|
|
riskdata.skipRisk:
|
|
description: If this parameter is provided with the value **true**, risk
|
|
checks for the payment request are skipped and the transaction will not
|
|
get a risk score.
|
|
type: string
|
|
type: object
|
|
AdditionalDataRiskStandalone:
|
|
additionalProperties: false
|
|
properties:
|
|
PayPal.CountryCode:
|
|
description: Shopper's country of residence in the form of ISO standard
|
|
3166 2-character country codes.
|
|
type: string
|
|
PayPal.EmailId:
|
|
description: Shopper's email.
|
|
type: string
|
|
PayPal.FirstName:
|
|
description: Shopper's first name.
|
|
type: string
|
|
PayPal.LastName:
|
|
description: Shopper's last name.
|
|
type: string
|
|
PayPal.PayerId:
|
|
description: 'Unique PayPal Customer Account identification number. Character
|
|
length and limitations: 13 single-byte alphanumeric characters.'
|
|
type: string
|
|
PayPal.Phone:
|
|
description: Shopper's phone number.
|
|
type: string
|
|
PayPal.ProtectionEligibility:
|
|
description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\
|
|
\ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\
|
|
\ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\
|
|
\ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\
|
|
\ \u2014 Merchant is not protected under the Seller Protection Policy."
|
|
type: string
|
|
PayPal.TransactionId:
|
|
description: Unique transaction ID of the payment.
|
|
type: string
|
|
avsResultRaw:
|
|
description: 'Raw AVS result received from the acquirer, where available.
|
|
Example: D'
|
|
type: string
|
|
bin:
|
|
description: The Bank Identification Number of a credit card, which is the
|
|
first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/online-payments/tokenization).
|
|
type: string
|
|
cvcResultRaw:
|
|
description: 'Raw CVC result received from the acquirer, where available.
|
|
Example: 1'
|
|
type: string
|
|
riskToken:
|
|
description: Unique identifier or token for the shopper's card details.
|
|
type: string
|
|
threeDAuthenticated:
|
|
description: 'A Boolean value indicating whether 3DS authentication was
|
|
completed on this payment. Example: true'
|
|
type: string
|
|
threeDOffered:
|
|
description: 'A Boolean value indicating whether 3DS was offered for this
|
|
payment. Example: true'
|
|
type: string
|
|
tokenDataType:
|
|
description: 'Required for PayPal payments only. The only supported value
|
|
is: **paypal**.'
|
|
type: string
|
|
type: object
|
|
AdditionalDataSubMerchant:
|
|
additionalProperties: false
|
|
properties:
|
|
subMerchant.numberOfSubSellers:
|
|
description: Required for transactions performed by registered payment facilitators.
|
|
Indicates the number of sub-merchants contained in the request. For example,
|
|
**3**.
|
|
type: string
|
|
subMerchant.subSeller[subSellerNr].city:
|
|
description: 'Required for transactions performed by registered payment
|
|
facilitators. The city of the sub-merchant''s address.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* Maximum length: 13 characters'
|
|
type: string
|
|
subMerchant.subSeller[subSellerNr].country:
|
|
description: "Required for transactions performed by registered payment\
|
|
\ facilitators. The three-letter country code of the sub-merchant's address.\
|
|
\ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\
|
|
* Fixed length: 3 characters"
|
|
type: string
|
|
subMerchant.subSeller[subSellerNr].email:
|
|
description: 'Required for transactions performed by registered payment
|
|
facilitators. The email address of the sub-merchant.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* Maximum length: 40 characters'
|
|
type: string
|
|
subMerchant.subSeller[subSellerNr].id:
|
|
description: "Required for transactions performed by registered payment\
|
|
\ facilitators. A unique identifier that you create for the sub-merchant,\
|
|
\ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\
|
|
* Maximum length: 15 characters"
|
|
type: string
|
|
subMerchant.subSeller[subSellerNr].mcc:
|
|
description: "Required for transactions performed by registered payment\
|
|
\ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\
|
|
\ \n* Format: Numeric\n* Fixed length: 4 digits"
|
|
type: string
|
|
subMerchant.subSeller[subSellerNr].name:
|
|
description: 'Required for transactions performed by registered payment
|
|
facilitators. The name of the sub-merchant. Based on scheme specifications,
|
|
this value will overwrite the shopper statement that will appear in the
|
|
card statement.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* Maximum length: 22 characters'
|
|
type: string
|
|
subMerchant.subSeller[subSellerNr].phoneNumber:
|
|
description: 'Required for transactions performed by registered payment
|
|
facilitators. The phone number of the sub-merchant.* Format: Alphanumeric
|
|
|
|
* Maximum length: 20 characters'
|
|
type: string
|
|
subMerchant.subSeller[subSellerNr].postalCode:
|
|
description: 'Required for transactions performed by registered payment
|
|
facilitators. The postal code of the sub-merchant''s address, without
|
|
dashes.
|
|
|
|
* Format: Numeric
|
|
|
|
* Fixed length: 8 digits'
|
|
type: string
|
|
subMerchant.subSeller[subSellerNr].state:
|
|
description: 'Required for transactions performed by registered payment
|
|
facilitators. The state code of the sub-merchant''s address, if applicable
|
|
to the country.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* Maximum length: 2 characters'
|
|
type: string
|
|
subMerchant.subSeller[subSellerNr].street:
|
|
description: 'Required for transactions performed by registered payment
|
|
facilitators. The street name and house number of the sub-merchant''s
|
|
address.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* Maximum length: 60 characters'
|
|
type: string
|
|
subMerchant.subSeller[subSellerNr].taxId:
|
|
description: 'Required for transactions performed by registered payment
|
|
facilitators. The tax ID of the sub-merchant.
|
|
|
|
* Format: Numeric
|
|
|
|
* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ'
|
|
type: string
|
|
type: object
|
|
AdditionalDataTemporaryServices:
|
|
additionalProperties: false
|
|
properties:
|
|
enhancedSchemeData.customerReference:
|
|
description: 'The customer code, if supplied by a customer.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* maxLength: 25'
|
|
type: string
|
|
enhancedSchemeData.employeeName:
|
|
description: "The name or ID of the person working in a temporary capacity.\n\
|
|
* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros."
|
|
type: string
|
|
enhancedSchemeData.jobDescription:
|
|
description: "The job description of the person working in a temporary capacity.\n\
|
|
* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros."
|
|
type: string
|
|
enhancedSchemeData.regularHoursRate:
|
|
description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* maxLength: 7
|
|
|
|
* Must not be empty
|
|
|
|
* Can be all zeros'
|
|
type: string
|
|
enhancedSchemeData.regularHoursWorked:
|
|
description: 'The hours worked.
|
|
|
|
* maxLength: 7
|
|
|
|
* Must not be empty
|
|
|
|
* Can be all zeros'
|
|
type: string
|
|
enhancedSchemeData.requestName:
|
|
description: 'The name of the person requesting temporary services.
|
|
|
|
* maxLength: 40
|
|
|
|
* Must not be all zeros
|
|
|
|
* Must not be all spaces'
|
|
type: string
|
|
enhancedSchemeData.tempStartDate:
|
|
description: 'The billing period start date.
|
|
|
|
* Format: ddMMyy
|
|
|
|
* maxLength: 6'
|
|
type: string
|
|
enhancedSchemeData.tempWeekEnding:
|
|
description: 'The billing period end date.
|
|
|
|
* Format: ddMMyy
|
|
|
|
* maxLength: 6'
|
|
type: string
|
|
enhancedSchemeData.totalTaxAmount:
|
|
description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
For example, 2000 means USD 20.00
|
|
|
|
* maxLength: 12'
|
|
type: string
|
|
type: object
|
|
AdditionalDataWallets:
|
|
additionalProperties: false
|
|
properties:
|
|
androidpay.token:
|
|
description: The Android Pay token retrieved from the SDK.
|
|
type: string
|
|
masterpass.transactionId:
|
|
description: The Mastercard Masterpass Transaction ID retrieved from the
|
|
SDK.
|
|
type: string
|
|
payment.token:
|
|
description: The Apple Pay token retrieved from the SDK.
|
|
type: string
|
|
paywithgoogle.token:
|
|
description: The Google Pay token retrieved from the SDK.
|
|
type: string
|
|
samsungpay.token:
|
|
description: The Samsung Pay token retrieved from the SDK.
|
|
type: string
|
|
visacheckout.callId:
|
|
description: The Visa Checkout Call ID retrieved from the SDK.
|
|
type: string
|
|
type: object
|
|
Address:
|
|
additionalProperties: false
|
|
properties:
|
|
city:
|
|
description: 'The name of the city. Maximum length: 3000 characters.'
|
|
maxLength: 3000
|
|
type: string
|
|
country:
|
|
description: 'The two-character ISO-3166-1 alpha-2 country code. For example,
|
|
**US**.
|
|
|
|
> If you don''t know the country or are not collecting the country from
|
|
the shopper, provide `country` as `ZZ`.'
|
|
type: string
|
|
houseNumberOrName:
|
|
description: 'The number or name of the house. Maximum length: 3000 characters.'
|
|
maxLength: 3000
|
|
type: string
|
|
postalCode:
|
|
description: A maximum of five digits for an address in the US, or a maximum
|
|
of ten characters for an address in all other countries.
|
|
type: string
|
|
stateOrProvince:
|
|
description: 'The two-character ISO 3166-2 state or province code. For example,
|
|
**CA** in the US or **ON** in Canada.
|
|
|
|
> Required for the US and Canada.'
|
|
type: string
|
|
street:
|
|
description: 'The name of the street. Maximum length: 3000 characters.
|
|
|
|
> The house number should not be included in this field; it should be
|
|
separately provided via `houseNumberOrName`.'
|
|
maxLength: 3000
|
|
type: string
|
|
required:
|
|
- street
|
|
- houseNumberOrName
|
|
- city
|
|
- postalCode
|
|
- country
|
|
type: object
|
|
AffirmDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
type:
|
|
default: affirm
|
|
description: '**affirm**'
|
|
enum:
|
|
- affirm
|
|
type: string
|
|
title: Affirm
|
|
type: object
|
|
AfterpayDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
billingAddress:
|
|
description: The address where to send the invoice.
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
deliveryAddress:
|
|
description: The address where the goods should be delivered.
|
|
type: string
|
|
personalDetails:
|
|
description: Shopper name, date of birth, phone number, and email address.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: afterpay_default
|
|
description: '**afterpay_default**'
|
|
enum:
|
|
- afterpay_default
|
|
- afterpaytouch
|
|
- afterpay_b2b
|
|
- clearpay
|
|
type: string
|
|
required:
|
|
- type
|
|
title: Afterpay
|
|
type: object
|
|
Agency:
|
|
additionalProperties: false
|
|
properties:
|
|
invoiceNumber:
|
|
description: 'The reference number for the invoice, issued by the agency.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 6 characters'
|
|
type: string
|
|
planName:
|
|
description: 'The two-letter agency plan identifier.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 2 characters
|
|
|
|
* maxLength: 2 characters'
|
|
type: string
|
|
type: object
|
|
Airline:
|
|
additionalProperties: false
|
|
properties:
|
|
agency:
|
|
$ref: '#/components/schemas/Agency'
|
|
boardingFee:
|
|
description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* Encoding: Numeric
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 11 characters'
|
|
format: int64
|
|
type: integer
|
|
code:
|
|
description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
|
|
3-digit accounting code (PAX) that identifies the carrier.
|
|
|
|
* Format: IATA 3-digit accounting code (PAX)
|
|
|
|
* Example: KLM = 074
|
|
|
|
* minLength: 3 characters
|
|
|
|
* maxLength: 3 characters
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
computerizedReservationSystem:
|
|
description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system)
|
|
used to make the reservation and purchase the ticket.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 4 characters
|
|
|
|
* maxLength: 4 characters'
|
|
type: string
|
|
customerReferenceNumber:
|
|
description: 'The alphanumeric customer reference number.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* maxLength: 20 characters
|
|
|
|
* If you send more than 20 characters, the customer reference number is
|
|
truncated
|
|
|
|
* Must not start with a space or be all spaces.'
|
|
type: string
|
|
designatorCode:
|
|
description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
|
|
2-letter accounting code (PAX) that identifies the carrier.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* Example: KLM = KL
|
|
|
|
* minLength: 2 characters
|
|
|
|
* maxLength: 2 characters
|
|
|
|
* Must not start with a space or be all spaces.'
|
|
type: string
|
|
documentType:
|
|
description: 'A code that identifies the type of item bought. The description
|
|
of the code can appear on credit card statements.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* Example: Passenger ticket = 01
|
|
|
|
* minLength: 2 characters
|
|
|
|
* maxLength: 2 characters'
|
|
type: string
|
|
flightDate:
|
|
description: 'The flight departure date. Time is optional.
|
|
|
|
* Format for date only: `yyyy-MM-dd`
|
|
|
|
* Format for date and time: `yyyy-MM-ddTHH:mm`
|
|
|
|
* Use local time of departure airport.
|
|
|
|
* minLength: 10 characters
|
|
|
|
* maxLength: 16 characters'
|
|
format: date-time
|
|
type: string
|
|
legs:
|
|
items:
|
|
$ref: '#/components/schemas/Leg'
|
|
type: array
|
|
passengerName:
|
|
description: 'The passenger''s name, initials, and title.
|
|
|
|
* Format: last name + first name or initials + title
|
|
|
|
* Example: *FLYER / MARY MS*
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 20 characters
|
|
|
|
* If you send more than 20 characters, the name is truncated
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
passengers:
|
|
items:
|
|
$ref: '#/components/schemas/Passenger'
|
|
type: array
|
|
ticket:
|
|
$ref: '#/components/schemas/Ticket'
|
|
travelAgency:
|
|
$ref: '#/components/schemas/TravelAgency'
|
|
required:
|
|
- passengerName
|
|
type: object
|
|
AmazonPayDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
amazonPayToken:
|
|
description: This is the `amazonPayToken` that you obtained from the [Get
|
|
Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session)
|
|
response. This token is used for API only integration specifically.
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
checkoutSessionId:
|
|
description: The `checkoutSessionId` is used to identify the checkout session
|
|
at the Amazon Pay side. This field is required only for drop-in and components
|
|
integration, where it replaces the amazonPayToken.
|
|
type: string
|
|
type:
|
|
default: amazonpay
|
|
description: '**amazonpay**'
|
|
enum:
|
|
- amazonpay
|
|
type: string
|
|
title: Amazon Pay
|
|
type: object
|
|
Amount:
|
|
additionalProperties: false
|
|
properties:
|
|
currency:
|
|
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).
|
|
maxLength: 3
|
|
minLength: 3
|
|
type: string
|
|
value:
|
|
description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).
|
|
format: int64
|
|
type: integer
|
|
required:
|
|
- value
|
|
- currency
|
|
type: object
|
|
Amounts:
|
|
additionalProperties: false
|
|
properties:
|
|
currency:
|
|
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes/).
|
|
type: string
|
|
values:
|
|
description: The amounts of the donation (in [minor units](https://docs.adyen.com/development-resources/currency-codes/)).
|
|
items:
|
|
format: int64
|
|
type: integer
|
|
type: array
|
|
required:
|
|
- currency
|
|
- values
|
|
type: object
|
|
AncvDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
beneficiaryId:
|
|
description: ANCV account identification (email or account number)
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
description: '**ancv**'
|
|
enum:
|
|
- ancv
|
|
type: string
|
|
title: ANCV
|
|
type: object
|
|
AndroidPayDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
type:
|
|
default: androidpay
|
|
description: '**androidpay**'
|
|
enum:
|
|
- androidpay
|
|
type: string
|
|
title: Android Pay
|
|
type: object
|
|
ApplePayDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
applePayToken:
|
|
description: The stringified and base64 encoded `paymentData` you retrieved
|
|
from the Apple framework.
|
|
maxLength: 10000
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
fundingSource:
|
|
description: The funding source that should be used when multiple sources
|
|
are available. For Brazilian combo cards, by default the funding source
|
|
is credit. To use debit, set this value to **debit**.
|
|
enum:
|
|
- credit
|
|
- debit
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: applepay
|
|
description: '**applepay**'
|
|
enum:
|
|
- applepay
|
|
type: string
|
|
required:
|
|
- applePayToken
|
|
title: Apple Pay
|
|
type: object
|
|
ApplePayDonations:
|
|
additionalProperties: false
|
|
properties:
|
|
applePayToken:
|
|
description: The stringified and base64 encoded `paymentData` you retrieved
|
|
from the Apple framework.
|
|
maxLength: 10000
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
fundingSource:
|
|
description: The funding source that should be used when multiple sources
|
|
are available. For Brazilian combo cards, by default the funding source
|
|
is credit. To use debit, set this value to **debit**.
|
|
enum:
|
|
- credit
|
|
- debit
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: applepay
|
|
description: '**applepay**'
|
|
enum:
|
|
- applepay
|
|
type: string
|
|
required:
|
|
- applePayToken
|
|
title: Apple Pay
|
|
type: object
|
|
ApplePaySessionRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
displayName:
|
|
description: 'This is the name that your shoppers will see in the Apple
|
|
Pay interface.
|
|
|
|
|
|
The value returned as `configuration.merchantName` field from the [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods)
|
|
response.'
|
|
maxLength: 64
|
|
type: string
|
|
domainName:
|
|
description: 'The domain name you provided when you added Apple Pay in your
|
|
Customer Area.
|
|
|
|
|
|
This must match the `window.location.hostname` of the web shop.'
|
|
type: string
|
|
merchantIdentifier:
|
|
description: 'Your merchant identifier registered with Apple Pay.
|
|
|
|
|
|
Use the value of the `configuration.merchantId` field from the [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods)
|
|
response.'
|
|
type: string
|
|
required:
|
|
- domainName
|
|
- merchantIdentifier
|
|
- displayName
|
|
type: object
|
|
ApplePaySessionResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
data:
|
|
description: Base64 encoded data you need to [complete the Apple Pay merchant
|
|
validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation).
|
|
type: string
|
|
required:
|
|
- data
|
|
type: object
|
|
ApplicationInfo:
|
|
additionalProperties: false
|
|
properties:
|
|
adyenLibrary:
|
|
description: Adyen-developed software, such as libraries and plugins, used
|
|
to interact with the Adyen API. For example, Magento plugin, Java API
|
|
library, etc.
|
|
$ref: '#/components/schemas/CommonField'
|
|
adyenPaymentSource:
|
|
description: Adyen-developed software to get payment details. For example,
|
|
Checkout SDK, Secured Fields SDK, etc.
|
|
$ref: '#/components/schemas/CommonField'
|
|
externalPlatform:
|
|
description: Third-party developed platform used to initiate payment requests.
|
|
For example, Magento, Zuora, etc.
|
|
$ref: '#/components/schemas/ExternalPlatform'
|
|
merchantApplication:
|
|
description: Merchant developed software, such as cashier application, used
|
|
to interact with the Adyen API.
|
|
$ref: '#/components/schemas/CommonField'
|
|
merchantDevice:
|
|
description: Merchant device information.
|
|
$ref: '#/components/schemas/MerchantDevice'
|
|
shopperInteractionDevice:
|
|
description: Shopper interaction device, such as terminal, mobile device
|
|
or web browser, to initiate payment requests.
|
|
$ref: '#/components/schemas/ShopperInteractionDevice'
|
|
type: object
|
|
AuthenticationData:
|
|
additionalProperties: false
|
|
properties:
|
|
attemptAuthentication:
|
|
x-addedInVersion: '69'
|
|
description: 'Indicates when 3D Secure authentication should be attempted.
|
|
This overrides all other rules, including [Dynamic 3D Secure settings](https://docs.adyen.com/risk-management/dynamic-3d-secure).
|
|
|
|
|
|
Possible values:
|
|
|
|
|
|
* **always**: Perform 3D Secure authentication.
|
|
|
|
* **never**: Don''t perform 3D Secure authentication. If PSD2 SCA or other
|
|
national regulations require authentication, the transaction gets declined.'
|
|
enum:
|
|
- always
|
|
- never
|
|
type: string
|
|
authenticationOnly:
|
|
x-addedInVersion: '69'
|
|
default: false
|
|
description: 'If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
|
|
and not the payment authorisation.
|
|
|
|
Default: **false**.'
|
|
type: boolean
|
|
threeDSRequestData:
|
|
x-addedInVersion: '69'
|
|
description: Object with additional parameters for the 3D Secure authentication
|
|
flow.
|
|
$ref: '#/components/schemas/ThreeDSRequestData'
|
|
type: object
|
|
BacsDirectDebitDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
bankAccountNumber:
|
|
x-addedInVersion: '65'
|
|
description: The bank account number (without separators).
|
|
type: string
|
|
bankLocationId:
|
|
x-addedInVersion: '65'
|
|
description: The bank routing number of the account.
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
holderName:
|
|
x-addedInVersion: '65'
|
|
description: The name of the bank account holder.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
transferInstrumentId:
|
|
description: The unique identifier of your user's verified transfer instrument,
|
|
which you can use to top up their balance accounts.
|
|
type: string
|
|
type:
|
|
default: directdebit_GB
|
|
description: '**directdebit_GB**'
|
|
enum:
|
|
- directdebit_GB
|
|
type: string
|
|
title: BACS Direct Debit
|
|
type: object
|
|
BalanceCheckRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
accountInfo:
|
|
x-addedInVersion: '40'
|
|
description: 'Shopper account information for 3D Secure 2.
|
|
|
|
> For 3D Secure 2 transactions, we recommend that you include this object
|
|
to increase the chances of achieving a frictionless flow.'
|
|
$ref: '#/components/schemas/AccountInfo'
|
|
additionalAmount:
|
|
description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
|
|
request to use a non-zero value, assign this value to `additionalAmount`
|
|
(while the amount must be still set to 0 to trigger BIN or card verification).
|
|
|
|
Required to be in the same currency as the `amount`. '
|
|
$ref: '#/components/schemas/Amount'
|
|
additionalData:
|
|
additionalProperties:
|
|
type: string
|
|
x-anyOf:
|
|
- $ref: '#/components/schemas/AdditionalData3DSecure'
|
|
- $ref: '#/components/schemas/AdditionalDataAirline'
|
|
- $ref: '#/components/schemas/AdditionalDataCarRental'
|
|
- $ref: '#/components/schemas/AdditionalDataCommon'
|
|
- $ref: '#/components/schemas/AdditionalDataLevel23'
|
|
- $ref: '#/components/schemas/AdditionalDataLodging'
|
|
- $ref: '#/components/schemas/AdditionalDataOpenInvoice'
|
|
- $ref: '#/components/schemas/AdditionalDataOpi'
|
|
- $ref: '#/components/schemas/AdditionalDataRatepay'
|
|
- $ref: '#/components/schemas/AdditionalDataRetry'
|
|
- $ref: '#/components/schemas/AdditionalDataRisk'
|
|
- $ref: '#/components/schemas/AdditionalDataRiskStandalone'
|
|
- $ref: '#/components/schemas/AdditionalDataSubMerchant'
|
|
- $ref: '#/components/schemas/AdditionalDataTemporaryServices'
|
|
- $ref: '#/components/schemas/AdditionalDataWallets'
|
|
description: 'This field contains additional data, which may be required
|
|
for a particular payment request.
|
|
|
|
|
|
The `additionalData` object consists of entries, each of which includes
|
|
the key and value.'
|
|
type: object
|
|
amount:
|
|
description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)).
|
|
For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
|
|
requests, set amount to 0 (zero).
|
|
$ref: '#/components/schemas/Amount'
|
|
applicationInfo:
|
|
x-addedInVersion: '40'
|
|
description: Information about your application. For more details, see [Building
|
|
Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
|
|
$ref: '#/components/schemas/ApplicationInfo'
|
|
billingAddress:
|
|
x-addedInVersion: '4'
|
|
description: 'The address where to send the invoice.
|
|
|
|
> The `billingAddress` object is required in the following scenarios.
|
|
Include all of the fields within this object.
|
|
|
|
>* For 3D Secure 2 transactions in all browser-based and mobile implementations.
|
|
|
|
>* For cross-border payouts to and from Canada.'
|
|
$ref: '#/components/schemas/Address'
|
|
browserInfo:
|
|
description: 'The shopper''s browser information.
|
|
|
|
> For 3D Secure, the full object is required for web integrations. For
|
|
mobile app integrations, include the `userAgent` and `acceptHeader` fields
|
|
to indicate that your integration can support a redirect in case a payment
|
|
is routed to 3D Secure 2 redirect.'
|
|
$ref: '#/components/schemas/BrowserInfo'
|
|
captureDelayHours:
|
|
x-addedInVersion: '2'
|
|
description: The delay between the authorisation and scheduled auto-capture,
|
|
specified in hours.
|
|
format: int32
|
|
type: integer
|
|
dateOfBirth:
|
|
x-addedInVersion: '7'
|
|
description: 'The shopper''s date of birth.
|
|
|
|
|
|
Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
|
|
format: date
|
|
type: string
|
|
dccQuote:
|
|
description: The forex quote as returned in the response of the forex service.
|
|
$ref: '#/components/schemas/ForexQuote'
|
|
deliveryAddress:
|
|
description: The address where the purchased goods should be delivered.
|
|
$ref: '#/components/schemas/Address'
|
|
deliveryDate:
|
|
x-addedInVersion: '8'
|
|
description: 'The date and time the purchased goods should be delivered.
|
|
|
|
|
|
Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD
|
|
|
|
|
|
Example: 2017-07-17T13:42:40.428+01:00'
|
|
format: date-time
|
|
type: string
|
|
deviceFingerprint:
|
|
x-addedInVersion: '2'
|
|
description: A string containing the shopper's device fingerprint. For more
|
|
information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
|
|
maxLength: 5000
|
|
type: string
|
|
fraudOffset:
|
|
description: An integer value that is added to the normal fraud score. The
|
|
value can be either positive or negative.
|
|
format: int32
|
|
type: integer
|
|
installments:
|
|
x-addedInVersion: '4'
|
|
description: Contains installment settings. For more information, refer
|
|
to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).
|
|
$ref: '#/components/schemas/Installments'
|
|
localizedShopperStatement:
|
|
x-addedInVersion: '68'
|
|
additionalProperties:
|
|
type: string
|
|
description: "The `localizedShopperStatement` field lets you use dynamic\
|
|
\ values for your shopper statement in a local character set.\nIf not\
|
|
\ supplied, left empty, or for cross-border transactions, **shopperStatement**\
|
|
\ is used.\n\nAdyen currently supports the ja-Kana and ja-Hani character\
|
|
\ set for Visa, Mastercard and JCB payments in Japan using Japanese cards.\
|
|
\ This character set supports:\n\n* UTF-8 based Katakana, Kanji, capital\
|
|
\ letters, numbers and special characters. \n* Half-width or full-width\
|
|
\ characters."
|
|
type: object
|
|
mcc:
|
|
x-addedInVersion: '12'
|
|
description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code)
|
|
(MCC) is a four-digit number, which relates to a particular market segment.
|
|
This code reflects the predominant activity that is conducted by the merchant.
|
|
type: string
|
|
merchantAccount:
|
|
description: The merchant account identifier, with which you want to process
|
|
the transaction.
|
|
type: string
|
|
merchantOrderReference:
|
|
x-addedInVersion: '9'
|
|
description: 'This reference allows linking multiple transactions to each
|
|
other for reporting purposes (i.e. order auth-rate). The reference should
|
|
be unique per billing cycle.
|
|
|
|
The same merchant order reference should never be reused after the first
|
|
authorised attempt. If used, this field should be supplied for all incoming
|
|
authorisations.
|
|
|
|
> We strongly recommend you send the `merchantOrderReference` value to
|
|
benefit from linking payment requests when authorisation retries take
|
|
place. In addition, we recommend you provide `retry.orderAttemptNumber`,
|
|
`retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
|
|
type: string
|
|
merchantRiskIndicator:
|
|
x-addedInVersion: '40'
|
|
description: 'Additional risk fields for 3D Secure 2.
|
|
|
|
> For 3D Secure 2 transactions, we recommend that you include this object
|
|
to increase the chances of achieving a frictionless flow.'
|
|
$ref: '#/components/schemas/MerchantRiskIndicator'
|
|
metadata:
|
|
x-addedInVersion: '17'
|
|
additionalProperties:
|
|
type: string
|
|
description: 'Metadata consists of entries, each of which includes a key
|
|
and a value.
|
|
|
|
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
|
|
is the `pspReference` of the first payment. We use this to link the multiple
|
|
payments to each other. As your own reference for linking multiple payments,
|
|
use the `merchantOrderReference`instead.
|
|
type: string
|
|
paymentMethod:
|
|
additionalProperties:
|
|
type: string
|
|
description: The collection that contains the type of the payment method
|
|
and its specific information.
|
|
type: object
|
|
recurring:
|
|
description: The recurring settings for the payment. Use this property when
|
|
you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments).
|
|
$ref: '#/components/schemas/Recurring'
|
|
recurringProcessingModel:
|
|
x-addedInVersion: '30'
|
|
description: "Defines a recurring payment type. Required when creating a\
|
|
\ token to store payment details or using stored payment details.\nAllowed\
|
|
\ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\
|
|
\ amount, which follows a fixed schedule.\n* `CardOnFile` \u2013 With\
|
|
\ a card-on-file (CoF) transaction, card details are stored to enable\
|
|
\ one-click or omnichannel journeys, or simply to streamline the checkout\
|
|
\ process. Any subscription not following a fixed schedule is also considered\
|
|
\ a card-on-file transaction.\n* `UnscheduledCardOnFile` \u2013 An unscheduled\
|
|
\ card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed\
|
|
\ schedule and/or have variable amounts. For example, automatic top-ups\
|
|
\ when a cardholder's balance drops below a certain amount.\n"
|
|
enum:
|
|
- CardOnFile
|
|
- Subscription
|
|
- UnscheduledCardOnFile
|
|
type: string
|
|
reference:
|
|
description: 'The reference to uniquely identify a payment. This reference
|
|
is used in all communication with you about the payment status. We recommend
|
|
using a unique value per payment; however, it is not a requirement.
|
|
|
|
If you need to provide multiple references for a transaction, separate
|
|
them with hyphens ("-").
|
|
|
|
Maximum length: 80 characters.'
|
|
type: string
|
|
selectedBrand:
|
|
description: 'Some payment methods require defining a value for this field
|
|
to specify how to process the transaction.
|
|
|
|
|
|
For the Bancontact payment method, it can be set to:
|
|
|
|
* `maestro` (default), to be processed like a Maestro card, or
|
|
|
|
* `bcmc`, to be processed like a Bancontact card.'
|
|
type: string
|
|
selectedRecurringDetailReference:
|
|
description: The `recurringDetailReference` you want to use for this payment.
|
|
The value `LATEST` can be used to select the most recently stored recurring
|
|
detail.
|
|
type: string
|
|
sessionId:
|
|
description: A session ID used to identify a payment session.
|
|
type: string
|
|
shopperEmail:
|
|
description: 'The shopper''s email address. We recommend that you provide
|
|
this data, as it is used in velocity fraud checks.
|
|
|
|
> For 3D Secure 2 transactions, schemes require `shopperEmail` for all
|
|
browser-based and mobile implementations.'
|
|
type: string
|
|
shopperIP:
|
|
description: 'The shopper''s IP address. In general, we recommend that you
|
|
provide this data, as it is used in a number of risk checks (for instance,
|
|
number of payment attempts or location-based checks).
|
|
|
|
> For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based
|
|
implementations.
|
|
|
|
This field is also mandatory for some merchants depending on your business
|
|
model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
|
|
type: string
|
|
shopperInteraction:
|
|
description: 'Specifies the sales channel, through which the shopper gives
|
|
their card details, and whether the shopper is a returning customer.
|
|
|
|
For the web service API, Adyen assumes Ecommerce shopper interaction by
|
|
default.
|
|
|
|
|
|
This field has the following possible values:
|
|
|
|
* `Ecommerce` - Online transactions where the cardholder is present (online).
|
|
For better authorisation rates, we recommend sending the card security
|
|
code (CSC) along with the request.
|
|
|
|
* `ContAuth` - Card on file and/or subscription transactions, where the
|
|
cardholder is known to the merchant (returning customer). If the shopper
|
|
is present (online), you can supply also the CSC to improve authorisation
|
|
(one-click payment).
|
|
|
|
* `Moto` - Mail-order and telephone-order transactions where the shopper
|
|
is in contact with the merchant via email or telephone.
|
|
|
|
* `POS` - Point-of-sale transactions where the shopper is physically present
|
|
to make a payment using a secure payment terminal.'
|
|
enum:
|
|
- Ecommerce
|
|
- ContAuth
|
|
- Moto
|
|
- POS
|
|
type: string
|
|
shopperLocale:
|
|
x-addedInVersion: '7'
|
|
description: The combination of a language code and a country code to specify
|
|
the language to be used in the payment.
|
|
type: string
|
|
shopperName:
|
|
x-addedInVersion: '7'
|
|
description: The shopper's full name.
|
|
$ref: '#/components/schemas/Name'
|
|
shopperReference:
|
|
description: "Required for recurring payments. \nYour reference to uniquely\
|
|
\ identify this shopper, for example user ID or account ID. The value\
|
|
\ is case-sensitive and must be at least three characters.\n> Your reference\
|
|
\ must not include personally identifiable information (PII) such as name\
|
|
\ or email address."
|
|
type: string
|
|
shopperStatement:
|
|
description: "The text to be shown on the shopper's bank statement.\n We\
|
|
\ recommend sending a maximum of 22 characters, otherwise banks might\
|
|
\ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
|
|
\ spaces, and special characters **. , ' _ - ? + * /**."
|
|
type: string
|
|
socialSecurityNumber:
|
|
x-addedInVersion: '4'
|
|
description: The shopper's social security number.
|
|
type: string
|
|
splits:
|
|
x-addedInVersion: '37'
|
|
description: An array of objects specifying how the payment should be split
|
|
when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments)
|
|
or [platforms](https://docs.adyen.com/platforms/split-payments), or standalone
|
|
[Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).
|
|
items:
|
|
$ref: '#/components/schemas/Split'
|
|
type: array
|
|
store:
|
|
x-addedInVersion: '23'
|
|
description: Required for Adyen for Platforms integrations if you are a
|
|
platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference)
|
|
(on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference)
|
|
(in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store))
|
|
for the ecommerce or point-of-sale store that is processing the payment.
|
|
maxLength: 16
|
|
minLength: 1
|
|
type: string
|
|
telephoneNumber:
|
|
x-addedInVersion: '7'
|
|
description: The shopper's telephone number.
|
|
type: string
|
|
threeDS2RequestData:
|
|
x-addedInVersion: '40'
|
|
description: Request fields for 3D Secure 2. To check if any of the following
|
|
fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments)
|
|
or [Classic integration](https://docs.adyen.com/classic-integration) documentation.
|
|
$ref: '#/components/schemas/ThreeDS2RequestData'
|
|
threeDSAuthenticationOnly:
|
|
x-addedInVersion: '50'
|
|
deprecated: true
|
|
x-deprecatedInVersion: '69'
|
|
x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
|
|
default: false
|
|
description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
|
|
and not the payment authorisation.
|
|
type: boolean
|
|
totalsGroup:
|
|
x-addedInVersion: '23'
|
|
description: The reference value to aggregate sales totals in reporting.
|
|
When not specified, the store field is used (if available).
|
|
maxLength: 16
|
|
minLength: 1
|
|
type: string
|
|
trustedShopper:
|
|
x-addedInVersion: '37'
|
|
description: Set to true if the payment should be routed to a trusted MID.
|
|
type: boolean
|
|
required:
|
|
- merchantAccount
|
|
- amount
|
|
- paymentMethod
|
|
type: object
|
|
BalanceCheckResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
additionalData:
|
|
additionalProperties:
|
|
type: string
|
|
x-anyOf:
|
|
- $ref: '#/components/schemas/ResponseAdditionalData3DSecure'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataCard'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataCommon'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataDomesticError'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataOpi'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataSepa'
|
|
description: 'Contains additional information about the payment. Some data
|
|
fields are included only if you select them first: Go to **Customer Area**
|
|
> **Developers** > **Additional data**.'
|
|
type: object
|
|
balance:
|
|
description: The balance for the payment method.
|
|
$ref: '#/components/schemas/Amount'
|
|
fraudResult:
|
|
description: The fraud result properties of the payment.
|
|
$ref: '#/components/schemas/FraudResult'
|
|
pspReference:
|
|
description: Adyen's 16-character reference associated with the transaction/request.
|
|
This value is globally unique; quote it when communicating with us about
|
|
this request.
|
|
type: string
|
|
refusalReason:
|
|
description: 'If the payment''s authorisation is refused or an error occurs
|
|
during authorisation, this field holds Adyen''s mapped reason for the
|
|
refusal or a description of the error. When a transaction fails, the authorisation
|
|
response includes `resultCode` and `refusalReason` values.
|
|
|
|
|
|
For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).'
|
|
type: string
|
|
resultCode:
|
|
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:
|
|
- Success
|
|
- NotEnoughBalance
|
|
- Failed
|
|
type: string
|
|
transactionLimit:
|
|
x-addedInVersion: '65'
|
|
description: The maximum spendable balance for a single transaction. Applicable
|
|
to some gift cards.
|
|
$ref: '#/components/schemas/Amount'
|
|
required:
|
|
- balance
|
|
- resultCode
|
|
type: object
|
|
BillDeskDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
issuer:
|
|
description: The issuer id of the shopper's selected bank.
|
|
type: string
|
|
type:
|
|
description: '**billdesk**'
|
|
enum:
|
|
- billdesk_online
|
|
- billdesk_wallet
|
|
type: string
|
|
required:
|
|
- type
|
|
- issuer
|
|
title: BillDesk
|
|
type: object
|
|
BillingAddress:
|
|
additionalProperties: false
|
|
properties:
|
|
city:
|
|
description: 'The name of the city. Maximum length: 3000 characters.'
|
|
maxLength: 3000
|
|
type: string
|
|
country:
|
|
description: 'The two-character ISO-3166-1 alpha-2 country code. For example,
|
|
**US**.
|
|
|
|
> If you don''t know the country or are not collecting the country from
|
|
the shopper, provide `country` as `ZZ`.'
|
|
type: string
|
|
houseNumberOrName:
|
|
description: 'The number or name of the house. Maximum length: 3000 characters.'
|
|
maxLength: 3000
|
|
type: string
|
|
postalCode:
|
|
description: A maximum of five digits for an address in the US, or a maximum
|
|
of ten characters for an address in all other countries.
|
|
type: string
|
|
stateOrProvince:
|
|
description: 'The two-character ISO 3166-2 state or province code. For example,
|
|
**CA** in the US or **ON** in Canada.
|
|
|
|
> Required for the US and Canada.'
|
|
maxLength: 1000
|
|
type: string
|
|
street:
|
|
description: 'The name of the street. Maximum length: 3000 characters.
|
|
|
|
> The house number should not be included in this field; it should be
|
|
separately provided via `houseNumberOrName`.'
|
|
maxLength: 3000
|
|
type: string
|
|
required:
|
|
- street
|
|
- houseNumberOrName
|
|
- city
|
|
- postalCode
|
|
- country
|
|
type: object
|
|
BlikDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
blikCode:
|
|
description: BLIK code consisting of 6 digits.
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
description: '**blik**'
|
|
enum:
|
|
- blik
|
|
type: string
|
|
title: BLIK
|
|
type: object
|
|
BrowserInfo:
|
|
additionalProperties: false
|
|
properties:
|
|
acceptHeader:
|
|
description: The accept header value of the shopper's browser.
|
|
type: string
|
|
colorDepth:
|
|
x-addedInVersion: '40'
|
|
description: 'The color depth of the shopper''s browser in bits per pixel.
|
|
This should be obtained by using the browser''s `screen.colorDepth` property.
|
|
Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.'
|
|
format: int32
|
|
type: integer
|
|
javaEnabled:
|
|
x-addedInVersion: '40'
|
|
description: Boolean value indicating if the shopper's browser is able to
|
|
execute Java.
|
|
type: boolean
|
|
javaScriptEnabled:
|
|
x-addedInVersion: '40'
|
|
default: true
|
|
description: Boolean value indicating if the shopper's browser is able to
|
|
execute JavaScript. A default 'true' value is assumed if the field is
|
|
not present.
|
|
type: boolean
|
|
language:
|
|
x-addedInVersion: '40'
|
|
description: The `navigator.language` value of the shopper's browser (as
|
|
defined in IETF BCP 47).
|
|
type: string
|
|
screenHeight:
|
|
x-addedInVersion: '40'
|
|
description: The total height of the shopper's device screen in pixels.
|
|
format: int32
|
|
type: integer
|
|
screenWidth:
|
|
x-addedInVersion: '40'
|
|
description: The total width of the shopper's device screen in pixels.
|
|
format: int32
|
|
type: integer
|
|
timeZoneOffset:
|
|
x-addedInVersion: '40'
|
|
description: Time difference between UTC time and the shopper's browser
|
|
local time, in minutes.
|
|
format: int32
|
|
type: integer
|
|
userAgent:
|
|
description: The user agent value of the shopper's browser.
|
|
type: string
|
|
required:
|
|
- userAgent
|
|
- acceptHeader
|
|
- javaEnabled
|
|
- colorDepth
|
|
- screenHeight
|
|
- screenWidth
|
|
- timeZoneOffset
|
|
- language
|
|
type: object
|
|
CancelOrderRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
merchantAccount:
|
|
description: The merchant account identifier that orderData belongs to.
|
|
type: string
|
|
order:
|
|
description: The order request object that contains a pspReference that
|
|
represents the order and the matching encrypted order data.
|
|
$ref: '#/components/schemas/EncryptedOrderData'
|
|
required:
|
|
- order
|
|
- merchantAccount
|
|
type: object
|
|
CancelOrderResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
pspReference:
|
|
description: A unique reference of the cancellation request.
|
|
type: string
|
|
resultCode:
|
|
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
|
|
- resultCode
|
|
type: object
|
|
CardBrandDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
supported:
|
|
description: Indicates if you support the card brand.
|
|
type: boolean
|
|
type:
|
|
description: The name of the card brand.
|
|
type: string
|
|
type: object
|
|
CardDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
brand:
|
|
description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.'
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
cupsecureplus.smscode:
|
|
deprecated: true
|
|
type: string
|
|
cvc:
|
|
description: The card verification code. Only collect raw card data if you
|
|
are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
|
|
type: string
|
|
encryptedCard:
|
|
description: Only include this for JSON Web Encryption (JWE) implementations.
|
|
The JWE-encrypted card details.
|
|
maxLength: 40000
|
|
type: string
|
|
encryptedCardNumber:
|
|
description: The encrypted card number.
|
|
maxLength: 15000
|
|
type: string
|
|
encryptedExpiryMonth:
|
|
description: The encrypted card expiry month.
|
|
maxLength: 15000
|
|
type: string
|
|
encryptedExpiryYear:
|
|
description: The encrypted card expiry year.
|
|
maxLength: 15000
|
|
type: string
|
|
encryptedSecurityCode:
|
|
description: The encrypted card verification code.
|
|
maxLength: 15000
|
|
type: string
|
|
expiryMonth:
|
|
description: The card expiry month. Only collect raw card data if you are
|
|
[fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
|
|
type: string
|
|
expiryYear:
|
|
description: The card expiry year. Only collect raw card data if you are
|
|
[fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
|
|
type: string
|
|
fastlaneData:
|
|
description: The encoded fastlane data blob
|
|
type: string
|
|
fundingSource:
|
|
description: The funding source that should be used when multiple sources
|
|
are available. For Brazilian combo cards, by default the funding source
|
|
is credit. To use debit, set this value to **debit**.
|
|
enum:
|
|
- credit
|
|
- debit
|
|
type: string
|
|
holderName:
|
|
description: The name of the card holder.
|
|
maxLength: 15000
|
|
type: string
|
|
networkPaymentReference:
|
|
description: The transaction identifier from card schemes. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference)
|
|
from the response to the first payment.
|
|
type: string
|
|
number:
|
|
description: The card number. Only collect raw card data if you are [fully
|
|
PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
shopperNotificationReference:
|
|
description: The `shopperNotificationReference` returned in the response
|
|
when you requested to notify the shopper. Used only for recurring payments
|
|
in India.
|
|
type: string
|
|
srcCorrelationId:
|
|
description: An identifier used for the Click to Pay transaction.
|
|
type: string
|
|
srcDigitalCardId:
|
|
description: The SRC reference for the Click to Pay token.
|
|
type: string
|
|
srcScheme:
|
|
description: The scheme that is being used for Click to Pay.
|
|
type: string
|
|
srcTokenReference:
|
|
description: The reference for the Click to Pay token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
threeDS2SdkVersion:
|
|
description: Required for mobile integrations. Version of the 3D Secure
|
|
2 mobile SDK.
|
|
maxLength: 12
|
|
type: string
|
|
type:
|
|
default: scheme
|
|
description: Default payment method details. Common for scheme payment methods,
|
|
and for simple payment method details.
|
|
enum:
|
|
- bcmc
|
|
- scheme
|
|
- networkToken
|
|
- giftcard
|
|
- card
|
|
- clicktopay
|
|
type: string
|
|
title: Card
|
|
type: object
|
|
CardDetailsRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
cardNumber:
|
|
description: "A minimum of the first eight digits of the card number. The\
|
|
\ full card number gives the best result. \n\nYou must be [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide)\
|
|
\ to collect raw card data."
|
|
type: string
|
|
countryCode:
|
|
description: 'The shopper country.
|
|
|
|
|
|
Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
|
|
|
|
Example: NL or DE'
|
|
type: string
|
|
encryptedCardNumber:
|
|
description: The encrypted card number.
|
|
maxLength: 15000
|
|
type: string
|
|
merchantAccount:
|
|
description: The merchant account identifier, with which you want to process
|
|
the transaction.
|
|
type: string
|
|
supportedBrands:
|
|
description: "The card brands you support. This is the [`brands`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods__resParam_paymentMethods-brands)\
|
|
\ array from your [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods)\
|
|
\ response. \n\nIf not included, our API uses the ones configured for\
|
|
\ your merchant account and, if provided, the country code."
|
|
items:
|
|
type: string
|
|
type: array
|
|
required:
|
|
- cardNumber
|
|
- merchantAccount
|
|
type: object
|
|
CardDetailsResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
brands:
|
|
description: The list of brands identified for the card.
|
|
items:
|
|
$ref: '#/components/schemas/CardBrandDetails'
|
|
type: array
|
|
fundingSource:
|
|
description: The funding source of the card, for example **DEBIT**, **CREDIT**,
|
|
or **PREPAID**.
|
|
type: string
|
|
isCardCommercial:
|
|
description: Indicates if this is a commercial card or a consumer card.
|
|
If **true**, it is a commercial card. If **false**, it is a consumer card.
|
|
type: boolean
|
|
issuingCountryCode:
|
|
description: The two-letter country code of the country where the card
|
|
was issued.
|
|
type: string
|
|
type: object
|
|
CardDonations:
|
|
additionalProperties: false
|
|
properties:
|
|
brand:
|
|
description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.'
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
cupsecureplus.smscode:
|
|
deprecated: true
|
|
type: string
|
|
cvc:
|
|
description: The card verification code. Only collect raw card data if you
|
|
are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
|
|
type: string
|
|
encryptedCard:
|
|
description: Only include this for JSON Web Encryption (JWE) implementations.
|
|
The JWE-encrypted card details.
|
|
maxLength: 40000
|
|
type: string
|
|
encryptedCardNumber:
|
|
description: The encrypted card number.
|
|
maxLength: 15000
|
|
type: string
|
|
encryptedExpiryMonth:
|
|
description: The encrypted card expiry month.
|
|
maxLength: 15000
|
|
type: string
|
|
encryptedExpiryYear:
|
|
description: The encrypted card expiry year.
|
|
maxLength: 15000
|
|
type: string
|
|
encryptedSecurityCode:
|
|
description: The encrypted card verification code.
|
|
maxLength: 15000
|
|
type: string
|
|
expiryMonth:
|
|
description: The card expiry month. Only collect raw card data if you are
|
|
[fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
|
|
type: string
|
|
expiryYear:
|
|
description: The card expiry year. Only collect raw card data if you are
|
|
[fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
|
|
type: string
|
|
fastlaneData:
|
|
description: The encoded fastlane data blob
|
|
type: string
|
|
fundingSource:
|
|
description: The funding source that should be used when multiple sources
|
|
are available. For Brazilian combo cards, by default the funding source
|
|
is credit. To use debit, set this value to **debit**.
|
|
enum:
|
|
- credit
|
|
- debit
|
|
type: string
|
|
holderName:
|
|
description: The name of the card holder.
|
|
maxLength: 15000
|
|
type: string
|
|
networkPaymentReference:
|
|
description: The transaction identifier from card schemes. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference)
|
|
from the response to the first payment.
|
|
type: string
|
|
number:
|
|
description: The card number. Only collect raw card data if you are [fully
|
|
PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
shopperNotificationReference:
|
|
description: The `shopperNotificationReference` returned in the response
|
|
when you requested to notify the shopper. Used only for recurring payments
|
|
in India.
|
|
type: string
|
|
srcCorrelationId:
|
|
description: An identifier used for the Click to Pay transaction.
|
|
type: string
|
|
srcDigitalCardId:
|
|
description: The SRC reference for the Click to Pay token.
|
|
type: string
|
|
srcScheme:
|
|
description: The scheme that is being used for Click to Pay.
|
|
type: string
|
|
srcTokenReference:
|
|
description: The reference for the Click to Pay token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
threeDS2SdkVersion:
|
|
description: Required for mobile integrations. Version of the 3D Secure
|
|
2 mobile SDK.
|
|
maxLength: 12
|
|
type: string
|
|
type:
|
|
default: scheme
|
|
description: Default payment method details. Common for scheme payment methods,
|
|
and for simple payment method details.
|
|
enum:
|
|
- bcmc
|
|
- scheme
|
|
- networkToken
|
|
- giftcard
|
|
- card
|
|
- clicktopay
|
|
type: string
|
|
title: Card
|
|
type: object
|
|
CashAppDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
cashtag:
|
|
description: Cash App issued cashtag for recurring payment
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
customerId:
|
|
description: Cash App issued customerId for recurring payment
|
|
type: string
|
|
grantId:
|
|
description: Cash App issued grantId for one time payment
|
|
type: string
|
|
onFileGrantId:
|
|
description: Cash App issued onFileGrantId for recurring payment
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
requestId:
|
|
description: Cash App request id
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
subtype:
|
|
description: The payment method subtype.
|
|
type: string
|
|
type:
|
|
default: cashapp
|
|
description: cashapp
|
|
enum:
|
|
- cashapp
|
|
type: string
|
|
title: Stored Payment Method
|
|
type: object
|
|
CellulantDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
issuer:
|
|
description: The Cellulant issuer.
|
|
type: string
|
|
type:
|
|
default: cellulant
|
|
description: '**Cellulant**'
|
|
enum:
|
|
- cellulant
|
|
type: string
|
|
title: Cellulant
|
|
type: object
|
|
CheckoutAwaitAction:
|
|
additionalProperties: false
|
|
properties:
|
|
paymentData:
|
|
description: Encoded payment data.
|
|
type: string
|
|
paymentMethodType:
|
|
description: Specifies the payment method.
|
|
type: string
|
|
type:
|
|
description: '**await**'
|
|
enum:
|
|
- await
|
|
type: string
|
|
url:
|
|
description: Specifies the URL to redirect to.
|
|
type: string
|
|
required:
|
|
- type
|
|
type: object
|
|
CheckoutBankAccount:
|
|
additionalProperties: false
|
|
properties:
|
|
accountType:
|
|
description: The type of the bank account.
|
|
enum:
|
|
- balance
|
|
- checking
|
|
- deposit
|
|
- general
|
|
- other
|
|
- payment
|
|
- savings
|
|
type: string
|
|
bankAccountNumber:
|
|
description: The bank account number (without separators).
|
|
type: string
|
|
bankCity:
|
|
description: The bank city.
|
|
type: string
|
|
bankLocationId:
|
|
description: The location id of the bank. The field value is `nil` in most
|
|
cases.
|
|
type: string
|
|
bankName:
|
|
description: The name of the bank.
|
|
type: string
|
|
bic:
|
|
description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362)
|
|
(BIC) is the SWIFT address assigned to a bank. The field value is `nil`
|
|
in most cases.
|
|
type: string
|
|
countryCode:
|
|
description: 'Country code where the bank is located.
|
|
|
|
|
|
A valid value is an ISO two-character country code (e.g. ''NL'').'
|
|
type: string
|
|
iban:
|
|
description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number)
|
|
(IBAN).
|
|
type: string
|
|
ownerName:
|
|
description: "The name of the bank account holder.\nIf you submit a name\
|
|
\ with non-Latin characters, we automatically replace some of them with\
|
|
\ corresponding Latin characters to meet the FATF recommendations. For\
|
|
\ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\
|
|
\ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\
|
|
\ accept '\xF8'.\nAfter replacement, the ownerName must have at least\
|
|
\ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\
|
|
\ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\
|
|
\ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\
|
|
> If provided details don't match the required format, the response returns\
|
|
\ the error message: 203 'Invalid bank account holder name'."
|
|
type: string
|
|
taxId:
|
|
description: The bank account holder's tax ID.
|
|
type: string
|
|
type: object
|
|
CheckoutBankTransferAction:
|
|
additionalProperties: false
|
|
properties:
|
|
accountNumber:
|
|
description: The account number of the bank transfer.
|
|
type: string
|
|
beneficiary:
|
|
description: The name of the account holder.
|
|
type: string
|
|
bic:
|
|
description: The BIC of the IBAN.
|
|
type: string
|
|
downloadUrl:
|
|
description: The url to download payment details with.
|
|
type: string
|
|
iban:
|
|
description: The IBAN of the bank transfer.
|
|
type: string
|
|
paymentMethodType:
|
|
description: Specifies the payment method.
|
|
type: string
|
|
reference:
|
|
description: The transfer reference.
|
|
type: string
|
|
routingNumber:
|
|
description: The routing number of the bank transfer.
|
|
type: string
|
|
shopperEmail:
|
|
description: The e-mail of the shopper, included if an e-mail was sent to
|
|
the shopper.
|
|
type: string
|
|
sortCode:
|
|
description: The sort code of the bank transfer.
|
|
type: string
|
|
totalAmount:
|
|
description: The amount of the bank transfer.
|
|
$ref: '#/components/schemas/Amount'
|
|
type:
|
|
description: The type of the action.
|
|
enum:
|
|
- bankTransfer
|
|
type: string
|
|
url:
|
|
description: Specifies the URL to redirect to.
|
|
type: string
|
|
required:
|
|
- type
|
|
type: object
|
|
CheckoutDelegatedAuthenticationAction:
|
|
additionalProperties: false
|
|
properties:
|
|
authorisationToken:
|
|
description: A token needed to authorise a payment.
|
|
type: string
|
|
paymentData:
|
|
description: Encoded payment data.
|
|
type: string
|
|
paymentMethodType:
|
|
description: Specifies the payment method.
|
|
type: string
|
|
token:
|
|
description: A token to pass to the delegatedAuthentication component.
|
|
type: string
|
|
type:
|
|
description: '**delegatedAuthentication**'
|
|
enum:
|
|
- delegatedAuthentication
|
|
type: string
|
|
url:
|
|
description: Specifies the URL to redirect to.
|
|
type: string
|
|
required:
|
|
- type
|
|
type: object
|
|
CheckoutNativeRedirectAction:
|
|
additionalProperties: false
|
|
properties:
|
|
data:
|
|
additionalProperties:
|
|
type: string
|
|
description: When the redirect URL must be accessed via POST, use this data
|
|
to post to the redirect URL.
|
|
type: object
|
|
method:
|
|
description: Specifies the HTTP method, for example GET or POST.
|
|
type: string
|
|
nativeRedirectData:
|
|
description: Native SDK's redirect data containing the direct issuer link
|
|
and state data that must be submitted to the /v1/nativeRedirect/redirectResult.
|
|
type: string
|
|
paymentMethodType:
|
|
description: Specifies the payment method.
|
|
type: string
|
|
type:
|
|
description: '**nativeRedirect**'
|
|
enum:
|
|
- nativeRedirect
|
|
type: string
|
|
url:
|
|
description: Specifies the URL to redirect to.
|
|
type: string
|
|
required:
|
|
- type
|
|
type: object
|
|
CheckoutOrderResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
amount:
|
|
description: The initial amount of the order.
|
|
$ref: '#/components/schemas/Amount'
|
|
expiresAt:
|
|
description: The expiry date for the order.
|
|
type: string
|
|
orderData:
|
|
description: The encrypted order data.
|
|
type: string
|
|
pspReference:
|
|
description: The `pspReference` that belongs to the order.
|
|
type: string
|
|
reference:
|
|
description: The merchant reference for the order.
|
|
type: string
|
|
remainingAmount:
|
|
description: The updated remaining amount.
|
|
$ref: '#/components/schemas/Amount'
|
|
required:
|
|
- pspReference
|
|
type: object
|
|
CheckoutQrCodeAction:
|
|
additionalProperties: false
|
|
properties:
|
|
expiresAt:
|
|
description: Expiry time of the QR code.
|
|
type: string
|
|
paymentData:
|
|
description: Encoded payment data.
|
|
type: string
|
|
paymentMethodType:
|
|
description: Specifies the payment method.
|
|
type: string
|
|
qrCodeData:
|
|
description: The contents of the QR code as a UTF8 string.
|
|
type: string
|
|
type:
|
|
description: '**qrCode**'
|
|
enum:
|
|
- qrCode
|
|
type: string
|
|
url:
|
|
description: Specifies the URL to redirect to.
|
|
type: string
|
|
required:
|
|
- type
|
|
type: object
|
|
CheckoutRedirectAction:
|
|
additionalProperties: false
|
|
properties:
|
|
data:
|
|
additionalProperties:
|
|
type: string
|
|
description: When the redirect URL must be accessed via POST, use this data
|
|
to post to the redirect URL.
|
|
type: object
|
|
method:
|
|
description: Specifies the HTTP method, for example GET or POST.
|
|
type: string
|
|
paymentMethodType:
|
|
description: Specifies the payment method.
|
|
type: string
|
|
type:
|
|
description: '**redirect**'
|
|
enum:
|
|
- redirect
|
|
type: string
|
|
url:
|
|
description: Specifies the URL to redirect to.
|
|
type: string
|
|
required:
|
|
- type
|
|
type: object
|
|
CheckoutSDKAction:
|
|
additionalProperties: false
|
|
properties:
|
|
paymentData:
|
|
description: Encoded payment data.
|
|
type: string
|
|
paymentMethodType:
|
|
description: Specifies the payment method.
|
|
type: string
|
|
sdkData:
|
|
additionalProperties:
|
|
type: string
|
|
description: The data to pass to the SDK.
|
|
type: object
|
|
type:
|
|
description: The type of the action.
|
|
enum:
|
|
- sdk
|
|
- wechatpaySDK
|
|
type: string
|
|
url:
|
|
description: Specifies the URL to redirect to.
|
|
type: string
|
|
required:
|
|
- type
|
|
type: object
|
|
CheckoutSessionInstallmentOption:
|
|
additionalProperties: false
|
|
properties:
|
|
plans:
|
|
description: 'Defines the type of installment plan. If not set, defaults
|
|
to **regular**.
|
|
|
|
|
|
Possible values:
|
|
|
|
* **regular**
|
|
|
|
* **revolving*** **bonus**
|
|
|
|
* **with_interest**
|
|
|
|
* **buynow_paylater**
|
|
|
|
* **nointerest_bonus**
|
|
|
|
* **interest_bonus**
|
|
|
|
* **refund_prctg**
|
|
|
|
* **nointeres_refund_prctg**
|
|
|
|
* **interes_refund_prctg**'
|
|
items:
|
|
enum:
|
|
- bonus
|
|
- buynow_paylater
|
|
- interes_refund_prctg
|
|
- interest_bonus
|
|
- nointeres_refund_prctg
|
|
- nointerest_bonus
|
|
- refund_prctg
|
|
- regular
|
|
- revolving
|
|
- with_interest
|
|
type: string
|
|
type: array
|
|
preselectedValue:
|
|
description: Preselected number of installments offered for this payment
|
|
method.
|
|
format: int32
|
|
type: integer
|
|
values:
|
|
description: An array of the number of installments that the shopper can
|
|
choose from. For example, **[2,3,5]**. This cannot be specified simultaneously
|
|
with `maxValue`.
|
|
items:
|
|
format: int32
|
|
type: integer
|
|
type: array
|
|
type: object
|
|
CheckoutSessionThreeDS2RequestData:
|
|
additionalProperties: false
|
|
properties:
|
|
homePhone:
|
|
description: The home phone number provided by the Cardholder.
|
|
$ref: '#/components/schemas/Phone'
|
|
mobilePhone:
|
|
description: The mobile phone number provided by the Cardholder.
|
|
$ref: '#/components/schemas/Phone'
|
|
threeDSRequestorChallengeInd:
|
|
description: "Indicates whether a challenge is requested for this transaction.\
|
|
\ Possible values:\n* **01** \u2014 No preference\n* **02** \u2014 No\
|
|
\ challenge requested\n* **03** \u2014 Challenge requested (3DS Requestor\
|
|
\ preference)\n* **04** \u2014 Challenge requested (Mandate)\n* **05**\
|
|
\ \u2014 No challenge (transactional risk analysis is already performed)\n\
|
|
* **06** \u2014 Data Only"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
- '05'
|
|
- '06'
|
|
type: string
|
|
workPhone:
|
|
description: The work phone number provided by the Cardholder.
|
|
$ref: '#/components/schemas/Phone'
|
|
type: object
|
|
CheckoutThreeDS2Action:
|
|
additionalProperties: false
|
|
properties:
|
|
authorisationToken:
|
|
description: A token needed to authorise a payment.
|
|
type: string
|
|
paymentData:
|
|
description: Encoded payment data.
|
|
type: string
|
|
paymentMethodType:
|
|
description: Specifies the payment method.
|
|
type: string
|
|
subtype:
|
|
description: A subtype of the token.
|
|
type: string
|
|
token:
|
|
description: A token to pass to the 3DS2 Component to get the fingerprint.
|
|
type: string
|
|
type:
|
|
description: '**threeDS2**'
|
|
enum:
|
|
- threeDS2
|
|
type: string
|
|
url:
|
|
description: Specifies the URL to redirect to.
|
|
type: string
|
|
required:
|
|
- type
|
|
type: object
|
|
CheckoutVoucherAction:
|
|
additionalProperties: false
|
|
properties:
|
|
alternativeReference:
|
|
description: The voucher alternative reference code.
|
|
type: string
|
|
collectionInstitutionNumber:
|
|
description: A collection institution number (store number) for Econtext
|
|
Pay-Easy ATM.
|
|
type: string
|
|
downloadUrl:
|
|
description: The URL to download the voucher.
|
|
type: string
|
|
entity:
|
|
description: An entity number of Multibanco.
|
|
type: string
|
|
expiresAt:
|
|
description: The date time of the voucher expiry.
|
|
type: string
|
|
initialAmount:
|
|
description: The initial amount.
|
|
$ref: '#/components/schemas/Amount'
|
|
instructionsUrl:
|
|
description: The URL to the detailed instructions to make payment using
|
|
the voucher.
|
|
type: string
|
|
issuer:
|
|
description: The issuer of the voucher.
|
|
type: string
|
|
maskedTelephoneNumber:
|
|
description: The shopper telephone number (partially masked).
|
|
type: string
|
|
merchantName:
|
|
description: The merchant name.
|
|
type: string
|
|
merchantReference:
|
|
description: The merchant reference.
|
|
type: string
|
|
passCreationToken:
|
|
x-addedInVersion: '68'
|
|
description: A Base64-encoded token containing all properties of the voucher.
|
|
For iOS, you can use this to pass a voucher to Apple Wallet.
|
|
type: string
|
|
paymentData:
|
|
description: Encoded payment data.
|
|
type: string
|
|
paymentMethodType:
|
|
description: Specifies the payment method.
|
|
type: string
|
|
reference:
|
|
description: The voucher reference code.
|
|
type: string
|
|
shopperEmail:
|
|
description: The shopper email.
|
|
type: string
|
|
shopperName:
|
|
description: The shopper name.
|
|
type: string
|
|
surcharge:
|
|
description: The surcharge amount.
|
|
$ref: '#/components/schemas/Amount'
|
|
totalAmount:
|
|
description: The total amount (initial plus surcharge amount).
|
|
$ref: '#/components/schemas/Amount'
|
|
type:
|
|
description: '**voucher**'
|
|
enum:
|
|
- voucher
|
|
type: string
|
|
url:
|
|
description: Specifies the URL to redirect to.
|
|
type: string
|
|
required:
|
|
- type
|
|
type: object
|
|
CommonField:
|
|
additionalProperties: false
|
|
properties:
|
|
name:
|
|
description: Name of the field. For example, Name of External Platform.
|
|
type: string
|
|
version:
|
|
description: Version of the field. For example, Version of External Platform.
|
|
type: string
|
|
type: object
|
|
Company:
|
|
additionalProperties: false
|
|
properties:
|
|
homepage:
|
|
description: The company website's home page.
|
|
type: string
|
|
name:
|
|
description: The company name.
|
|
type: string
|
|
registrationNumber:
|
|
description: Registration number of the company.
|
|
type: string
|
|
registryLocation:
|
|
description: Registry location of the company.
|
|
type: string
|
|
taxId:
|
|
description: Tax ID of the company.
|
|
type: string
|
|
type:
|
|
description: The company type.
|
|
type: string
|
|
type: object
|
|
CreateCheckoutSessionRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
accountInfo:
|
|
description: 'Shopper account information for 3D Secure 2.
|
|
|
|
> For 3D Secure 2 transactions, we recommend that you include this object
|
|
to increase the chances of achieving a frictionless flow.'
|
|
$ref: '#/components/schemas/AccountInfo'
|
|
additionalAmount:
|
|
description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
|
|
request to use a non-zero value, assign this value to `additionalAmount`
|
|
(while the amount must be still set to 0 to trigger BIN or card verification).
|
|
|
|
Required to be in the same currency as the `amount`. '
|
|
$ref: '#/components/schemas/Amount'
|
|
additionalData:
|
|
additionalProperties:
|
|
type: string
|
|
x-anyOf:
|
|
- $ref: '#/components/schemas/AdditionalData3DSecure'
|
|
- $ref: '#/components/schemas/AdditionalDataAirline'
|
|
- $ref: '#/components/schemas/AdditionalDataCarRental'
|
|
- $ref: '#/components/schemas/AdditionalDataCommon'
|
|
- $ref: '#/components/schemas/AdditionalDataLevel23'
|
|
- $ref: '#/components/schemas/AdditionalDataLodging'
|
|
- $ref: '#/components/schemas/AdditionalDataOpenInvoice'
|
|
- $ref: '#/components/schemas/AdditionalDataOpi'
|
|
- $ref: '#/components/schemas/AdditionalDataRatepay'
|
|
- $ref: '#/components/schemas/AdditionalDataRetry'
|
|
- $ref: '#/components/schemas/AdditionalDataRisk'
|
|
- $ref: '#/components/schemas/AdditionalDataRiskStandalone'
|
|
- $ref: '#/components/schemas/AdditionalDataSubMerchant'
|
|
- $ref: '#/components/schemas/AdditionalDataTemporaryServices'
|
|
- $ref: '#/components/schemas/AdditionalDataWallets'
|
|
description: 'This field contains additional data, which may be required
|
|
for a particular payment request.
|
|
|
|
|
|
The `additionalData` object consists of entries, each of which includes
|
|
the key and value.'
|
|
type: object
|
|
allowedPaymentMethods:
|
|
description: 'List of payment methods to be presented to the shopper. To
|
|
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
|
|
|
|
|
|
Example: `"allowedPaymentMethods":["ideal","applepay"]`'
|
|
items:
|
|
type: string
|
|
type: array
|
|
amount:
|
|
description: The amount of the payment.
|
|
$ref: '#/components/schemas/Amount'
|
|
applicationInfo:
|
|
description: Information about your application. For more details, see [Building
|
|
Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
|
|
$ref: '#/components/schemas/ApplicationInfo'
|
|
authenticationData:
|
|
x-addedInVersion: '69'
|
|
description: Configuration data for 3DS payments.
|
|
$ref: '#/components/schemas/AuthenticationData'
|
|
billingAddress:
|
|
description: The address where to send the invoice.
|
|
$ref: '#/components/schemas/BillingAddress'
|
|
blockedPaymentMethods:
|
|
description: 'List of payment methods to be hidden from the shopper. To
|
|
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
|
|
|
|
|
|
Example: `"blockedPaymentMethods":["ideal","applepay"]`'
|
|
items:
|
|
type: string
|
|
type: array
|
|
captureDelayHours:
|
|
description: The delay between the authorisation and scheduled auto-capture,
|
|
specified in hours.
|
|
format: int32
|
|
type: integer
|
|
channel:
|
|
description: 'The platform where a payment transaction takes place. This
|
|
field is optional for filtering out payment methods that are only available
|
|
on specific platforms. If this value is not set, then we will try to infer
|
|
it from the `sdkVersion` or `token`.
|
|
|
|
|
|
Possible values:
|
|
|
|
* **iOS**
|
|
|
|
* **Android**
|
|
|
|
* **Web**'
|
|
enum:
|
|
- iOS
|
|
- Android
|
|
- Web
|
|
type: string
|
|
company:
|
|
description: Information regarding the company.
|
|
$ref: '#/components/schemas/Company'
|
|
countryCode:
|
|
description: The shopper's two-letter country code.
|
|
type: string
|
|
dateOfBirth:
|
|
description: 'The shopper''s date of birth.
|
|
|
|
|
|
Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
|
|
format: date
|
|
type: string
|
|
deliverAt:
|
|
description: 'The date and time when the purchased goods should be delivered.
|
|
|
|
|
|
[ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD,
|
|
for example, **2020-12-18T10:15:30+01:00**.'
|
|
format: date-time
|
|
type: string
|
|
deliveryAddress:
|
|
description: The address where the purchased goods should be delivered.
|
|
$ref: '#/components/schemas/DeliveryAddress'
|
|
enableOneClick:
|
|
description: When true and `shopperReference` is provided, the shopper will
|
|
be asked if the payment details should be stored for future [one-click
|
|
payments](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
|
|
type: boolean
|
|
enablePayOut:
|
|
description: When true and `shopperReference` is provided, the payment details
|
|
will be tokenized for payouts.
|
|
type: boolean
|
|
enableRecurring:
|
|
description: When true and `shopperReference` is provided, the payment details
|
|
will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types)
|
|
where the shopper is not present, such as subscription or automatic top-up
|
|
payments.
|
|
type: boolean
|
|
expiresAt:
|
|
description: The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html)
|
|
format. When not specified, the expiry date is set to 1 hour after session
|
|
creation. You cannot set the session expiry to more than 24 hours after
|
|
session creation.
|
|
format: date-time
|
|
type: string
|
|
fundOrigin:
|
|
description: The person or entity funding the money.
|
|
$ref: '#/components/schemas/FundOrigin'
|
|
fundRecipient:
|
|
description: the person or entity receiving the money
|
|
$ref: '#/components/schemas/FundRecipient'
|
|
installmentOptions:
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/CheckoutSessionInstallmentOption'
|
|
description: A set of key-value pairs that specifies the installment options
|
|
available per payment method. The key must be a payment method name in
|
|
lowercase. For example, **card** to specify installment options for all
|
|
cards, or **visa** or **mc**. The value must be an object containing the
|
|
installment options.
|
|
type: object
|
|
lineItems:
|
|
description: 'Price and product information about the purchased items, to
|
|
be included on the invoice sent to the shopper.
|
|
|
|
> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna,
|
|
Ratepay, Riverty, and Zip.'
|
|
items:
|
|
$ref: '#/components/schemas/LineItem'
|
|
type: array
|
|
mandate:
|
|
description: The mandate details to initiate recurring transaction.
|
|
$ref: '#/components/schemas/Mandate'
|
|
mcc:
|
|
description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code)
|
|
(MCC) is a four-digit number, which relates to a particular market segment.
|
|
This code reflects the predominant activity that is conducted by the merchant.
|
|
type: string
|
|
merchantAccount:
|
|
description: The merchant account identifier, with which you want to process
|
|
the transaction.
|
|
type: string
|
|
merchantOrderReference:
|
|
description: 'This reference allows linking multiple transactions to each
|
|
other for reporting purposes (i.e. order auth-rate). The reference should
|
|
be unique per billing cycle.
|
|
|
|
The same merchant order reference should never be reused after the first
|
|
authorised attempt. If used, this field should be supplied for all incoming
|
|
authorisations.
|
|
|
|
> We strongly recommend you send the `merchantOrderReference` value to
|
|
benefit from linking payment requests when authorisation retries take
|
|
place. In addition, we recommend you provide `retry.orderAttemptNumber`,
|
|
`retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
|
|
type: string
|
|
metadata:
|
|
additionalProperties:
|
|
type: string
|
|
description: 'Metadata consists of entries, each of which includes a key
|
|
and a value.
|
|
|
|
Limits:
|
|
|
|
* Maximum 20 key-value pairs per request.
|
|
|
|
* Maximum 20 characters per key.
|
|
|
|
* Maximum 80 characters per value. '
|
|
type: object
|
|
mode:
|
|
x-addedInVersion: '69'
|
|
default: embedded
|
|
description: 'Indicates the type of front end integration. Possible values:
|
|
|
|
* **embedded** (default): Drop-in or Components integration
|
|
|
|
* **hosted**: Hosted Checkout integration'
|
|
enum:
|
|
- embedded
|
|
- hosted
|
|
type: string
|
|
mpiData:
|
|
description: Authentication data produced by an MPI (Mastercard SecureCode,
|
|
Visa Secure, or Cartes Bancaires).
|
|
$ref: '#/components/schemas/ThreeDSecureData'
|
|
platformChargebackLogic:
|
|
x-addedInVersion: '70'
|
|
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).
|
|
$ref: '#/components/schemas/PlatformChargebackLogic'
|
|
recurringExpiry:
|
|
description: Date after which no further authorisations shall be performed.
|
|
Only for 3D Secure 2.
|
|
type: string
|
|
recurringFrequency:
|
|
description: Minimum number of days between authorisations. Only for 3D
|
|
Secure 2.
|
|
type: string
|
|
recurringProcessingModel:
|
|
description: "Defines a recurring payment type. Required when creating a\
|
|
\ token to store payment details.\nAllowed values:\n* `Subscription` \u2013\
|
|
\ A transaction for a fixed or variable amount, which follows a fixed\
|
|
\ schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\
|
|
\ card details are stored to enable one-click or omnichannel journeys,\
|
|
\ or simply to streamline the checkout process. Any subscription not following\
|
|
\ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\
|
|
\ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\
|
|
\ that occurs on a non-fixed schedule and/or have variable amounts. For\
|
|
\ example, automatic top-ups when a cardholder's balance drops below a\
|
|
\ certain amount.\n"
|
|
enum:
|
|
- CardOnFile
|
|
- Subscription
|
|
- UnscheduledCardOnFile
|
|
type: string
|
|
redirectFromIssuerMethod:
|
|
description: Specifies the redirect method (GET or POST) when redirecting
|
|
back from the issuer.
|
|
type: string
|
|
redirectToIssuerMethod:
|
|
description: Specifies the redirect method (GET or POST) when redirecting
|
|
to the issuer.
|
|
type: string
|
|
reference:
|
|
description: The reference to uniquely identify a payment.
|
|
type: string
|
|
returnUrl:
|
|
description: "The URL to return to in case of a redirection.\nThe format\
|
|
\ depends on the channel. \n* For web, include the protocol `http://`\
|
|
\ or `https://`. You can also include your own additional query parameters,\
|
|
\ for example, shopper ID or order reference number.\nExample: `https://your-company.com/checkout?shopperOrder=12xy`\n\
|
|
* For iOS, use the custom URL for your app. To know more about setting\
|
|
\ custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).\n\
|
|
Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\
|
|
\ on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).\n\
|
|
Example: `my-app://your.package.name`\n\nIf the URL to return to includes\
|
|
\ non-ASCII characters, like spaces or special letters, URL encode the\
|
|
\ value.\n> The URL must not include personally identifiable information\
|
|
\ (PII), for example name or email address."
|
|
maxLength: 8000
|
|
type: string
|
|
riskData:
|
|
description: Any risk-related settings to apply to the payment.
|
|
$ref: '#/components/schemas/RiskData'
|
|
shopperEmail:
|
|
description: The shopper's email address.
|
|
type: string
|
|
shopperIP:
|
|
description: 'The shopper''s IP address. In general, we recommend that you
|
|
provide this data, as it is used in a number of risk checks (for instance,
|
|
number of payment attempts or location-based checks).
|
|
|
|
> For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based
|
|
implementations.
|
|
|
|
This field is also mandatory for some merchants depending on your business
|
|
model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
|
|
type: string
|
|
shopperInteraction:
|
|
description: 'Specifies the sales channel, through which the shopper gives
|
|
their card details, and whether the shopper is a returning customer.
|
|
|
|
For the web service API, Adyen assumes Ecommerce shopper interaction by
|
|
default.
|
|
|
|
|
|
This field has the following possible values:
|
|
|
|
* `Ecommerce` - Online transactions where the cardholder is present (online).
|
|
For better authorisation rates, we recommend sending the card security
|
|
code (CSC) along with the request.
|
|
|
|
* `ContAuth` - Card on file and/or subscription transactions, where the
|
|
cardholder is known to the merchant (returning customer). If the shopper
|
|
is present (online), you can supply also the CSC to improve authorisation
|
|
(one-click payment).
|
|
|
|
* `Moto` - Mail-order and telephone-order transactions where the shopper
|
|
is in contact with the merchant via email or telephone.
|
|
|
|
* `POS` - Point-of-sale transactions where the shopper is physically present
|
|
to make a payment using a secure payment terminal.'
|
|
enum:
|
|
- Ecommerce
|
|
- ContAuth
|
|
- Moto
|
|
- POS
|
|
type: string
|
|
shopperLocale:
|
|
description: The combination of a language code and a country code to specify
|
|
the language to be used in the payment.
|
|
type: string
|
|
shopperName:
|
|
description: The shopper's full name. This object is required for some payment
|
|
methods such as AfterPay, Klarna, or if you're enrolled in the PayPal
|
|
Seller Protection program.
|
|
$ref: '#/components/schemas/Name'
|
|
shopperReference:
|
|
description: 'Your reference to uniquely identify this shopper, for example
|
|
user ID or account ID. The value is case-sensitive and must be at least
|
|
three characters.
|
|
|
|
> Your reference must not include personally identifiable information
|
|
(PII) such as name or email address.'
|
|
maxLength: 256
|
|
minLength: 3
|
|
type: string
|
|
shopperStatement:
|
|
description: "The text to be shown on the shopper's bank statement.\n We\
|
|
\ recommend sending a maximum of 22 characters, otherwise banks might\
|
|
\ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
|
|
\ spaces, and special characters **. , ' _ - ? + * /**."
|
|
type: string
|
|
showInstallmentAmount:
|
|
description: Set to true to show the payment amount per installment.
|
|
type: boolean
|
|
showRemovePaymentMethodButton:
|
|
description: Set to **true** to show a button that lets the shopper remove
|
|
a stored payment method.
|
|
type: boolean
|
|
socialSecurityNumber:
|
|
description: The shopper's social security number.
|
|
type: string
|
|
splitCardFundingSources:
|
|
default: false
|
|
description: Boolean value indicating whether the card payment method should
|
|
be split into separate debit and credit options.
|
|
type: boolean
|
|
splits:
|
|
description: An array of objects specifying how to split a payment when
|
|
using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information),
|
|
[Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information),
|
|
or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
|
|
items:
|
|
$ref: '#/components/schemas/Split'
|
|
type: array
|
|
store:
|
|
description: Required for Adyen for Platforms integrations if you are a
|
|
platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference)
|
|
(on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference)
|
|
(in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store))
|
|
for the ecommerce or point-of-sale store that is processing the payment.
|
|
type: string
|
|
storeFiltrationMode:
|
|
description: "Specifies how payment methods should be filtered based on\
|
|
\ the 'store' parameter:\n - 'exclusive': Only payment methods belonging\
|
|
\ to the specified 'store' are returned.\n - 'inclusive': Payment methods\
|
|
\ from the 'store' and those not associated with any other store are returned."
|
|
enum:
|
|
- exclusive
|
|
- inclusive
|
|
- skipFilter
|
|
type: string
|
|
storePaymentMethod:
|
|
description: When true and `shopperReference` is provided, the payment details
|
|
will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
|
|
type: boolean
|
|
storePaymentMethodMode:
|
|
x-addedInVersion: '70'
|
|
description: "Indicates if the details of the payment method will be stored\
|
|
\ for the shopper. Possible values:\n* **disabled** \u2013 No details\
|
|
\ will be stored (default).\n* **askForConsent** \u2013 If the `shopperReference`\
|
|
\ is provided, the UI lets the shopper choose if they want their payment\
|
|
\ details to be stored.\n* **enabled** \u2013 If the `shopperReference`\
|
|
\ is provided, the details will be stored without asking the shopper for\
|
|
\ consent."
|
|
enum:
|
|
- askForConsent
|
|
- disabled
|
|
- enabled
|
|
type: string
|
|
telephoneNumber:
|
|
description: The shopper's telephone number.
|
|
type: string
|
|
themeId:
|
|
x-addedInVersion: '69'
|
|
description: Sets a custom theme for [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/?platform=Web&integration=Hosted+Checkout).
|
|
The value can be any of the **Theme ID** values from your Customer Area.
|
|
type: string
|
|
threeDS2RequestData:
|
|
description: Request fields for 3D Secure 2. To check if any of the following
|
|
fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments).
|
|
$ref: '#/components/schemas/CheckoutSessionThreeDS2RequestData'
|
|
threeDSAuthenticationOnly:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '69'
|
|
x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
|
|
default: false
|
|
description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
|
|
and not the payment authorisation.
|
|
type: boolean
|
|
trustedShopper:
|
|
description: Set to true if the payment should be routed to a trusted MID.
|
|
type: boolean
|
|
required:
|
|
- amount
|
|
- reference
|
|
- returnUrl
|
|
- merchantAccount
|
|
type: object
|
|
CreateCheckoutSessionResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
accountInfo:
|
|
description: 'Shopper account information for 3D Secure 2.
|
|
|
|
> For 3D Secure 2 transactions, we recommend that you include this object
|
|
to increase the chances of achieving a frictionless flow.'
|
|
$ref: '#/components/schemas/AccountInfo'
|
|
additionalAmount:
|
|
description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
|
|
request to use a non-zero value, assign this value to `additionalAmount`
|
|
(while the amount must be still set to 0 to trigger BIN or card verification).
|
|
|
|
Required to be in the same currency as the `amount`. '
|
|
$ref: '#/components/schemas/Amount'
|
|
additionalData:
|
|
additionalProperties:
|
|
type: string
|
|
x-anyOf:
|
|
- $ref: '#/components/schemas/AdditionalData3DSecure'
|
|
- $ref: '#/components/schemas/AdditionalDataAirline'
|
|
- $ref: '#/components/schemas/AdditionalDataCarRental'
|
|
- $ref: '#/components/schemas/AdditionalDataCommon'
|
|
- $ref: '#/components/schemas/AdditionalDataLevel23'
|
|
- $ref: '#/components/schemas/AdditionalDataLodging'
|
|
- $ref: '#/components/schemas/AdditionalDataOpenInvoice'
|
|
- $ref: '#/components/schemas/AdditionalDataOpi'
|
|
- $ref: '#/components/schemas/AdditionalDataRatepay'
|
|
- $ref: '#/components/schemas/AdditionalDataRetry'
|
|
- $ref: '#/components/schemas/AdditionalDataRisk'
|
|
- $ref: '#/components/schemas/AdditionalDataRiskStandalone'
|
|
- $ref: '#/components/schemas/AdditionalDataSubMerchant'
|
|
- $ref: '#/components/schemas/AdditionalDataTemporaryServices'
|
|
- $ref: '#/components/schemas/AdditionalDataWallets'
|
|
description: 'This field contains additional data, which may be required
|
|
for a particular payment request.
|
|
|
|
|
|
The `additionalData` object consists of entries, each of which includes
|
|
the key and value.'
|
|
type: object
|
|
allowedPaymentMethods:
|
|
description: 'List of payment methods to be presented to the shopper. To
|
|
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
|
|
|
|
|
|
Example: `"allowedPaymentMethods":["ideal","applepay"]`'
|
|
items:
|
|
type: string
|
|
type: array
|
|
amount:
|
|
description: The amount of the payment.
|
|
$ref: '#/components/schemas/Amount'
|
|
applicationInfo:
|
|
description: Information about your application. For more details, see [Building
|
|
Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
|
|
$ref: '#/components/schemas/ApplicationInfo'
|
|
authenticationData:
|
|
x-addedInVersion: '69'
|
|
description: Configuration data for 3DS payments.
|
|
$ref: '#/components/schemas/AuthenticationData'
|
|
billingAddress:
|
|
description: The address where to send the invoice.
|
|
$ref: '#/components/schemas/BillingAddress'
|
|
blockedPaymentMethods:
|
|
description: 'List of payment methods to be hidden from the shopper. To
|
|
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
|
|
|
|
|
|
Example: `"blockedPaymentMethods":["ideal","applepay"]`'
|
|
items:
|
|
type: string
|
|
type: array
|
|
captureDelayHours:
|
|
description: The delay between the authorisation and scheduled auto-capture,
|
|
specified in hours.
|
|
format: int32
|
|
type: integer
|
|
channel:
|
|
description: 'The platform where a payment transaction takes place. This
|
|
field is optional for filtering out payment methods that are only available
|
|
on specific platforms. If this value is not set, then we will try to infer
|
|
it from the `sdkVersion` or `token`.
|
|
|
|
|
|
Possible values:
|
|
|
|
* **iOS**
|
|
|
|
* **Android**
|
|
|
|
* **Web**'
|
|
enum:
|
|
- iOS
|
|
- Android
|
|
- Web
|
|
type: string
|
|
company:
|
|
description: Information regarding the company.
|
|
$ref: '#/components/schemas/Company'
|
|
countryCode:
|
|
description: The shopper's two-letter country code.
|
|
type: string
|
|
dateOfBirth:
|
|
description: The shopper's date of birth in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html)
|
|
format.
|
|
format: date-time
|
|
type: string
|
|
deliverAt:
|
|
description: 'The date and time when the purchased goods should be delivered.
|
|
|
|
|
|
[ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD,
|
|
for example, **2020-12-18T10:15:30+01:00**.'
|
|
format: date-time
|
|
type: string
|
|
deliveryAddress:
|
|
description: The address where the purchased goods should be delivered.
|
|
$ref: '#/components/schemas/DeliveryAddress'
|
|
enableOneClick:
|
|
description: When true and `shopperReference` is provided, the shopper will
|
|
be asked if the payment details should be stored for future [one-click
|
|
payments](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
|
|
type: boolean
|
|
enablePayOut:
|
|
description: When true and `shopperReference` is provided, the payment details
|
|
will be tokenized for payouts.
|
|
type: boolean
|
|
enableRecurring:
|
|
description: When true and `shopperReference` is provided, the payment details
|
|
will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types)
|
|
where the shopper is not present, such as subscription or automatic top-up
|
|
payments.
|
|
type: boolean
|
|
expiresAt:
|
|
description: The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html)
|
|
format. When not specified, the expiry date is set to 1 hour after session
|
|
creation. You cannot set the session expiry to more than 24 hours after
|
|
session creation.
|
|
format: date-time
|
|
type: string
|
|
fundOrigin:
|
|
description: The person or entity funding the money.
|
|
$ref: '#/components/schemas/FundOrigin'
|
|
fundRecipient:
|
|
description: the person or entity receiving the money
|
|
$ref: '#/components/schemas/FundRecipient'
|
|
id:
|
|
description: A unique identifier of the session.
|
|
readOnly: true
|
|
type: string
|
|
installmentOptions:
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/CheckoutSessionInstallmentOption'
|
|
description: A set of key-value pairs that specifies the installment options
|
|
available per payment method. The key must be a payment method name in
|
|
lowercase. For example, **card** to specify installment options for all
|
|
cards, or **visa** or **mc**. The value must be an object containing the
|
|
installment options.
|
|
type: object
|
|
lineItems:
|
|
description: 'Price and product information about the purchased items, to
|
|
be included on the invoice sent to the shopper.
|
|
|
|
> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna,
|
|
Ratepay, Riverty, and Zip.'
|
|
items:
|
|
$ref: '#/components/schemas/LineItem'
|
|
type: array
|
|
mandate:
|
|
description: The mandate details to initiate recurring transaction.
|
|
$ref: '#/components/schemas/Mandate'
|
|
mcc:
|
|
description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code)
|
|
(MCC) is a four-digit number, which relates to a particular market segment.
|
|
This code reflects the predominant activity that is conducted by the merchant.
|
|
type: string
|
|
merchantAccount:
|
|
description: The merchant account identifier, with which you want to process
|
|
the transaction.
|
|
type: string
|
|
merchantOrderReference:
|
|
description: 'This reference allows linking multiple transactions to each
|
|
other for reporting purposes (i.e. order auth-rate). The reference should
|
|
be unique per billing cycle.
|
|
|
|
The same merchant order reference should never be reused after the first
|
|
authorised attempt. If used, this field should be supplied for all incoming
|
|
authorisations.
|
|
|
|
> We strongly recommend you send the `merchantOrderReference` value to
|
|
benefit from linking payment requests when authorisation retries take
|
|
place. In addition, we recommend you provide `retry.orderAttemptNumber`,
|
|
`retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
|
|
type: string
|
|
metadata:
|
|
additionalProperties:
|
|
type: string
|
|
description: 'Metadata consists of entries, each of which includes a key
|
|
and a value.
|
|
|
|
Limits:
|
|
|
|
* Maximum 20 key-value pairs per request.
|
|
|
|
* Maximum 20 characters per key.
|
|
|
|
* Maximum 80 characters per value. '
|
|
type: object
|
|
mode:
|
|
x-addedInVersion: '70'
|
|
default: embedded
|
|
description: 'Indicates the type of front end integration. Possible values:
|
|
|
|
* **embedded** (default): Drop-in or Components integration
|
|
|
|
* **hosted**: Hosted Checkout integration'
|
|
enum:
|
|
- embedded
|
|
- hosted
|
|
type: string
|
|
mpiData:
|
|
description: Authentication data produced by an MPI (Mastercard SecureCode,
|
|
Visa Secure, or Cartes Bancaires).
|
|
$ref: '#/components/schemas/ThreeDSecureData'
|
|
platformChargebackLogic:
|
|
x-addedInVersion: '70'
|
|
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).
|
|
$ref: '#/components/schemas/PlatformChargebackLogic'
|
|
recurringExpiry:
|
|
description: Date after which no further authorisations shall be performed.
|
|
Only for 3D Secure 2.
|
|
type: string
|
|
recurringFrequency:
|
|
description: Minimum number of days between authorisations. Only for 3D
|
|
Secure 2.
|
|
type: string
|
|
recurringProcessingModel:
|
|
description: "Defines a recurring payment type. Required when creating a\
|
|
\ token to store payment details.\nAllowed values:\n* `Subscription` \u2013\
|
|
\ A transaction for a fixed or variable amount, which follows a fixed\
|
|
\ schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\
|
|
\ card details are stored to enable one-click or omnichannel journeys,\
|
|
\ or simply to streamline the checkout process. Any subscription not following\
|
|
\ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\
|
|
\ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\
|
|
\ that occurs on a non-fixed schedule and/or have variable amounts. For\
|
|
\ example, automatic top-ups when a cardholder's balance drops below a\
|
|
\ certain amount.\n"
|
|
enum:
|
|
- CardOnFile
|
|
- Subscription
|
|
- UnscheduledCardOnFile
|
|
type: string
|
|
redirectFromIssuerMethod:
|
|
description: Specifies the redirect method (GET or POST) when redirecting
|
|
back from the issuer.
|
|
type: string
|
|
redirectToIssuerMethod:
|
|
description: Specifies the redirect method (GET or POST) when redirecting
|
|
to the issuer.
|
|
type: string
|
|
reference:
|
|
description: The reference to uniquely identify a payment.
|
|
type: string
|
|
returnUrl:
|
|
description: "The URL to return to in case of a redirection.\nThe format\
|
|
\ depends on the channel. \n* For web, include the protocol `http://`\
|
|
\ or `https://`. You can also include your own additional query parameters,\
|
|
\ for example, shopper ID or order reference number.\nExample: `https://your-company.com/checkout?shopperOrder=12xy`\n\
|
|
* For iOS, use the custom URL for your app. To know more about setting\
|
|
\ custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).\n\
|
|
Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\
|
|
\ on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).\n\
|
|
Example: `my-app://your.package.name`\n\nIf the URL to return to includes\
|
|
\ non-ASCII characters, like spaces or special letters, URL encode the\
|
|
\ value.\n> The URL must not include personally identifiable information\
|
|
\ (PII), for example name or email address."
|
|
maxLength: 8000
|
|
type: string
|
|
riskData:
|
|
description: Any risk-related settings to apply to the payment.
|
|
$ref: '#/components/schemas/RiskData'
|
|
sessionData:
|
|
description: The payment session data you need to pass to your front end.
|
|
type: string
|
|
shopperEmail:
|
|
description: The shopper's email address.
|
|
type: string
|
|
shopperIP:
|
|
description: 'The shopper''s IP address. In general, we recommend that you
|
|
provide this data, as it is used in a number of risk checks (for instance,
|
|
number of payment attempts or location-based checks).
|
|
|
|
> For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based
|
|
implementations.
|
|
|
|
This field is also mandatory for some merchants depending on your business
|
|
model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
|
|
type: string
|
|
shopperInteraction:
|
|
description: 'Specifies the sales channel, through which the shopper gives
|
|
their card details, and whether the shopper is a returning customer.
|
|
|
|
For the web service API, Adyen assumes Ecommerce shopper interaction by
|
|
default.
|
|
|
|
|
|
This field has the following possible values:
|
|
|
|
* `Ecommerce` - Online transactions where the cardholder is present (online).
|
|
For better authorisation rates, we recommend sending the card security
|
|
code (CSC) along with the request.
|
|
|
|
* `ContAuth` - Card on file and/or subscription transactions, where the
|
|
cardholder is known to the merchant (returning customer). If the shopper
|
|
is present (online), you can supply also the CSC to improve authorisation
|
|
(one-click payment).
|
|
|
|
* `Moto` - Mail-order and telephone-order transactions where the shopper
|
|
is in contact with the merchant via email or telephone.
|
|
|
|
* `POS` - Point-of-sale transactions where the shopper is physically present
|
|
to make a payment using a secure payment terminal.'
|
|
enum:
|
|
- Ecommerce
|
|
- ContAuth
|
|
- Moto
|
|
- POS
|
|
type: string
|
|
shopperLocale:
|
|
description: The combination of a language code and a country code to specify
|
|
the language to be used in the payment.
|
|
type: string
|
|
shopperName:
|
|
description: The shopper's full name. This object is required for some payment
|
|
methods such as AfterPay, Klarna, or if you're enrolled in the PayPal
|
|
Seller Protection program.
|
|
$ref: '#/components/schemas/Name'
|
|
shopperReference:
|
|
description: 'Your reference to uniquely identify this shopper, for example
|
|
user ID or account ID. The value is case-sensitive and must be at least
|
|
three characters.
|
|
|
|
> Your reference must not include personally identifiable information
|
|
(PII) such as name or email address.'
|
|
maxLength: 256
|
|
minLength: 3
|
|
type: string
|
|
shopperStatement:
|
|
description: "The text to be shown on the shopper's bank statement.\n We\
|
|
\ recommend sending a maximum of 22 characters, otherwise banks might\
|
|
\ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
|
|
\ spaces, and special characters **. , ' _ - ? + * /**."
|
|
type: string
|
|
showInstallmentAmount:
|
|
description: Set to true to show the payment amount per installment.
|
|
type: boolean
|
|
showRemovePaymentMethodButton:
|
|
description: Set to **true** to show a button that lets the shopper remove
|
|
a stored payment method.
|
|
type: boolean
|
|
socialSecurityNumber:
|
|
description: The shopper's social security number.
|
|
type: string
|
|
splitCardFundingSources:
|
|
default: false
|
|
description: Boolean value indicating whether the card payment method should
|
|
be split into separate debit and credit options.
|
|
type: boolean
|
|
splits:
|
|
description: An array of objects specifying how to split a payment when
|
|
using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information),
|
|
[Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information),
|
|
or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
|
|
items:
|
|
$ref: '#/components/schemas/Split'
|
|
type: array
|
|
store:
|
|
description: Required for Adyen for Platforms integrations if you are a
|
|
platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference)
|
|
(on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference)
|
|
(in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store))
|
|
for the ecommerce or point-of-sale store that is processing the payment.
|
|
type: string
|
|
storeFiltrationMode:
|
|
description: "Specifies how payment methods should be filtered based on\
|
|
\ the 'store' parameter:\n - 'exclusive': Only payment methods belonging\
|
|
\ to the specified 'store' are returned.\n - 'inclusive': Payment methods\
|
|
\ from the 'store' and those not associated with any other store are returned."
|
|
enum:
|
|
- exclusive
|
|
- inclusive
|
|
- skipFilter
|
|
type: string
|
|
storePaymentMethod:
|
|
description: When true and `shopperReference` is provided, the payment details
|
|
will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
|
|
type: boolean
|
|
storePaymentMethodMode:
|
|
x-addedInVersion: '70'
|
|
description: "Indicates if the details of the payment method will be stored\
|
|
\ for the shopper. Possible values:\n* **disabled** \u2013 No details\
|
|
\ will be stored (default).\n* **askForConsent** \u2013 If the `shopperReference`\
|
|
\ is provided, the UI lets the shopper choose if they want their payment\
|
|
\ details to be stored.\n* **enabled** \u2013 If the `shopperReference`\
|
|
\ is provided, the details will be stored without asking the shopper for\
|
|
\ consent."
|
|
enum:
|
|
- askForConsent
|
|
- disabled
|
|
- enabled
|
|
type: string
|
|
telephoneNumber:
|
|
description: The shopper's telephone number.
|
|
type: string
|
|
themeId:
|
|
x-addedInVersion: '69'
|
|
description: Sets a custom theme for [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/?platform=Web&integration=Hosted+Checkout).
|
|
The value can be any of the **Theme ID** values from your Customer Area.
|
|
type: string
|
|
threeDS2RequestData:
|
|
description: Request fields for 3D Secure 2. To check if any of the following
|
|
fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments).
|
|
$ref: '#/components/schemas/CheckoutSessionThreeDS2RequestData'
|
|
threeDSAuthenticationOnly:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '69'
|
|
x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
|
|
default: false
|
|
description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
|
|
and not the payment authorisation.
|
|
type: boolean
|
|
trustedShopper:
|
|
description: Set to true if the payment should be routed to a trusted MID.
|
|
type: boolean
|
|
url:
|
|
x-addedInVersion: '69'
|
|
description: The URL for the Hosted Checkout page. Redirect the shopper
|
|
to this URL so they can make the payment.
|
|
type: string
|
|
required:
|
|
- id
|
|
- amount
|
|
- reference
|
|
- returnUrl
|
|
- expiresAt
|
|
- merchantAccount
|
|
type: object
|
|
CreateOrderRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
amount:
|
|
description: The total amount of the order.
|
|
$ref: '#/components/schemas/Amount'
|
|
expiresAt:
|
|
description: 'The date when the order should expire. If not provided, the
|
|
default expiry duration is 1 day.
|
|
|
|
|
|
[ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD,
|
|
for example, **2020-12-18T10:15:30+01:00**.'
|
|
type: string
|
|
merchantAccount:
|
|
description: The merchant account identifier, with which you want to process
|
|
the order.
|
|
type: string
|
|
reference:
|
|
description: A custom reference identifying the order.
|
|
type: string
|
|
required:
|
|
- merchantAccount
|
|
- reference
|
|
- amount
|
|
type: object
|
|
CreateOrderResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
additionalData:
|
|
additionalProperties:
|
|
type: string
|
|
x-anyOf:
|
|
- $ref: '#/components/schemas/ResponseAdditionalData3DSecure'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataCard'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataCommon'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataDomesticError'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataOpi'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataSepa'
|
|
description: 'Contains additional information about the payment. Some data
|
|
fields are included only if you select them first: Go to **Customer Area**
|
|
> **Developers** > **Additional data**.'
|
|
type: object
|
|
amount:
|
|
x-addedInVersion: '68'
|
|
description: The initial amount of the order.
|
|
$ref: '#/components/schemas/Amount'
|
|
expiresAt:
|
|
description: The date that the order will expire.
|
|
type: string
|
|
fraudResult:
|
|
description: The fraud result properties of the payment.
|
|
$ref: '#/components/schemas/FraudResult'
|
|
orderData:
|
|
description: The encrypted data that will be used by merchant for adding
|
|
payments to the order.
|
|
type: string
|
|
pspReference:
|
|
description: Adyen's 16-character reference associated with the transaction/request.
|
|
This value is globally unique; quote it when communicating with us about
|
|
this request.
|
|
type: string
|
|
reference:
|
|
description: The reference provided by merchant for creating the order.
|
|
type: string
|
|
refusalReason:
|
|
description: 'If the payment''s authorisation is refused or an error occurs
|
|
during authorisation, this field holds Adyen''s mapped reason for the
|
|
refusal or a description of the error. When a transaction fails, the authorisation
|
|
response includes `resultCode` and `refusalReason` values.
|
|
|
|
|
|
For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).'
|
|
type: string
|
|
remainingAmount:
|
|
description: The remaining amount in the order.
|
|
$ref: '#/components/schemas/Amount'
|
|
resultCode:
|
|
description: "The result of the order creation request.\n The value is always\
|
|
\ **Success**."
|
|
enum:
|
|
- Success
|
|
type: string
|
|
required:
|
|
- amount
|
|
- remainingAmount
|
|
- expiresAt
|
|
- orderData
|
|
- resultCode
|
|
type: object
|
|
DeliveryAddress:
|
|
additionalProperties: false
|
|
properties:
|
|
city:
|
|
description: 'The name of the city. Maximum length: 3000 characters.'
|
|
maxLength: 3000
|
|
type: string
|
|
country:
|
|
description: 'The two-character ISO-3166-1 alpha-2 country code. For example,
|
|
**US**.
|
|
|
|
> If you don''t know the country or are not collecting the country from
|
|
the shopper, provide `country` as `ZZ`.'
|
|
type: string
|
|
firstName:
|
|
type: string
|
|
houseNumberOrName:
|
|
description: 'The number or name of the house. Maximum length: 3000 characters.'
|
|
maxLength: 3000
|
|
type: string
|
|
lastName:
|
|
type: string
|
|
postalCode:
|
|
description: A maximum of five digits for an address in the US, or a maximum
|
|
of ten characters for an address in all other countries.
|
|
type: string
|
|
stateOrProvince:
|
|
description: 'The two-character ISO 3166-2 state or province code. For example,
|
|
**CA** in the US or **ON** in Canada.
|
|
|
|
> Required for the US and Canada.'
|
|
maxLength: 1000
|
|
type: string
|
|
street:
|
|
description: 'The name of the street. Maximum length: 3000 characters.
|
|
|
|
> The house number should not be included in this field; it should be
|
|
separately provided via `houseNumberOrName`.'
|
|
maxLength: 3000
|
|
type: string
|
|
required:
|
|
- street
|
|
- houseNumberOrName
|
|
- city
|
|
- postalCode
|
|
- country
|
|
type: object
|
|
DeliveryMethod:
|
|
additionalProperties: false
|
|
properties:
|
|
amount:
|
|
description: The cost of this delivery method.
|
|
$ref: '#/components/schemas/Amount'
|
|
description:
|
|
description: The name of the delivery method as shown to the shopper.
|
|
type: string
|
|
reference:
|
|
description: The reference of the delivery method.
|
|
type: string
|
|
selected:
|
|
description: If you display the PayPal lightbox with delivery methods, set
|
|
to **true** for the delivery method that is selected. Only one delivery
|
|
method can be selected at a time.
|
|
type: boolean
|
|
type:
|
|
description: The type of the delivery method.
|
|
enum:
|
|
- Shipping
|
|
type: string
|
|
type: object
|
|
DetailsRequestAuthenticationData:
|
|
additionalProperties: false
|
|
properties:
|
|
authenticationOnly:
|
|
x-addedInVersion: '69'
|
|
default: false
|
|
description: 'If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
|
|
and not the payment authorisation.
|
|
|
|
Default: *false**.'
|
|
type: boolean
|
|
type: object
|
|
DeviceRenderOptions:
|
|
additionalProperties: false
|
|
properties:
|
|
sdkInterface:
|
|
default: both
|
|
description: 'Supported SDK interface types.
|
|
|
|
Allowed values:
|
|
|
|
* native
|
|
|
|
* html
|
|
|
|
* both'
|
|
enum:
|
|
- native
|
|
- html
|
|
- both
|
|
type: string
|
|
sdkUiType:
|
|
description: 'UI types supported for displaying specific challenges.
|
|
|
|
Allowed values:
|
|
|
|
* text
|
|
|
|
* singleSelect
|
|
|
|
* outOfBand
|
|
|
|
* otherHtml
|
|
|
|
* multiSelect'
|
|
items:
|
|
enum:
|
|
- multiSelect
|
|
- otherHtml
|
|
- outOfBand
|
|
- singleSelect
|
|
- text
|
|
type: string
|
|
type: array
|
|
type: object
|
|
DokuDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
firstName:
|
|
description: The shopper's first name.
|
|
type: string
|
|
lastName:
|
|
description: The shopper's last name.
|
|
type: string
|
|
shopperEmail:
|
|
description: The shopper's email.
|
|
type: string
|
|
type:
|
|
description: '**doku**'
|
|
enum:
|
|
- doku_mandiri_va
|
|
- doku_cimb_va
|
|
- doku_danamon_va
|
|
- doku_bni_va
|
|
- doku_permata_lite_atm
|
|
- doku_bri_va
|
|
- doku_bca_va
|
|
- doku_alfamart
|
|
- doku_indomaret
|
|
- doku_wallet
|
|
- doku_ovo
|
|
type: string
|
|
required:
|
|
- type
|
|
- firstName
|
|
- lastName
|
|
- shopperEmail
|
|
title: Doku
|
|
type: object
|
|
Donation:
|
|
additionalProperties: false
|
|
properties:
|
|
currency:
|
|
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes/).
|
|
type: string
|
|
donationType:
|
|
description: 'The [type of donation](https://docs.adyen.com/online-payments/donations/#donation-types).
|
|
|
|
|
|
Possible values:
|
|
|
|
* **roundup**: a donation where the original transaction amount is rounded
|
|
up as a donation.
|
|
|
|
* **fixedAmounts**: a donation where you show fixed donations amounts
|
|
that the shopper can select from.'
|
|
type: string
|
|
maxRoundupAmount:
|
|
description: The maximum amount a transaction can be rounded up to make
|
|
a donation. This field is only present when `donationType` is **roundup**.
|
|
format: int64
|
|
type: integer
|
|
type:
|
|
description: 'The [type of donation](https://docs.adyen.com/online-payments/donations/#donation-types).
|
|
|
|
|
|
Possible values:
|
|
|
|
* **roundup**: a donation where the original transaction amount is rounded
|
|
up as a donation.
|
|
|
|
* **fixedAmounts**: a donation where you show fixed donation amounts that
|
|
the shopper can select from.'
|
|
type: string
|
|
values:
|
|
description: The fixed donation amounts in [minor units](https://docs.adyen.com/development-resources/currency-codes//#minor-units).
|
|
This field is only present when `donationType` is **fixedAmounts**.
|
|
items:
|
|
format: int64
|
|
type: integer
|
|
type: array
|
|
required:
|
|
- currency
|
|
- donationType
|
|
- type
|
|
type: object
|
|
DonationCampaign:
|
|
additionalProperties: false
|
|
properties:
|
|
amounts:
|
|
description: The object that contains the fixed donation amounts that the
|
|
shopper can select from.
|
|
$ref: '#/components/schemas/Amounts'
|
|
bannerUrl:
|
|
description: The URL for the banner of the nonprofit or campaign.
|
|
type: string
|
|
campaignName:
|
|
description: The name of the donation campaign..
|
|
type: string
|
|
causeName:
|
|
description: The cause of the nonprofit.
|
|
type: string
|
|
donation:
|
|
description: The object that contains the details of the donation.
|
|
$ref: '#/components/schemas/Donation'
|
|
id:
|
|
description: The unique campaign ID of the donation campaign.
|
|
type: string
|
|
logoUrl:
|
|
description: The URL for the logo of the nonprofit.
|
|
type: string
|
|
nonprofitDescription:
|
|
description: The description of the nonprofit.
|
|
type: string
|
|
nonprofitName:
|
|
description: The name of the nonprofit organization that receives the donation.
|
|
type: string
|
|
nonprofitUrl:
|
|
description: The website URL of the nonprofit.
|
|
type: string
|
|
termsAndConditionsUrl:
|
|
description: The URL of the terms and conditions page of the nonprofit and
|
|
the campaign.
|
|
type: string
|
|
type: object
|
|
DonationCampaignsRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
currency:
|
|
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes/).
|
|
type: string
|
|
locale:
|
|
description: Locale on the shopper interaction device.
|
|
type: string
|
|
merchantAccount:
|
|
description: Your merchant account identifier.
|
|
type: string
|
|
required:
|
|
- merchantAccount
|
|
- currency
|
|
type: object
|
|
DonationCampaignsResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
donationCampaigns:
|
|
description: List of active donation campaigns for your merchant account.
|
|
items:
|
|
$ref: '#/components/schemas/DonationCampaign'
|
|
type: array
|
|
type: object
|
|
DonationPaymentRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
accountInfo:
|
|
x-addedInVersion: '40'
|
|
description: 'Shopper account information for 3D Secure 2.
|
|
|
|
> For 3D Secure 2 transactions, we recommend that you include this object
|
|
to increase the chances of achieving a frictionless flow.'
|
|
$ref: '#/components/schemas/AccountInfo'
|
|
additionalAmount:
|
|
description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
|
|
request to use a non-zero value, assign this value to `additionalAmount`
|
|
(while the amount must be still set to 0 to trigger BIN or card verification).
|
|
|
|
Required to be in the same currency as the `amount`. '
|
|
$ref: '#/components/schemas/Amount'
|
|
additionalData:
|
|
additionalProperties:
|
|
type: string
|
|
x-anyOf:
|
|
- $ref: '#/components/schemas/AdditionalData3DSecure'
|
|
- $ref: '#/components/schemas/AdditionalDataAirline'
|
|
- $ref: '#/components/schemas/AdditionalDataCarRental'
|
|
- $ref: '#/components/schemas/AdditionalDataCommon'
|
|
- $ref: '#/components/schemas/AdditionalDataLevel23'
|
|
- $ref: '#/components/schemas/AdditionalDataLodging'
|
|
- $ref: '#/components/schemas/AdditionalDataOpenInvoice'
|
|
- $ref: '#/components/schemas/AdditionalDataOpi'
|
|
- $ref: '#/components/schemas/AdditionalDataRatepay'
|
|
- $ref: '#/components/schemas/AdditionalDataRetry'
|
|
- $ref: '#/components/schemas/AdditionalDataRisk'
|
|
- $ref: '#/components/schemas/AdditionalDataRiskStandalone'
|
|
- $ref: '#/components/schemas/AdditionalDataSubMerchant'
|
|
- $ref: '#/components/schemas/AdditionalDataTemporaryServices'
|
|
- $ref: '#/components/schemas/AdditionalDataWallets'
|
|
description: 'This field contains additional data, which may be required
|
|
for a particular payment request.
|
|
|
|
|
|
The `additionalData` object consists of entries, each of which includes
|
|
the key and value.'
|
|
type: object
|
|
allowedPaymentMethods:
|
|
x-addedInVersion: '37'
|
|
description: 'List of payment methods to be presented to the shopper. To
|
|
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
|
|
|
|
|
|
Example: `"allowedPaymentMethods":["ideal","applepay"]`'
|
|
items:
|
|
type: string
|
|
type: array
|
|
amount:
|
|
description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)).
|
|
For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
|
|
requests, set amount to 0 (zero).
|
|
$ref: '#/components/schemas/Amount'
|
|
applicationInfo:
|
|
x-addedInVersion: '40'
|
|
description: Information about your application. For more details, see [Building
|
|
Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
|
|
$ref: '#/components/schemas/ApplicationInfo'
|
|
authenticationData:
|
|
x-addedInVersion: '69'
|
|
description: Data for 3DS authentication.
|
|
$ref: '#/components/schemas/AuthenticationData'
|
|
billingAddress:
|
|
description: 'The address where to send the invoice.
|
|
|
|
> The `billingAddress` object is required in the following scenarios.
|
|
Include all of the fields within this object.
|
|
|
|
>* For 3D Secure 2 transactions in all browser-based and mobile implementations.
|
|
|
|
>* For cross-border payouts to and from Canada.'
|
|
$ref: '#/components/schemas/BillingAddress'
|
|
blockedPaymentMethods:
|
|
x-addedInVersion: '37'
|
|
description: 'List of payment methods to be hidden from the shopper. To
|
|
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
|
|
|
|
|
|
Example: `"blockedPaymentMethods":["ideal","applepay"]`'
|
|
items:
|
|
type: string
|
|
type: array
|
|
browserInfo:
|
|
description: 'The shopper''s browser information.
|
|
|
|
> For 3D Secure, the full object is required for web integrations. For
|
|
mobile app integrations, include the `userAgent` and `acceptHeader` fields
|
|
to indicate that your integration can support a redirect in case a payment
|
|
is routed to 3D Secure 2 redirect.'
|
|
$ref: '#/components/schemas/BrowserInfo'
|
|
captureDelayHours:
|
|
description: The delay between the authorisation and scheduled auto-capture,
|
|
specified in hours.
|
|
format: int32
|
|
type: integer
|
|
channel:
|
|
description: 'The platform where a payment transaction takes place. This
|
|
field is optional for filtering out payment methods that are only available
|
|
on specific platforms. If this value is not set, then we will try to infer
|
|
it from the `sdkVersion` or `token`.
|
|
|
|
|
|
Possible values:
|
|
|
|
* iOS
|
|
|
|
* Android
|
|
|
|
* Web'
|
|
enum:
|
|
- iOS
|
|
- Android
|
|
- Web
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: Checkout attempt ID that corresponds to the Id generated by
|
|
the client SDK for tracking user payment journey.
|
|
type: string
|
|
company:
|
|
x-addedInVersion: '32'
|
|
description: Information regarding the company.
|
|
$ref: '#/components/schemas/Company'
|
|
conversionId:
|
|
x-addedInVersion: '49'
|
|
deprecated: true
|
|
x-deprecatedInVersion: '68'
|
|
x-deprecatedMessage: Use `checkoutAttemptId` instead
|
|
description: Conversion ID that corresponds to the Id generated by the client
|
|
SDK for tracking user payment journey.
|
|
type: string
|
|
countryCode:
|
|
description: 'The shopper country.
|
|
|
|
|
|
Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
|
|
|
|
Example: NL or DE'
|
|
maxLength: 100
|
|
type: string
|
|
dateOfBirth:
|
|
description: 'The shopper''s date of birth.
|
|
|
|
|
|
Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
|
|
format: date-time
|
|
type: string
|
|
dccQuote:
|
|
description: The forex quote as returned in the response of the forex service.
|
|
$ref: '#/components/schemas/ForexQuote'
|
|
deliverAt:
|
|
x-addedInVersion: '70'
|
|
description: 'The date and time the purchased goods should be delivered.
|
|
|
|
|
|
Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD
|
|
|
|
|
|
Example: 2017-07-17T13:42:40.428+01:00'
|
|
format: date-time
|
|
type: string
|
|
deliveryAddress:
|
|
description: The address where the purchased goods should be delivered.
|
|
$ref: '#/components/schemas/DeliveryAddress'
|
|
deliveryDate:
|
|
description: 'The date and time the purchased goods should be delivered.
|
|
|
|
|
|
Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD
|
|
|
|
|
|
Example: 2017-07-17T13:42:40.428+01:00'
|
|
format: date-time
|
|
type: string
|
|
deviceFingerprint:
|
|
description: A string containing the shopper's device fingerprint. For more
|
|
information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
|
|
maxLength: 5000
|
|
type: string
|
|
donationAccount:
|
|
description: Donation account to which the transaction is credited.
|
|
type: string
|
|
donationCampaignId:
|
|
x-addedInVersion: '67'
|
|
description: The donation campaign ID received in the `/donationCampaigns`
|
|
call.
|
|
type: string
|
|
donationOriginalPspReference:
|
|
description: PSP reference of the transaction from which the donation token
|
|
is generated. Required when `donationToken` is provided.
|
|
type: string
|
|
donationToken:
|
|
description: Donation token received in the `/payments` call.
|
|
type: string
|
|
enableOneClick:
|
|
x-addedInVersion: '32'
|
|
description: When true and `shopperReference` is provided, the shopper will
|
|
be asked if the payment details should be stored for future one-click
|
|
payments.
|
|
type: boolean
|
|
enablePayOut:
|
|
x-addedInVersion: '32'
|
|
description: When true and `shopperReference` is provided, the payment details
|
|
will be tokenized for payouts.
|
|
type: boolean
|
|
enableRecurring:
|
|
x-addedInVersion: '32'
|
|
description: When true and `shopperReference` is provided, the payment details
|
|
will be tokenized for recurring payments.
|
|
type: boolean
|
|
entityType:
|
|
description: The type of the entity the payment is processed for.
|
|
enum:
|
|
- NaturalPerson
|
|
- CompanyName
|
|
type: string
|
|
fraudOffset:
|
|
description: An integer value that is added to the normal fraud score. The
|
|
value can be either positive or negative.
|
|
format: int32
|
|
type: integer
|
|
fundOrigin:
|
|
description: The person or entity funding the money.
|
|
$ref: '#/components/schemas/FundOrigin'
|
|
fundRecipient:
|
|
description: the person or entity receiving the money
|
|
$ref: '#/components/schemas/FundRecipient'
|
|
fundingSource:
|
|
x-addedInVersion: '52'
|
|
description: The funding source that should be used when multiple sources
|
|
are available. For Brazilian combo cards, by default the funding source
|
|
is credit. To use debit, set this value to **debit**.
|
|
enum:
|
|
- debit
|
|
type: string
|
|
industryUsage:
|
|
x-addedInVersion: '70'
|
|
description: "The reason for the amount update. Possible values: \n* **delayedCharge**\
|
|
\ \n* **noShow** \n* **installment**"
|
|
enum:
|
|
- delayedCharge
|
|
- installment
|
|
- noShow
|
|
type: string
|
|
installments:
|
|
description: Contains installment settings. For more information, refer
|
|
to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).
|
|
$ref: '#/components/schemas/Installments'
|
|
lineItems:
|
|
x-addedInVersion: '32'
|
|
description: 'Price and product information about the purchased items, to
|
|
be included on the invoice sent to the shopper.
|
|
|
|
> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna,
|
|
Ratepay, Riverty, and Zip.'
|
|
items:
|
|
$ref: '#/components/schemas/LineItem'
|
|
type: array
|
|
localizedShopperStatement:
|
|
x-addedInVersion: '68'
|
|
additionalProperties:
|
|
type: string
|
|
description: "The `localizedShopperStatement` field lets you use dynamic\
|
|
\ values for your shopper statement in a local character set.\nIf not\
|
|
\ supplied, left empty, or for cross-border transactions, **shopperStatement**\
|
|
\ is used.\n\nAdyen currently supports the ja-Kana character set for Visa\
|
|
\ and Mastercard payments in Japan using Japanese cards. This character\
|
|
\ set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and\
|
|
\ special characters. \n* Half-width or full-width characters."
|
|
type: object
|
|
mandate:
|
|
description: The mandate details to initiate recurring transaction.
|
|
$ref: '#/components/schemas/Mandate'
|
|
mcc:
|
|
description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code)
|
|
(MCC) is a four-digit number, which relates to a particular market segment.
|
|
This code reflects the predominant activity that is conducted by the merchant.
|
|
type: string
|
|
merchantAccount:
|
|
description: The merchant account identifier, with which you want to process
|
|
the transaction.
|
|
type: string
|
|
merchantOrderReference:
|
|
description: 'This reference allows linking multiple transactions to each
|
|
other for reporting purposes (i.e. order auth-rate). The reference should
|
|
be unique per billing cycle.
|
|
|
|
The same merchant order reference should never be reused after the first
|
|
authorised attempt. If used, this field should be supplied for all incoming
|
|
authorisations.
|
|
|
|
> We strongly recommend you send the `merchantOrderReference` value to
|
|
benefit from linking payment requests when authorisation retries take
|
|
place. In addition, we recommend you provide `retry.orderAttemptNumber`,
|
|
`retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
|
|
maxLength: 1000
|
|
type: string
|
|
merchantRiskIndicator:
|
|
x-addedInVersion: '40'
|
|
description: 'Additional risk fields for 3D Secure 2.
|
|
|
|
> For 3D Secure 2 transactions, we recommend that you include this object
|
|
to increase the chances of achieving a frictionless flow.'
|
|
$ref: '#/components/schemas/MerchantRiskIndicator'
|
|
metadata:
|
|
additionalProperties:
|
|
type: string
|
|
description: 'Metadata consists of entries, each of which includes a key
|
|
and a value.
|
|
|
|
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,
|
|
Visa Secure, or Cartes Bancaires).
|
|
$ref: '#/components/schemas/ThreeDSecureData'
|
|
order:
|
|
description: The order information required for partial payments.
|
|
$ref: '#/components/schemas/EncryptedOrderData'
|
|
orderReference:
|
|
description: When you are doing multiple partial (gift card) payments, this
|
|
is the `pspReference` of the first payment. We use this to link the multiple
|
|
payments to each other. As your own reference for linking multiple payments,
|
|
use the `merchantOrderReference`instead.
|
|
type: string
|
|
origin:
|
|
x-addedInVersion: '40'
|
|
description: 'Required for the 3D Secure 2 `channel` **Web** integration.
|
|
|
|
|
|
Set this parameter to the origin URL of the page that you are loading
|
|
the 3D Secure Component from.'
|
|
maxLength: 80
|
|
type: string
|
|
paymentMethod:
|
|
description: The type and required details of a payment method to use.
|
|
oneOf:
|
|
- $ref: '#/components/schemas/ApplePayDonations'
|
|
- $ref: '#/components/schemas/CardDonations'
|
|
- $ref: '#/components/schemas/GooglePayDonations'
|
|
- $ref: '#/components/schemas/IdealDonations'
|
|
- $ref: '#/components/schemas/PayWithGoogleDonations'
|
|
platformChargebackLogic:
|
|
x-addedInVersion: '68'
|
|
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).
|
|
$ref: '#/components/schemas/PlatformChargebackLogic'
|
|
recurringExpiry:
|
|
description: Date after which no further authorisations shall be performed.
|
|
Only for 3D Secure 2.
|
|
type: string
|
|
recurringFrequency:
|
|
description: Minimum number of days between authorisations. Only for 3D
|
|
Secure 2.
|
|
type: string
|
|
recurringProcessingModel:
|
|
x-addedInVersion: '32'
|
|
description: "Defines a recurring payment type. Required when creating a\
|
|
\ token to store payment details or using stored payment details.\nAllowed\
|
|
\ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\
|
|
\ amount, which follows a fixed schedule.\n* `CardOnFile` \u2013 With\
|
|
\ a card-on-file (CoF) transaction, card details are stored to enable\
|
|
\ one-click or omnichannel journeys, or simply to streamline the checkout\
|
|
\ process. Any subscription not following a fixed schedule is also considered\
|
|
\ a card-on-file transaction.\n* `UnscheduledCardOnFile` \u2013 An unscheduled\
|
|
\ card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed\
|
|
\ schedule and/or have variable amounts. For example, automatic top-ups\
|
|
\ when a cardholder's balance drops below a certain amount.\n"
|
|
enum:
|
|
- CardOnFile
|
|
- Subscription
|
|
- UnscheduledCardOnFile
|
|
type: string
|
|
redirectFromIssuerMethod:
|
|
x-addedInVersion: '32'
|
|
description: Specifies the redirect method (GET or POST) when redirecting
|
|
back from the issuer.
|
|
type: string
|
|
redirectToIssuerMethod:
|
|
x-addedInVersion: '32'
|
|
description: Specifies the redirect method (GET or POST) when redirecting
|
|
to the issuer.
|
|
type: string
|
|
reference:
|
|
description: 'The reference to uniquely identify a payment. This reference
|
|
is used in all communication with you about the payment status. We recommend
|
|
using a unique value per payment; however, it is not a requirement.
|
|
|
|
If you need to provide multiple references for a transaction, separate
|
|
them with hyphens ("-").
|
|
|
|
Maximum length: 80 characters.'
|
|
type: string
|
|
returnUrl:
|
|
description: 'The URL to return to in case of a redirection.
|
|
|
|
The format depends on the channel. This URL can have a maximum of 1024
|
|
characters.
|
|
|
|
* For web, include the protocol `http://` or `https://`. You can also
|
|
include your own additional query parameters, for example, shopper ID
|
|
or order reference number.
|
|
|
|
Example: `https://your-company.com/checkout?shopperOrder=12xy`
|
|
|
|
* For iOS, use the custom URL for your app. To know more about setting
|
|
custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).
|
|
|
|
Example: `my-app://`
|
|
|
|
* For Android, use a custom URL handled by an Activity on your app. You
|
|
can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).
|
|
|
|
Example: `my-app://your.package.name`
|
|
|
|
|
|
If the URL to return to includes non-ASCII characters, like spaces or
|
|
special letters, URL encode the value.
|
|
|
|
> The URL must not include personally identifiable information (PII),
|
|
for example name or email address.'
|
|
maxLength: 8000
|
|
type: string
|
|
riskData:
|
|
description: Contains risk data, such as client-side data, used to identify
|
|
risk for a transaction.
|
|
$ref: '#/components/schemas/RiskData'
|
|
selectedRecurringDetailReference:
|
|
description: The `recurringDetailReference` you want to use for this payment.
|
|
The value `LATEST` can be used to select the most recently stored recurring
|
|
detail.
|
|
type: string
|
|
sessionValidity:
|
|
description: 'The date and time until when the session remains valid, in
|
|
[ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
|
|
|
|
|
|
For example: 2020-07-18T15:42:40.428+01:00'
|
|
type: string
|
|
shopperEmail:
|
|
description: 'The shopper''s email address. We recommend that you provide
|
|
this data, as it is used in velocity fraud checks.
|
|
|
|
> For 3D Secure 2 transactions, schemes require `shopperEmail` for all
|
|
browser-based and mobile implementations.'
|
|
type: string
|
|
shopperIP:
|
|
description: 'The shopper''s IP address. In general, we recommend that you
|
|
provide this data, as it is used in a number of risk checks (for instance,
|
|
number of payment attempts or location-based checks).
|
|
|
|
> For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based
|
|
implementations.
|
|
|
|
This field is also mandatory for some merchants depending on your business
|
|
model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
|
|
maxLength: 1000
|
|
type: string
|
|
shopperInteraction:
|
|
description: 'Specifies the sales channel, through which the shopper gives
|
|
their card details, and whether the shopper is a returning customer.
|
|
|
|
For the web service API, Adyen assumes Ecommerce shopper interaction by
|
|
default.
|
|
|
|
|
|
This field has the following possible values:
|
|
|
|
* `Ecommerce` - Online transactions where the cardholder is present (online).
|
|
For better authorisation rates, we recommend sending the card security
|
|
code (CSC) along with the request.
|
|
|
|
* `ContAuth` - Card on file and/or subscription transactions, where the
|
|
cardholder is known to the merchant (returning customer). If the shopper
|
|
is present (online), you can supply also the CSC to improve authorisation
|
|
(one-click payment).
|
|
|
|
* `Moto` - Mail-order and telephone-order transactions where the shopper
|
|
is in contact with the merchant via email or telephone.
|
|
|
|
* `POS` - Point-of-sale transactions where the shopper is physically present
|
|
to make a payment using a secure payment terminal.'
|
|
enum:
|
|
- Ecommerce
|
|
- ContAuth
|
|
- Moto
|
|
- POS
|
|
type: string
|
|
shopperLocale:
|
|
description: The combination of a language code and a country code to specify
|
|
the language to be used in the payment.
|
|
type: string
|
|
shopperName:
|
|
description: The shopper's full name.
|
|
$ref: '#/components/schemas/Name'
|
|
shopperReference:
|
|
description: "Required for recurring payments. \nYour reference to uniquely\
|
|
\ identify this shopper, for example user ID or account ID. Minimum length:\
|
|
\ 3 characters.\n> Your reference must not include personally identifiable\
|
|
\ information (PII), for example name or email address."
|
|
maxLength: 256
|
|
minLength: 3
|
|
type: string
|
|
shopperStatement:
|
|
description: "The text to be shown on the shopper's bank statement.\n We\
|
|
\ recommend sending a maximum of 22 characters, otherwise banks might\
|
|
\ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
|
|
\ spaces, and special characters **. , ' _ - ? + * /**."
|
|
maxLength: 10000
|
|
type: string
|
|
socialSecurityNumber:
|
|
description: The shopper's social security number.
|
|
type: string
|
|
splits:
|
|
x-addedInVersion: '37'
|
|
description: An array of objects specifying how to split a payment when
|
|
using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information),
|
|
[Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information),
|
|
or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
|
|
items:
|
|
$ref: '#/components/schemas/Split'
|
|
type: array
|
|
store:
|
|
description: Required for Adyen for Platforms integrations if you are a
|
|
platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference)
|
|
(on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference)
|
|
(in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store))
|
|
for the ecommerce or point-of-sale store that is processing the payment.
|
|
maxLength: 16
|
|
minLength: 1
|
|
type: string
|
|
storePaymentMethod:
|
|
x-addedInVersion: '49'
|
|
description: When true and `shopperReference` is provided, the payment details
|
|
will be stored.
|
|
type: boolean
|
|
telephoneNumber:
|
|
description: The shopper's telephone number.
|
|
type: string
|
|
threeDS2RequestData:
|
|
x-addedInVersion: '40'
|
|
description: Request fields for 3D Secure 2. To check if any of the following
|
|
fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments)
|
|
or [Classic integration](https://docs.adyen.com/classic-integration) documentation.
|
|
$ref: '#/components/schemas/ThreeDS2RequestFields'
|
|
threeDSAuthenticationOnly:
|
|
x-addedInVersion: '50'
|
|
deprecated: true
|
|
x-deprecatedInVersion: '69'
|
|
x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
|
|
default: false
|
|
description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
|
|
and not the payment authorisation.
|
|
type: boolean
|
|
trustedShopper:
|
|
x-addedInVersion: '37'
|
|
description: Set to true if the payment should be routed to a trusted MID.
|
|
type: boolean
|
|
required:
|
|
- paymentMethod
|
|
- returnUrl
|
|
- merchantAccount
|
|
- reference
|
|
- amount
|
|
type: object
|
|
DonationPaymentResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
amount:
|
|
description: Authorised amount in the transaction.
|
|
$ref: '#/components/schemas/Amount'
|
|
donationAccount:
|
|
description: The Adyen account name of your charity. We will provide you
|
|
with this account name once your chosen charity has been [onboarded](https://docs.adyen.com/online-payments/donations#onboarding).
|
|
type: string
|
|
id:
|
|
description: Your unique resource identifier.
|
|
type: string
|
|
merchantAccount:
|
|
description: The merchant account identifier, with which you want to process
|
|
the transaction.
|
|
type: string
|
|
payment:
|
|
description: Action to be taken for completing the payment.
|
|
$ref: '#/components/schemas/PaymentResponse'
|
|
reference:
|
|
description: 'The reference to uniquely identify a payment. This reference
|
|
is used in all communication with you about the payment status. We recommend
|
|
using a unique value per payment; however, it is not a requirement. If
|
|
you need to provide multiple references for a transaction, separate them
|
|
with hyphens ("-"). Maximum length: 80 characters.'
|
|
type: string
|
|
status:
|
|
description: 'The status of the donation transaction.
|
|
|
|
|
|
Possible values:
|
|
|
|
* **completed**
|
|
|
|
* **pending**
|
|
|
|
* **refused**'
|
|
enum:
|
|
- completed
|
|
- pending
|
|
- refused
|
|
type: string
|
|
type: object
|
|
DragonpayDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
issuer:
|
|
description: The Dragonpay issuer value of the shopper's selected bank.
|
|
Set this to an **id** of a Dragonpay issuer to preselect it.
|
|
type: string
|
|
shopperEmail:
|
|
description: "The shopper\u2019s email address."
|
|
type: string
|
|
type:
|
|
description: '**dragonpay**'
|
|
enum:
|
|
- dragonpay_ebanking
|
|
- dragonpay_otc_banking
|
|
- dragonpay_otc_non_banking
|
|
- dragonpay_otc_philippines
|
|
type: string
|
|
required:
|
|
- type
|
|
- issuer
|
|
title: Dragonpay
|
|
type: object
|
|
EBankingFinlandDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
issuer:
|
|
description: The Ebanking Finland issuer value of the shopper's selected
|
|
bank.
|
|
type: string
|
|
type:
|
|
default: ebanking_FI
|
|
description: '**ebanking_FI**'
|
|
enum:
|
|
- ebanking_FI
|
|
type: string
|
|
required:
|
|
- type
|
|
title: E-Banking Finland
|
|
type: object
|
|
EcontextVoucherDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
firstName:
|
|
description: The shopper's first name.
|
|
type: string
|
|
lastName:
|
|
description: The shopper's last name.
|
|
type: string
|
|
shopperEmail:
|
|
description: The shopper's email.
|
|
type: string
|
|
telephoneNumber:
|
|
description: The shopper's contact number. It must have an international
|
|
number format, for example **+31 20 779 1846**. Formats like **+31 (0)20
|
|
779 1846** or **0031 20 779 1846** are not accepted.
|
|
type: string
|
|
type:
|
|
description: '**econtextvoucher**'
|
|
enum:
|
|
- econtext_seven_eleven
|
|
- econtext_online
|
|
- econtext
|
|
- econtext_stores
|
|
- econtext_atm
|
|
type: string
|
|
required:
|
|
- type
|
|
- firstName
|
|
- lastName
|
|
- shopperEmail
|
|
- telephoneNumber
|
|
title: Voucher
|
|
type: object
|
|
EftDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
bankAccountNumber:
|
|
description: The bank account number (without separators).
|
|
type: string
|
|
bankCode:
|
|
description: The financial institution code.
|
|
type: string
|
|
bankLocationId:
|
|
description: The bank routing number of the account.
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
ownerName:
|
|
description: "The name of the bank account holder.\nIf you submit a name\
|
|
\ with non-Latin characters, we automatically replace some of them with\
|
|
\ corresponding Latin characters to meet the FATF recommendations. For\
|
|
\ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\
|
|
\ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\
|
|
\ accept '\xF8'.\nAfter replacement, the ownerName must have at least\
|
|
\ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\
|
|
\ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\
|
|
\ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\
|
|
> If provided details don't match the required format, the response returns\
|
|
\ the error message: 203 'Invalid bank account holder name'."
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: eft_directdebit_CA
|
|
description: '**eft**'
|
|
enum:
|
|
- eft_directdebit_CA
|
|
type: string
|
|
title: EFT Direct Debit
|
|
type: object
|
|
EncryptedOrderData:
|
|
additionalProperties: false
|
|
properties:
|
|
orderData:
|
|
description: The encrypted order data.
|
|
maxLength: 5000
|
|
type: string
|
|
pspReference:
|
|
description: The `pspReference` that belongs to the order.
|
|
type: string
|
|
required:
|
|
- pspReference
|
|
- orderData
|
|
type: object
|
|
EnhancedSchemeData:
|
|
additionalProperties: false
|
|
properties:
|
|
airline:
|
|
description: '[Airline enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/airline/)
|
|
that may be required for processing the transaction and/or for interchange
|
|
savings.'
|
|
$ref: '#/components/schemas/Airline'
|
|
type: object
|
|
ExternalPlatform:
|
|
additionalProperties: false
|
|
properties:
|
|
integrator:
|
|
description: External platform integrator.
|
|
type: string
|
|
name:
|
|
description: Name of the field. For example, Name of External Platform.
|
|
type: string
|
|
version:
|
|
description: Version of the field. For example, Version of External Platform.
|
|
type: string
|
|
type: object
|
|
FastlaneDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
fastlaneData:
|
|
description: The encoded fastlane data blob
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: fastlane
|
|
description: '**fastlane**'
|
|
enum:
|
|
- fastlane
|
|
type: string
|
|
required:
|
|
- type
|
|
- fastlaneData
|
|
title: Fastlane
|
|
type: object
|
|
ForexQuote:
|
|
additionalProperties: false
|
|
properties:
|
|
account:
|
|
description: The account name.
|
|
type: string
|
|
accountType:
|
|
description: The account type.
|
|
type: string
|
|
baseAmount:
|
|
description: The base amount.
|
|
$ref: '#/components/schemas/Amount'
|
|
basePoints:
|
|
description: The base points.
|
|
format: int32
|
|
type: integer
|
|
buy:
|
|
description: The buy rate.
|
|
$ref: '#/components/schemas/Amount'
|
|
interbank:
|
|
description: The interbank amount.
|
|
$ref: '#/components/schemas/Amount'
|
|
reference:
|
|
description: The reference assigned to the forex quote request.
|
|
type: string
|
|
sell:
|
|
description: The sell rate.
|
|
$ref: '#/components/schemas/Amount'
|
|
signature:
|
|
description: The signature to validate the integrity.
|
|
type: string
|
|
source:
|
|
description: The source of the forex quote.
|
|
type: string
|
|
type:
|
|
description: The type of forex.
|
|
type: string
|
|
validTill:
|
|
description: The date until which the forex quote is valid.
|
|
format: date-time
|
|
type: string
|
|
required:
|
|
- validTill
|
|
- basePoints
|
|
type: object
|
|
FraudCheckResult:
|
|
additionalProperties: false
|
|
properties:
|
|
accountScore:
|
|
description: The fraud score generated by the risk check.
|
|
format: int32
|
|
type: integer
|
|
checkId:
|
|
description: The ID of the risk check.
|
|
format: int32
|
|
type: integer
|
|
name:
|
|
description: The name of the risk check.
|
|
type: string
|
|
required:
|
|
- checkId
|
|
- name
|
|
- accountScore
|
|
type: object
|
|
FraudResult:
|
|
additionalProperties: false
|
|
properties:
|
|
accountScore:
|
|
description: The total fraud score generated by the risk checks.
|
|
format: int32
|
|
type: integer
|
|
results:
|
|
description: The result of the individual risk checks.
|
|
items:
|
|
$ref: '#/components/schemas/FraudCheckResult'
|
|
type: array
|
|
required:
|
|
- accountScore
|
|
type: object
|
|
FundOrigin:
|
|
additionalProperties: false
|
|
properties:
|
|
billingAddress:
|
|
description: The address where to send the invoice.
|
|
$ref: '#/components/schemas/Address'
|
|
shopperEmail:
|
|
description: The email address of the person funding the money.
|
|
type: string
|
|
shopperName:
|
|
description: The name of the person funding the money.
|
|
$ref: '#/components/schemas/Name'
|
|
telephoneNumber:
|
|
description: The phone number of the person funding the money.
|
|
type: string
|
|
walletIdentifier:
|
|
description: The unique identifier of the wallet where the funds are coming
|
|
from.
|
|
type: string
|
|
type: object
|
|
FundRecipient:
|
|
additionalProperties: false
|
|
properties:
|
|
IBAN:
|
|
description: The IBAN of the bank account where the funds are being transferred
|
|
to.
|
|
type: string
|
|
billingAddress:
|
|
description: The address where to send the invoice.
|
|
$ref: '#/components/schemas/Address'
|
|
paymentMethod:
|
|
description: The payment method used by the shopper.
|
|
$ref: '#/components/schemas/CardDetails'
|
|
shopperEmail:
|
|
description: The email address of the shopper.
|
|
type: string
|
|
shopperName:
|
|
description: The name of the shopper.
|
|
$ref: '#/components/schemas/Name'
|
|
shopperReference:
|
|
description: "Required for recurring payments. \nYour reference to uniquely\
|
|
\ identify this shopper, for example user ID or account ID. The value\
|
|
\ is case-sensitive and must be at least three characters.\n> Your reference\
|
|
\ must not include personally identifiable information (PII) such as name\
|
|
\ or email address."
|
|
maxLength: 256
|
|
minLength: 3
|
|
type: string
|
|
storedPaymentMethodId:
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
subMerchant:
|
|
description: 'Required for back-to-back/purchase-driven-load transactions,
|
|
where the funds are taken from the shopper''s stored card when the wallet
|
|
balance is insufficient.
|
|
|
|
The final merchant who will receive the money, also known as a [sub-merchant](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#submerchant).'
|
|
$ref: '#/components/schemas/SubMerchant'
|
|
telephoneNumber:
|
|
description: The telephone number of the shopper.
|
|
type: string
|
|
walletIdentifier:
|
|
description: The unique identifier for the wallet the funds are being transferred
|
|
to. You can use the shopper reference or any other identifier.
|
|
type: string
|
|
walletOwnerTaxId:
|
|
description: The tax identifier of the person receiving the funds.
|
|
type: string
|
|
walletPurpose:
|
|
description: The purpose of a digital wallet transaction.
|
|
enum:
|
|
- identifiedBoleto
|
|
- transferDifferentWallet
|
|
- transferOwnWallet
|
|
- transferSameWallet
|
|
- unidentifiedBoleto
|
|
type: string
|
|
type: object
|
|
GenericIssuerPaymentMethodDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
issuer:
|
|
description: The issuer id of the shopper's selected bank.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
description: '**genericissuer**'
|
|
enum:
|
|
- onlineBanking_PL
|
|
- eps
|
|
- onlineBanking_SK
|
|
- onlineBanking_CZ
|
|
type: string
|
|
required:
|
|
- type
|
|
- issuer
|
|
title: Stored Payment Method
|
|
type: object
|
|
GooglePayDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
fundingSource:
|
|
description: The funding source that should be used when multiple sources
|
|
are available. For Brazilian combo cards, by default the funding source
|
|
is credit. To use debit, set this value to **debit**.
|
|
enum:
|
|
- credit
|
|
- debit
|
|
type: string
|
|
googlePayCardNetwork:
|
|
description: 'The selected payment card network. '
|
|
type: string
|
|
googlePayToken:
|
|
description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData)
|
|
`PaymentData` response.
|
|
maxLength: 10000
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
threeDS2SdkVersion:
|
|
description: Required for mobile integrations. Version of the 3D Secure
|
|
2 mobile SDK.
|
|
maxLength: 12
|
|
type: string
|
|
type:
|
|
default: googlepay
|
|
description: '**googlepay**, **paywithgoogle**'
|
|
enum:
|
|
- googlepay
|
|
type: string
|
|
required:
|
|
- googlePayToken
|
|
title: Google Pay
|
|
type: object
|
|
GooglePayDonations:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
fundingSource:
|
|
description: The funding source that should be used when multiple sources
|
|
are available. For Brazilian combo cards, by default the funding source
|
|
is credit. To use debit, set this value to **debit**.
|
|
enum:
|
|
- credit
|
|
- debit
|
|
type: string
|
|
googlePayCardNetwork:
|
|
description: 'The selected payment card network. '
|
|
type: string
|
|
googlePayToken:
|
|
description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData)
|
|
`PaymentData` response.
|
|
maxLength: 10000
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
threeDS2SdkVersion:
|
|
description: Required for mobile integrations. Version of the 3D Secure
|
|
2 mobile SDK.
|
|
maxLength: 12
|
|
type: string
|
|
type:
|
|
default: googlepay
|
|
description: '**googlepay**, **paywithgoogle**'
|
|
enum:
|
|
- googlepay
|
|
type: string
|
|
required:
|
|
- googlePayToken
|
|
title: Google Pay
|
|
type: object
|
|
IdealDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
issuer:
|
|
description: The iDEAL issuer value of the shopper's selected bank. Set
|
|
this to an **id** of an iDEAL issuer to preselect it.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: ideal
|
|
description: '**ideal**'
|
|
enum:
|
|
- ideal
|
|
type: string
|
|
title: iDEAL
|
|
type: object
|
|
IdealDonations:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
issuer:
|
|
description: The iDEAL issuer value of the shopper's selected bank. Set
|
|
this to an **id** of an iDEAL issuer to preselect it.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: ideal
|
|
description: '**ideal**'
|
|
enum:
|
|
- ideal
|
|
type: string
|
|
title: iDEAL
|
|
type: object
|
|
InputDetail:
|
|
additionalProperties: false
|
|
properties:
|
|
configuration:
|
|
additionalProperties:
|
|
type: string
|
|
description: Configuration parameters for the required input.
|
|
type: object
|
|
details:
|
|
description: Input details can also be provided recursively.
|
|
items:
|
|
$ref: '#/components/schemas/SubInputDetail'
|
|
type: array
|
|
inputDetails:
|
|
deprecated: true
|
|
description: Input details can also be provided recursively (deprecated).
|
|
items:
|
|
$ref: '#/components/schemas/SubInputDetail'
|
|
type: array
|
|
itemSearchUrl:
|
|
description: In case of a select, the URL from which to query the items.
|
|
type: string
|
|
items:
|
|
description: In case of a select, the items to choose from.
|
|
items:
|
|
$ref: '#/components/schemas/Item'
|
|
type: array
|
|
key:
|
|
description: The value to provide in the result.
|
|
type: string
|
|
optional:
|
|
description: True if this input value is optional.
|
|
type: boolean
|
|
type:
|
|
description: The type of the required input.
|
|
type: string
|
|
value:
|
|
description: The value can be pre-filled, if available.
|
|
type: string
|
|
type: object
|
|
InstallmentOption:
|
|
additionalProperties: false
|
|
properties:
|
|
maxValue:
|
|
description: The maximum number of installments offered for this payment
|
|
method.
|
|
format: int32
|
|
type: integer
|
|
plans:
|
|
x-addedInVersion: '64'
|
|
description: 'Defines the type of installment plan. If not set, defaults
|
|
to **regular**.
|
|
|
|
|
|
Possible values:
|
|
|
|
* **regular**
|
|
|
|
* **revolving**'
|
|
items:
|
|
enum:
|
|
- bonus
|
|
- buynow_paylater
|
|
- interes_refund_prctg
|
|
- interest_bonus
|
|
- nointeres_refund_prctg
|
|
- nointerest_bonus
|
|
- refund_prctg
|
|
- regular
|
|
- revolving
|
|
- with_interest
|
|
type: string
|
|
type: array
|
|
preselectedValue:
|
|
x-addedInVersion: '64'
|
|
description: Preselected number of installments offered for this payment
|
|
method.
|
|
format: int32
|
|
type: integer
|
|
values:
|
|
x-addedInVersion: '64'
|
|
description: An array of the number of installments that the shopper can
|
|
choose from. For example, **[2,3,5]**. This cannot be specified simultaneously
|
|
with `maxValue`.
|
|
items:
|
|
format: int32
|
|
type: integer
|
|
type: array
|
|
type: object
|
|
Installments:
|
|
additionalProperties: false
|
|
properties:
|
|
extra:
|
|
x-addedInVersion: '68'
|
|
description: 'Defines the bonus percentage, refund percentage or if the
|
|
transaction is Buy now Pay later.
|
|
|
|
Used for [card installments in Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico)
|
|
|
|
'
|
|
format: int32
|
|
type: integer
|
|
plan:
|
|
x-addedInVersion: '64'
|
|
description: 'The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan).
|
|
|
|
and [Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico).
|
|
|
|
By default, this is set to **regular**.
|
|
|
|
'
|
|
enum:
|
|
- bonus
|
|
- buynow_paylater
|
|
- interes_refund_prctg
|
|
- interest_bonus
|
|
- nointeres_refund_prctg
|
|
- nointerest_bonus
|
|
- refund_prctg
|
|
- regular
|
|
- revolving
|
|
- with_interest
|
|
type: string
|
|
value:
|
|
description: 'Defines the number of installments.
|
|
|
|
Usually, the maximum allowed number of installments is capped. For example,
|
|
it may not be possible to split a payment in more than 24 installments.
|
|
The acquirer sets this upper limit, so its value may vary.
|
|
|
|
This value can be zero for Installments processed in Mexico.'
|
|
format: int32
|
|
type: integer
|
|
required:
|
|
- value
|
|
type: object
|
|
Item:
|
|
additionalProperties: false
|
|
properties:
|
|
id:
|
|
description: The value to provide in the result.
|
|
type: string
|
|
name:
|
|
description: The display name.
|
|
type: string
|
|
type: object
|
|
KlarnaDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
billingAddress:
|
|
description: The address where to send the invoice.
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
deliveryAddress:
|
|
description: The address where the goods should be delivered.
|
|
type: string
|
|
personalDetails:
|
|
description: Shopper name, date of birth, phone number, and email address.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
subtype:
|
|
description: The type of flow to initiate.
|
|
type: string
|
|
type:
|
|
default: klarna
|
|
description: '**klarna**'
|
|
enum:
|
|
- klarna
|
|
- klarnapayments
|
|
- klarnapayments_account
|
|
- klarnapayments_b2b
|
|
- klarna_paynow
|
|
- klarna_account
|
|
- klarna_b2b
|
|
type: string
|
|
required:
|
|
- type
|
|
title: Klarna
|
|
type: object
|
|
Leg:
|
|
additionalProperties: false
|
|
properties:
|
|
carrierCode:
|
|
description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
|
|
2-letter accounting code (PAX) that identifies the carrier.
|
|
|
|
This field is required if the airline data includes leg details.
|
|
|
|
* Example: KLM = KL
|
|
|
|
* minLength: 2 characters
|
|
|
|
* maxLength: 2 characters
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
classOfTravel:
|
|
description: "A one-letter travel class identifier.\n The following are\
|
|
\ common:\n * F: first class\n* J: business class\n* Y: economy class\n\
|
|
* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\
|
|
* maxLength: 1 character\n* Must not start with a space or be all spaces.\n\
|
|
* Must not be all zeros."
|
|
type: string
|
|
dateOfTravel:
|
|
description: 'Date and time of travel in format `yyyy-MM-ddTHH:mm`.
|
|
|
|
* Use local time of departure airport.
|
|
|
|
* minLength: 16 characters
|
|
|
|
* maxLength: 16 characters'
|
|
format: date-time
|
|
type: string
|
|
departureAirportCode:
|
|
description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
|
|
three-letter airport code of the departure airport.
|
|
|
|
This field is required if the airline data includes leg details.
|
|
|
|
|
|
* Encoding: ASCII
|
|
|
|
* Example: Amsterdam = AMS
|
|
|
|
* minLength: 3 characters
|
|
|
|
* maxLength: 3 characters
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
departureTax:
|
|
description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax)
|
|
charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
|
|
* Encoding: Numeric
|
|
|
|
* minLength: 1
|
|
|
|
* maxLength: 11
|
|
|
|
* Must not be all zeros.'
|
|
format: int64
|
|
type: integer
|
|
destinationAirportCode:
|
|
description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
|
|
3-letter airport code of the destination airport.
|
|
|
|
This field is required if the airline data includes leg details.
|
|
|
|
* Example: Amsterdam = AMS
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 3 characters
|
|
|
|
* maxLength: 3 characters
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
fareBasisCode:
|
|
description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code),
|
|
alphanumeric.
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 6 characters
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
flightNumber:
|
|
description: 'The flight identifier.
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 5 characters
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
stopOverCode:
|
|
description: 'A one-letter code that indicates whether the passenger is
|
|
entitled to make a stopover. Can be a space, O if the passenger is entitled
|
|
to make a stopover, or X if they are not.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 1 character'
|
|
type: string
|
|
type: object
|
|
LineItem:
|
|
additionalProperties: false
|
|
properties:
|
|
amountExcludingTax:
|
|
description: Item amount excluding the tax, in minor units.
|
|
format: int64
|
|
type: integer
|
|
amountIncludingTax:
|
|
description: Item amount including the tax, in minor units.
|
|
format: int64
|
|
type: integer
|
|
brand:
|
|
x-addedInVersion: '70'
|
|
description: Brand of the item.
|
|
type: string
|
|
color:
|
|
x-addedInVersion: '70'
|
|
description: Color of the item.
|
|
type: string
|
|
description:
|
|
description: Description of the line item.
|
|
maxLength: 10000
|
|
type: string
|
|
id:
|
|
description: ID of the line item.
|
|
type: string
|
|
imageUrl:
|
|
description: Link to the picture of the purchased item.
|
|
type: string
|
|
itemCategory:
|
|
description: Item category, used by the payment methods PayPal and Ratepay.
|
|
type: string
|
|
manufacturer:
|
|
x-addedInVersion: '70'
|
|
description: Manufacturer of the item.
|
|
type: string
|
|
marketplaceSellerId:
|
|
x-addedInVersion: '70'
|
|
description: Marketplace seller id.
|
|
type: string
|
|
productUrl:
|
|
description: Link to the purchased item.
|
|
type: string
|
|
quantity:
|
|
description: Number of items.
|
|
format: int64
|
|
type: integer
|
|
receiverEmail:
|
|
x-addedInVersion: '70'
|
|
description: Email associated with the given product in the basket (usually
|
|
in electronic gift cards).
|
|
type: string
|
|
size:
|
|
x-addedInVersion: '70'
|
|
description: Size of the item.
|
|
type: string
|
|
sku:
|
|
x-addedInVersion: '70'
|
|
description: Stock keeping unit.
|
|
type: string
|
|
taxAmount:
|
|
description: Tax amount, in minor units.
|
|
format: int64
|
|
type: integer
|
|
taxPercentage:
|
|
description: Tax percentage, in minor units.
|
|
format: int64
|
|
type: integer
|
|
upc:
|
|
x-addedInVersion: '70'
|
|
description: Universal Product Code.
|
|
type: string
|
|
type: object
|
|
ListStoredPaymentMethodsResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
merchantAccount:
|
|
description: Your merchant account.
|
|
type: string
|
|
shopperReference:
|
|
description: 'Your reference to uniquely identify this shopper, for example
|
|
user ID or account ID. Minimum length: 3 characters.
|
|
|
|
> Your reference must not include personally identifiable information
|
|
(PII), for example name or email address.'
|
|
type: string
|
|
storedPaymentMethods:
|
|
description: List of all stored payment methods.
|
|
items:
|
|
$ref: '#/components/schemas/StoredPaymentMethodResource'
|
|
type: array
|
|
type: object
|
|
Mandate:
|
|
additionalProperties: false
|
|
properties:
|
|
amount:
|
|
description: The billing amount (in minor units) of the recurring transactions.
|
|
type: string
|
|
amountRule:
|
|
description: "The limitation rule of the billing amount.\n\nPossible values:\n\
|
|
\ * **max**: The transaction amount can not exceed the `amount`.\n\n *\
|
|
\ **exact**: The transaction amount should be the same as the `amount`.\n\
|
|
\n"
|
|
enum:
|
|
- max
|
|
- exact
|
|
type: string
|
|
billingAttemptsRule:
|
|
description: "The rule to specify the period, within which the recurring\
|
|
\ debit can happen, relative to the mandate recurring date.\n\nPossible\
|
|
\ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\
|
|
\ and on a specific date.\n\n * **after**: On and after a specific date.\n\
|
|
\n"
|
|
enum:
|
|
- 'on'
|
|
- before
|
|
- after
|
|
type: string
|
|
billingDay:
|
|
description: 'The number of the day, on which the recurring debit can happen.
|
|
Should be within the same calendar month as the mandate recurring date.
|
|
|
|
|
|
Possible values: 1-31 based on the `frequency`.'
|
|
type: string
|
|
count:
|
|
description: The number of transactions that can be performed within the
|
|
given frequency.
|
|
type: string
|
|
endsAt:
|
|
description: End date of the billing plan, in YYYY-MM-DD format.
|
|
type: string
|
|
frequency:
|
|
description: 'The frequency with which a shopper should be charged.
|
|
|
|
|
|
Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**,
|
|
**quarterly**, **halfYearly**, **yearly**.'
|
|
enum:
|
|
- adhoc
|
|
- daily
|
|
- weekly
|
|
- biWeekly
|
|
- monthly
|
|
- quarterly
|
|
- halfYearly
|
|
- yearly
|
|
type: string
|
|
remarks:
|
|
description: The message shown by UPI to the shopper on the approval screen.
|
|
type: string
|
|
startsAt:
|
|
description: Start date of the billing plan, in YYYY-MM-DD format. By default,
|
|
the transaction date.
|
|
type: string
|
|
required:
|
|
- frequency
|
|
- amount
|
|
- endsAt
|
|
type: object
|
|
MasterpassDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
fundingSource:
|
|
description: The funding source that should be used when multiple sources
|
|
are available. For Brazilian combo cards, by default the funding source
|
|
is credit. To use debit, set this value to **debit**.
|
|
enum:
|
|
- credit
|
|
- debit
|
|
type: string
|
|
masterpassTransactionId:
|
|
description: The Masterpass transaction ID.
|
|
type: string
|
|
type:
|
|
default: masterpass
|
|
description: '**masterpass**'
|
|
enum:
|
|
- masterpass
|
|
type: string
|
|
required:
|
|
- masterpassTransactionId
|
|
title: Masterpass
|
|
type: object
|
|
MbwayDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
shopperEmail:
|
|
description: ''
|
|
type: string
|
|
telephoneNumber:
|
|
description: ''
|
|
type: string
|
|
type:
|
|
default: mbway
|
|
description: '**mbway**'
|
|
enum:
|
|
- mbway
|
|
type: string
|
|
required:
|
|
- telephoneNumber
|
|
- shopperEmail
|
|
title: MBWay
|
|
type: object
|
|
MerchantDevice:
|
|
additionalProperties: false
|
|
properties:
|
|
os:
|
|
description: Operating system running on the merchant device.
|
|
type: string
|
|
osVersion:
|
|
description: Version of the operating system on the merchant device.
|
|
type: string
|
|
reference:
|
|
description: Merchant device reference.
|
|
type: string
|
|
type: object
|
|
MerchantRiskIndicator:
|
|
additionalProperties: false
|
|
properties:
|
|
addressMatch:
|
|
description: Whether the chosen delivery address is identical to the billing
|
|
address.
|
|
type: boolean
|
|
deliveryAddressIndicator:
|
|
description: 'Indicator regarding the delivery address.
|
|
|
|
Allowed values:
|
|
|
|
* `shipToBillingAddress`
|
|
|
|
* `shipToVerifiedAddress`
|
|
|
|
* `shipToNewAddress`
|
|
|
|
* `shipToStore`
|
|
|
|
* `digitalGoods`
|
|
|
|
* `goodsNotShipped`
|
|
|
|
* `other`'
|
|
enum:
|
|
- shipToBillingAddress
|
|
- shipToVerifiedAddress
|
|
- shipToNewAddress
|
|
- shipToStore
|
|
- digitalGoods
|
|
- goodsNotShipped
|
|
- other
|
|
type: string
|
|
deliveryEmail:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '68'
|
|
x-deprecatedMessage: Use `deliveryEmailAddress` instead.
|
|
description: The delivery email address (for digital goods).
|
|
type: string
|
|
deliveryEmailAddress:
|
|
x-addedInVersion: '68'
|
|
description: 'For Electronic delivery, the email address to which the merchandise
|
|
was delivered. Maximum length: 254 characters.'
|
|
maxLength: 254
|
|
type: string
|
|
deliveryTimeframe:
|
|
description: 'The estimated delivery time for the shopper to receive the
|
|
goods.
|
|
|
|
Allowed values:
|
|
|
|
* `electronicDelivery`
|
|
|
|
* `sameDayShipping`
|
|
|
|
* `overnightShipping`
|
|
|
|
* `twoOrMoreDaysShipping`'
|
|
enum:
|
|
- electronicDelivery
|
|
- sameDayShipping
|
|
- overnightShipping
|
|
- twoOrMoreDaysShipping
|
|
type: string
|
|
giftCardAmount:
|
|
description: For prepaid or gift card purchase, the purchase amount total
|
|
of prepaid or gift card(s).
|
|
$ref: '#/components/schemas/Amount'
|
|
giftCardCount:
|
|
description: For prepaid or gift card purchase, total count of individual
|
|
prepaid or gift cards/codes purchased.
|
|
format: int32
|
|
type: integer
|
|
giftCardCurr:
|
|
x-addedInVersion: '68'
|
|
description: For prepaid or gift card purchase, [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)
|
|
three-digit currency code of the gift card, other than those listed in
|
|
Table A.5 of the EMVCo 3D Secure Protocol and Core Functions Specification.
|
|
type: string
|
|
preOrderDate:
|
|
description: For pre-order purchases, the expected date this product will
|
|
be available to the shopper.
|
|
format: date-time
|
|
type: string
|
|
preOrderPurchase:
|
|
description: Indicator for whether this transaction is for pre-ordering
|
|
a product.
|
|
type: boolean
|
|
preOrderPurchaseInd:
|
|
x-addedInVersion: '68'
|
|
description: Indicates whether Cardholder is placing an order for merchandise
|
|
with a future availability or release date.
|
|
type: string
|
|
reorderItems:
|
|
description: Indicator for whether the shopper has already purchased the
|
|
same items in the past.
|
|
type: boolean
|
|
reorderItemsInd:
|
|
x-addedInVersion: '68'
|
|
description: Indicates whether the cardholder is reordering previously purchased
|
|
merchandise.
|
|
type: string
|
|
shipIndicator:
|
|
x-addedInVersion: '68'
|
|
description: Indicates shipping method chosen for the transaction.
|
|
type: string
|
|
type: object
|
|
MobilePayDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
type:
|
|
default: mobilepay
|
|
description: '**mobilepay**'
|
|
enum:
|
|
- mobilepay
|
|
type: string
|
|
title: MobilePay
|
|
type: object
|
|
MolPayDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
issuer:
|
|
description: The shopper's bank. Specify this with the issuer value that
|
|
corresponds to this bank.
|
|
type: string
|
|
type:
|
|
description: '**molpay**'
|
|
enum:
|
|
- molpay_ebanking_fpx_MY
|
|
- molpay_ebanking_TH
|
|
type: string
|
|
required:
|
|
- type
|
|
- issuer
|
|
title: MOLPay
|
|
type: object
|
|
Name:
|
|
additionalProperties: false
|
|
properties:
|
|
firstName:
|
|
description: The first name.
|
|
maxLength: 80
|
|
type: string
|
|
lastName:
|
|
description: The last name.
|
|
maxLength: 80
|
|
type: string
|
|
required:
|
|
- firstName
|
|
- lastName
|
|
type: object
|
|
OpenInvoiceDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
billingAddress:
|
|
description: The address where to send the invoice.
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
deliveryAddress:
|
|
description: The address where the goods should be delivered.
|
|
type: string
|
|
personalDetails:
|
|
description: Shopper name, date of birth, phone number, and email address.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: openinvoice
|
|
description: '**openinvoice**'
|
|
enum:
|
|
- openinvoice
|
|
- afterpay_directdebit
|
|
- atome_pos
|
|
type: string
|
|
title: Open Invoice
|
|
type: object
|
|
Passenger:
|
|
additionalProperties: false
|
|
properties:
|
|
dateOfBirth:
|
|
description: 'The passenger''s date of birth.
|
|
|
|
* Format `yyyy-MM-dd`
|
|
|
|
* minLength: 10
|
|
|
|
* maxLength: 10'
|
|
format: date
|
|
type: string
|
|
firstName:
|
|
description: 'The passenger''s first name.
|
|
|
|
> This field is required if the airline data includes passenger details
|
|
or leg details.
|
|
|
|
* Encoding: ASCII'
|
|
type: string
|
|
lastName:
|
|
description: 'The passenger''s last name.
|
|
|
|
> This field is required if the airline data includes passenger details
|
|
or leg details.
|
|
|
|
* Encoding: ASCII'
|
|
type: string
|
|
phoneNumber:
|
|
description: 'The passenger''s phone number, including country code. This
|
|
is an alphanumeric field that can include the ''+'' and ''-'' signs.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 3 characters
|
|
|
|
* maxLength: 30 characters'
|
|
type: string
|
|
travellerType:
|
|
description: 'The IATA passenger type code (PTC).
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 3 characters
|
|
|
|
* maxLength: 6 characters'
|
|
type: string
|
|
type: object
|
|
PayByBankAISDirectDebitDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: paybybank_AIS_DD
|
|
description: '**paybybank_**'
|
|
enum:
|
|
- paybybank_AIS_DD
|
|
type: string
|
|
required:
|
|
- type
|
|
title: Pay By Bank AIS Direct Debit
|
|
type: object
|
|
PayByBankDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
issuer:
|
|
description: The PayByBank issuer value of the shopper's selected bank.
|
|
type: string
|
|
type:
|
|
default: paybybank
|
|
description: '**paybybank**'
|
|
enum:
|
|
- paybybank
|
|
type: string
|
|
required:
|
|
- type
|
|
title: PayByBank
|
|
type: object
|
|
PayPalDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
orderID:
|
|
description: The unique ID associated with the order.
|
|
type: string
|
|
payeePreferred:
|
|
description: IMMEDIATE_PAYMENT_REQUIRED or UNRESTRICTED
|
|
type: string
|
|
payerID:
|
|
description: The unique ID associated with the payer.
|
|
type: string
|
|
payerSelected:
|
|
description: PAYPAL or PAYPAL_CREDIT
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
subtype:
|
|
description: The type of flow to initiate.
|
|
enum:
|
|
- express
|
|
- redirect
|
|
- sdk
|
|
type: string
|
|
type:
|
|
default: paypal
|
|
description: '**paypal**'
|
|
enum:
|
|
- paypal
|
|
type: string
|
|
required:
|
|
- type
|
|
title: PayPal
|
|
type: object
|
|
PayPayDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: paypay
|
|
description: '**paypay**'
|
|
enum:
|
|
- paypay
|
|
type: string
|
|
title: PayPay
|
|
type: object
|
|
PayToDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
shopperAccountIdentifier:
|
|
description: The shopper's banking details or payId reference, used to complete
|
|
payment.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: payto
|
|
description: '**payto**'
|
|
enum:
|
|
- payto
|
|
type: string
|
|
title: PayTo
|
|
type: object
|
|
PayUUpiDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
shopperNotificationReference:
|
|
description: The `shopperNotificationReference` returned in the response
|
|
when you requested to notify the shopper. Used for recurring payment only.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: payu_IN_upi
|
|
description: '**payu_IN_upi**'
|
|
enum:
|
|
- payu_IN_upi
|
|
type: string
|
|
virtualPaymentAddress:
|
|
description: The virtual payment address for UPI.
|
|
type: string
|
|
required:
|
|
- type
|
|
title: PayU
|
|
type: object
|
|
PayWithGoogleDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
fundingSource:
|
|
description: The funding source that should be used when multiple sources
|
|
are available. For Brazilian combo cards, by default the funding source
|
|
is credit. To use debit, set this value to **debit**.
|
|
enum:
|
|
- credit
|
|
- debit
|
|
type: string
|
|
googlePayToken:
|
|
description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData)
|
|
`PaymentData` response.
|
|
maxLength: 5000
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
threeDS2SdkVersion:
|
|
description: Required for mobile integrations. Version of the 3D Secure
|
|
2 mobile SDK.
|
|
maxLength: 12
|
|
type: string
|
|
type:
|
|
default: paywithgoogle
|
|
description: '**paywithgoogle**'
|
|
enum:
|
|
- paywithgoogle
|
|
type: string
|
|
required:
|
|
- googlePayToken
|
|
title: Google Pay
|
|
type: object
|
|
PayWithGoogleDonations:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
fundingSource:
|
|
description: The funding source that should be used when multiple sources
|
|
are available. For Brazilian combo cards, by default the funding source
|
|
is credit. To use debit, set this value to **debit**.
|
|
enum:
|
|
- credit
|
|
- debit
|
|
type: string
|
|
googlePayToken:
|
|
description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData)
|
|
`PaymentData` response.
|
|
maxLength: 5000
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
threeDS2SdkVersion:
|
|
description: Required for mobile integrations. Version of the 3D Secure
|
|
2 mobile SDK.
|
|
maxLength: 12
|
|
type: string
|
|
type:
|
|
default: paywithgoogle
|
|
description: '**paywithgoogle**'
|
|
enum:
|
|
- paywithgoogle
|
|
type: string
|
|
required:
|
|
- googlePayToken
|
|
title: Google Pay
|
|
type: object
|
|
PaymentAmountUpdateRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
amount:
|
|
description: The updated amount. The `currency` must match the currency
|
|
used in authorisation.
|
|
$ref: '#/components/schemas/Amount'
|
|
applicationInfo:
|
|
description: Information about your application. For more details, see [Building
|
|
Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
|
|
$ref: '#/components/schemas/ApplicationInfo'
|
|
industryUsage:
|
|
x-addedInVersion: '70'
|
|
description: "The reason for the amount update. Possible values: \n* **delayedCharge**\
|
|
\ \n* **noShow** \n* **installment**"
|
|
enum:
|
|
- delayedCharge
|
|
- installment
|
|
- noShow
|
|
type: string
|
|
lineItems:
|
|
x-addedInVersion: '70'
|
|
description: 'Price and product information of the refunded items, required
|
|
for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
|
|
|
|
> This field is required for partial refunds with 3x 4x Oney, Affirm,
|
|
Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
|
|
items:
|
|
$ref: '#/components/schemas/LineItem'
|
|
type: array
|
|
merchantAccount:
|
|
description: The merchant account that is used to process the payment.
|
|
type: string
|
|
reference:
|
|
description: 'Your reference for the amount update request. Maximum length:
|
|
80 characters.'
|
|
type: string
|
|
splits:
|
|
description: An array of objects specifying how the amount should be split
|
|
between accounts when using Adyen for Platforms. For more information,
|
|
see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/process-payments)
|
|
or [platforms](https://docs.adyen.com/platforms/process-payments).
|
|
items:
|
|
$ref: '#/components/schemas/Split'
|
|
type: array
|
|
required:
|
|
- merchantAccount
|
|
- amount
|
|
type: object
|
|
PaymentAmountUpdateResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
amount:
|
|
description: The updated amount.
|
|
$ref: '#/components/schemas/Amount'
|
|
industryUsage:
|
|
x-addedInVersion: '70'
|
|
description: "The reason for the amount update. Possible values: \n* **delayedCharge**\
|
|
\ \n* **noShow** \n* **installment**"
|
|
enum:
|
|
- delayedCharge
|
|
- installment
|
|
- noShow
|
|
type: string
|
|
merchantAccount:
|
|
description: The merchant account that is used to process the payment.
|
|
type: string
|
|
paymentPspReference:
|
|
description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
|
|
of the payment to update. '
|
|
type: string
|
|
pspReference:
|
|
description: Adyen's 16-character reference associated with the amount update
|
|
request.
|
|
type: string
|
|
reference:
|
|
description: 'Your reference for the amount update request. Maximum length:
|
|
80 characters.'
|
|
type: string
|
|
splits:
|
|
description: An array of objects specifying how the amount should be split
|
|
between accounts when using Adyen for Platforms. For more information,
|
|
see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/process-payments)
|
|
or [platforms](https://docs.adyen.com/platforms/process-payments).
|
|
items:
|
|
$ref: '#/components/schemas/Split'
|
|
type: array
|
|
status:
|
|
description: The status of your request. This will always have the value
|
|
**received**.
|
|
enum:
|
|
- received
|
|
type: string
|
|
required:
|
|
- status
|
|
- merchantAccount
|
|
- amount
|
|
- reference
|
|
- pspReference
|
|
- paymentPspReference
|
|
type: object
|
|
PaymentCancelRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
applicationInfo:
|
|
description: Information about your application. For more details, see [Building
|
|
Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
|
|
$ref: '#/components/schemas/ApplicationInfo'
|
|
merchantAccount:
|
|
description: The merchant account that is used to process the payment.
|
|
type: string
|
|
reference:
|
|
description: 'Your reference for the cancel request. Maximum length: 80
|
|
characters.'
|
|
type: string
|
|
required:
|
|
- merchantAccount
|
|
type: object
|
|
PaymentCancelResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
merchantAccount:
|
|
description: The merchant account that is used to process the payment.
|
|
type: string
|
|
paymentPspReference:
|
|
description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
|
|
of the payment to cancel. '
|
|
type: string
|
|
pspReference:
|
|
description: Adyen's 16-character reference associated with the cancel request.
|
|
type: string
|
|
reference:
|
|
description: Your reference for the cancel request.
|
|
type: string
|
|
status:
|
|
description: The status of your request. This will always have the value
|
|
**received**.
|
|
enum:
|
|
- received
|
|
type: string
|
|
required:
|
|
- status
|
|
- merchantAccount
|
|
- paymentPspReference
|
|
- pspReference
|
|
type: object
|
|
PaymentCaptureRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
amount:
|
|
description: The amount that you want to capture. The `currency` must match
|
|
the currency used in authorisation, the `value` must be smaller than or
|
|
equal to the authorised amount.
|
|
$ref: '#/components/schemas/Amount'
|
|
applicationInfo:
|
|
description: Information about your application. For more details, see [Building
|
|
Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
|
|
$ref: '#/components/schemas/ApplicationInfo'
|
|
enhancedSchemeData:
|
|
x-addedInVersion: '70'
|
|
description: Enhanced scheme data that may be required for processing the
|
|
payment. For example, airline information.
|
|
$ref: '#/components/schemas/EnhancedSchemeData'
|
|
lineItems:
|
|
description: 'Price and product information of the refunded items, required
|
|
for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
|
|
|
|
> This field is required for partial refunds with 3x 4x Oney, Affirm,
|
|
Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
|
|
items:
|
|
$ref: '#/components/schemas/LineItem'
|
|
type: array
|
|
merchantAccount:
|
|
description: The merchant account that is used to process the payment.
|
|
type: string
|
|
platformChargebackLogic:
|
|
x-addedInVersion: '70'
|
|
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).
|
|
$ref: '#/components/schemas/PlatformChargebackLogic'
|
|
reference:
|
|
description: 'Your reference for the capture request. Maximum length: 80
|
|
characters.'
|
|
type: string
|
|
splits:
|
|
description: An array of objects specifying how the amount should be split
|
|
between accounts when using Adyen for Platforms. For more information,
|
|
see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/split-payments)
|
|
or [platforms](https://docs.adyen.com/platforms/online-payments/split-payments/).
|
|
items:
|
|
$ref: '#/components/schemas/Split'
|
|
type: array
|
|
subMerchants:
|
|
x-addedInVersion: '70'
|
|
description: A List of sub-merchants.
|
|
items:
|
|
$ref: '#/components/schemas/SubMerchantInfo'
|
|
type: array
|
|
required:
|
|
- merchantAccount
|
|
- amount
|
|
type: object
|
|
PaymentCaptureResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
amount:
|
|
description: The captured amount.
|
|
$ref: '#/components/schemas/Amount'
|
|
lineItems:
|
|
description: 'Price and product information of the refunded items, required
|
|
for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
|
|
|
|
> This field is required for partial refunds with 3x 4x Oney, Affirm,
|
|
Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
|
|
items:
|
|
$ref: '#/components/schemas/LineItem'
|
|
type: array
|
|
merchantAccount:
|
|
description: The merchant account that is used to process the payment.
|
|
type: string
|
|
paymentPspReference:
|
|
description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
|
|
of the payment to capture. '
|
|
type: string
|
|
platformChargebackLogic:
|
|
x-addedInVersion: '70'
|
|
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).
|
|
$ref: '#/components/schemas/PlatformChargebackLogic'
|
|
pspReference:
|
|
description: Adyen's 16-character reference associated with the capture
|
|
request.
|
|
type: string
|
|
reference:
|
|
description: Your reference for the capture request.
|
|
type: string
|
|
splits:
|
|
description: An array of objects specifying how the amount should be split
|
|
between accounts when using Adyen for Platforms. For more information,
|
|
see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/split-payments)
|
|
or [platforms](https://docs.adyen.com/platforms/online-payments/split-payments/).
|
|
items:
|
|
$ref: '#/components/schemas/Split'
|
|
type: array
|
|
status:
|
|
description: The status of your request. This will always have the value
|
|
**received**.
|
|
enum:
|
|
- received
|
|
type: string
|
|
subMerchants:
|
|
x-addedInVersion: '70'
|
|
description: List of sub-merchants.
|
|
items:
|
|
$ref: '#/components/schemas/SubMerchantInfo'
|
|
type: array
|
|
required:
|
|
- status
|
|
- merchantAccount
|
|
- amount
|
|
- pspReference
|
|
- paymentPspReference
|
|
type: object
|
|
PaymentCompletionDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
MD:
|
|
description: A payment session identifier returned by the card issuer.
|
|
maxLength: 20000
|
|
type: string
|
|
PaReq:
|
|
description: (3D) Payment Authentication Request data for the card issuer.
|
|
maxLength: 20000
|
|
type: string
|
|
PaRes:
|
|
description: (3D) Payment Authentication Response data by the card issuer.
|
|
maxLength: 20000
|
|
type: string
|
|
authorization_token:
|
|
type: string
|
|
billingToken:
|
|
description: PayPal-generated token for recurring payments.
|
|
type: string
|
|
cupsecureplus.smscode:
|
|
description: The SMS verification code collected from the shopper.
|
|
type: string
|
|
facilitatorAccessToken:
|
|
description: PayPal-generated third party access token.
|
|
type: string
|
|
oneTimePasscode:
|
|
description: A random number sent to the mobile phone number of the shopper
|
|
to verify the payment.
|
|
type: string
|
|
orderID:
|
|
description: PayPal-assigned ID for the order.
|
|
type: string
|
|
payerID:
|
|
description: PayPal-assigned ID for the payer (shopper).
|
|
type: string
|
|
payload:
|
|
description: Payload appended to the `returnURL` as a result of the redirect.
|
|
maxLength: 20000
|
|
type: string
|
|
paymentID:
|
|
description: PayPal-generated ID for the payment.
|
|
type: string
|
|
paymentStatus:
|
|
description: 'Value passed from the WeChat MiniProgram `wx.requestPayment`
|
|
**complete** callback. Possible values: any value starting with `requestPayment:`.'
|
|
type: string
|
|
redirectResult:
|
|
description: The result of the redirect as appended to the `returnURL`.
|
|
maxLength: 20000
|
|
type: string
|
|
resultCode:
|
|
description: Value you received from the WeChat Pay SDK.
|
|
type: string
|
|
returnUrlQueryString:
|
|
description: The query string as appended to the `returnURL` when using
|
|
direct issuer links .
|
|
maxLength: 20000
|
|
type: string
|
|
threeDSResult:
|
|
description: 'Base64-encoded string returned by the Component after the
|
|
challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.'
|
|
maxLength: 50000
|
|
type: string
|
|
threeds2.challengeResult:
|
|
description: 'Base64-encoded string returned by the Component after the
|
|
challenge flow. It contains the following parameter: `transStatus`.'
|
|
maxLength: 50000
|
|
type: string
|
|
threeds2.fingerprint:
|
|
description: 'Base64-encoded string returned by the Component after the
|
|
challenge flow. It contains the following parameter: `threeDSCompInd`.'
|
|
maxLength: 100000
|
|
type: string
|
|
vaultToken:
|
|
description: PayPalv2-generated token for recurring payments.
|
|
type: string
|
|
type: object
|
|
PaymentDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
type:
|
|
description: The payment method type.
|
|
enum:
|
|
- alipay
|
|
- multibanco
|
|
- bankTransfer_IBAN
|
|
- paybright
|
|
- paynow
|
|
- affirm_pos
|
|
- trustly
|
|
- trustlyvector
|
|
- oney
|
|
- facilypay
|
|
- facilypay_3x
|
|
- facilypay_4x
|
|
- facilypay_6x
|
|
- facilypay_10x
|
|
- facilypay_12x
|
|
- unionpay
|
|
- kcp_banktransfer
|
|
- kcp_payco
|
|
- kcp_creditcard
|
|
- wechatpaySDK
|
|
- wechatpayQR
|
|
- wechatpayWeb
|
|
- molpay_boost
|
|
- wallet_IN
|
|
- payu_IN_cashcard
|
|
- payu_IN_nb
|
|
- upi_qr
|
|
- paytm
|
|
- molpay_ebanking_VN
|
|
- molpay_ebanking_MY
|
|
- molpay_ebanking_direct_MY
|
|
- swish
|
|
- bizum
|
|
- walley
|
|
- walley_b2b
|
|
- alma
|
|
- paypo
|
|
- scalapay
|
|
- scalapay_3x
|
|
- scalapay_4x
|
|
- molpay_fpx
|
|
- konbini
|
|
- directEbanking
|
|
- boletobancario
|
|
- neteller
|
|
- cashticket
|
|
- ikano
|
|
- karenmillen
|
|
- oasis
|
|
- warehouse
|
|
- primeiropay_boleto
|
|
- mada
|
|
- benefit
|
|
- knet
|
|
- omannet
|
|
- gopay_wallet
|
|
- kcp_naverpay
|
|
- onlinebanking_IN
|
|
- fawry
|
|
- atome
|
|
- moneybookers
|
|
- naps
|
|
- nordea
|
|
- boletobancario_bradesco
|
|
- boletobancario_itau
|
|
- boletobancario_santander
|
|
- boletobancario_bancodobrasil
|
|
- boletobancario_hsbc
|
|
- molpay_maybank2u
|
|
- molpay_cimb
|
|
- molpay_rhb
|
|
- molpay_amb
|
|
- molpay_hlb
|
|
- molpay_affin_epg
|
|
- molpay_bankislam
|
|
- molpay_publicbank
|
|
- fpx_agrobank
|
|
- touchngo
|
|
- maybank2u_mae
|
|
- duitnow
|
|
- promptpay
|
|
- twint_pos
|
|
- alipay_hk
|
|
- alipay_hk_web
|
|
- alipay_hk_wap
|
|
- alipay_wap
|
|
- balanceplatform
|
|
type: string
|
|
title: Payment Details
|
|
type: object
|
|
PaymentDetailsRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
authenticationData:
|
|
x-addedInVersion: '69'
|
|
description: Data for 3DS authentication.
|
|
$ref: '#/components/schemas/DetailsRequestAuthenticationData'
|
|
details:
|
|
description: Use this collection to submit the details that were returned
|
|
as a result of the `/payments` call.
|
|
$ref: '#/components/schemas/PaymentCompletionDetails'
|
|
paymentData:
|
|
description: 'Encoded payment data. For [authorizing a payment after using
|
|
3D Secure 2 Authentication-only](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only/#authorise-the-payment-with-adyen):
|
|
|
|
|
|
If you received `resultCode`: **AuthenticationNotRequired** in the `/payments`
|
|
response, use the `threeDSPaymentData` from the same response.
|
|
|
|
|
|
If you received `resultCode`: **AuthenticationFinished** in the `/payments`
|
|
response, use the `action.paymentData` from the same response.'
|
|
maxLength: 200000
|
|
type: string
|
|
threeDSAuthenticationOnly:
|
|
x-addedInVersion: '40'
|
|
deprecated: true
|
|
x-deprecatedInVersion: '69'
|
|
x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
|
|
description: Change the `authenticationOnly` indicator originally set in
|
|
the `/payments` request. Only needs to be set if you want to modify the
|
|
value set previously.
|
|
type: boolean
|
|
required:
|
|
- details
|
|
type: object
|
|
PaymentDetailsResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
additionalData:
|
|
additionalProperties:
|
|
type: string
|
|
x-anyOf:
|
|
- $ref: '#/components/schemas/ResponseAdditionalData3DSecure'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataCard'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataCommon'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataDomesticError'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataOpi'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataSepa'
|
|
description: 'Contains additional information about the payment. Some data
|
|
fields are included only if you select them first: Go to **Customer Area**
|
|
> **Developers** > **Additional data**.'
|
|
type: object
|
|
amount:
|
|
x-addedInVersion: '52'
|
|
description: Authorised amount in the transaction.
|
|
$ref: '#/components/schemas/Amount'
|
|
donationToken:
|
|
x-addedInVersion: '66'
|
|
description: Donation Token containing payment details for Adyen Giving.
|
|
type: string
|
|
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.
|
|
$ref: '#/components/schemas/CheckoutOrderResponse'
|
|
paymentMethod:
|
|
x-addedInVersion: '69'
|
|
description: "Details about the payment method used in the transaction.\
|
|
\ \nOnly returned if `resultCode` is **Authorised**."
|
|
$ref: '#/components/schemas/ResponsePaymentMethod'
|
|
pspReference:
|
|
description: Adyen's 16-character string reference associated with the transaction/request.
|
|
This value is globally unique; quote it when communicating with us about
|
|
this request.
|
|
type: string
|
|
refusalReason:
|
|
description: 'If the payment''s authorisation is refused or an error occurs
|
|
during authorisation, this field holds Adyen''s mapped reason for the
|
|
refusal or a description of the error. When a transaction fails, the authorisation
|
|
response includes `resultCode` and `refusalReason` values.
|
|
|
|
|
|
For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).'
|
|
type: string
|
|
refusalReasonCode:
|
|
x-addedInVersion: '37'
|
|
description: Code that specifies the refusal reason. For more information,
|
|
see [Authorisation 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* **PartiallyAuthorised** \u2013 The payment\
|
|
\ has been authorised for a partial amount.\nThis happens for card payments\
|
|
\ when the merchant supports Partial Authorisations and the cardholder\
|
|
\ has insufficient funds.\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."
|
|
enum:
|
|
- AuthenticationFinished
|
|
- AuthenticationNotRequired
|
|
- Authorised
|
|
- Cancelled
|
|
- ChallengeShopper
|
|
- Error
|
|
- IdentifyShopper
|
|
- PartiallyAuthorised
|
|
- Pending
|
|
- PresentToShopper
|
|
- Received
|
|
- RedirectShopper
|
|
- Refused
|
|
- Success
|
|
type: string
|
|
shopperLocale:
|
|
description: The shopperLocale.
|
|
type: string
|
|
threeDS2ResponseData:
|
|
x-addedInVersion: '67'
|
|
description: Response of the 3D Secure 2 authentication.
|
|
$ref: '#/components/schemas/ThreeDS2ResponseData'
|
|
threeDS2Result:
|
|
x-addedInVersion: '41'
|
|
description: Result of the 3D Secure 2 authentication.
|
|
$ref: '#/components/schemas/ThreeDS2Result'
|
|
threeDSPaymentData:
|
|
x-addedInVersion: '67'
|
|
description: When non-empty, contains a value that you must submit to the
|
|
`/payments/details` endpoint as `paymentData`.
|
|
type: string
|
|
type: object
|
|
PaymentLinkRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
allowedPaymentMethods:
|
|
description: 'List of payment methods to be presented to the shopper. To
|
|
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
|
|
|
|
|
|
Example: `"allowedPaymentMethods":["ideal","applepay"]`'
|
|
items:
|
|
type: string
|
|
type: array
|
|
amount:
|
|
description: The payment amount and currency.
|
|
$ref: '#/components/schemas/Amount'
|
|
applicationInfo:
|
|
description: Information about your application. For more details, see [Building
|
|
Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
|
|
$ref: '#/components/schemas/ApplicationInfo'
|
|
billingAddress:
|
|
description: The address where to send the invoice.
|
|
$ref: '#/components/schemas/Address'
|
|
blockedPaymentMethods:
|
|
description: 'List of payment methods to be hidden from the shopper. To
|
|
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
|
|
|
|
|
|
Example: `"blockedPaymentMethods":["ideal","applepay"]`'
|
|
items:
|
|
type: string
|
|
type: array
|
|
captureDelayHours:
|
|
x-addedInVersion: '69'
|
|
description: The delay between the authorisation and scheduled auto-capture,
|
|
specified in hours.
|
|
format: int32
|
|
type: integer
|
|
countryCode:
|
|
description: The shopper's two-letter country code.
|
|
maxLength: 100
|
|
type: string
|
|
dateOfBirth:
|
|
x-addedInVersion: '69'
|
|
description: 'The shopper''s date of birth.
|
|
|
|
|
|
Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
|
|
format: date
|
|
type: string
|
|
deliverAt:
|
|
description: 'The date and time when the purchased goods should be delivered.
|
|
|
|
|
|
[ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD,
|
|
for example, **2020-12-18T10:15:30+01:00**.'
|
|
format: date-time
|
|
type: string
|
|
deliveryAddress:
|
|
description: The address where the purchased goods should be delivered.
|
|
$ref: '#/components/schemas/Address'
|
|
description:
|
|
description: 'A short description visible on the payment page.
|
|
|
|
Maximum length: 280 characters.'
|
|
type: string
|
|
expiresAt:
|
|
description: 'The date when the payment link expires.
|
|
|
|
|
|
[ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone
|
|
designator **Z**: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30Z**.
|
|
|
|
|
|
The maximum expiry date is 70 days after the payment link is created.
|
|
|
|
|
|
If not provided, the payment link expires 24 hours after it was created.'
|
|
type: string
|
|
fundOrigin:
|
|
description: The person or entity funding the money.
|
|
$ref: '#/components/schemas/FundOrigin'
|
|
fundRecipient:
|
|
description: the person or entity receiving the money
|
|
$ref: '#/components/schemas/FundRecipient'
|
|
installmentOptions:
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/InstallmentOption'
|
|
description: A set of key-value pairs that specifies the installment options
|
|
available per payment method. The key must be a payment method name in
|
|
lowercase. For example, **card** to specify installment options for all
|
|
cards, or **visa** or **mc**. The value must be an object containing the
|
|
installment options.
|
|
type: object
|
|
lineItems:
|
|
description: 'Price and product information about the purchased items, to
|
|
be included on the invoice sent to the shopper.
|
|
|
|
This parameter is required for open invoice (_buy now, pay later_) payment
|
|
methods such Afterpay, Clearpay, Klarna, RatePay, Riverty, and Zip.'
|
|
items:
|
|
$ref: '#/components/schemas/LineItem'
|
|
type: array
|
|
manualCapture:
|
|
description: Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture).
|
|
type: boolean
|
|
mcc:
|
|
x-addedInVersion: '69'
|
|
description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code)
|
|
(MCC) is a four-digit number, which relates to a particular market segment.
|
|
This code reflects the predominant activity that is conducted by the merchant.
|
|
maxLength: 16
|
|
type: string
|
|
merchantAccount:
|
|
description: The merchant account identifier for which the payment link
|
|
is created.
|
|
type: string
|
|
merchantOrderReference:
|
|
description: This reference allows linking multiple transactions to each
|
|
other for reporting purposes (for example, order auth-rate). The reference
|
|
should be unique per billing cycle.
|
|
maxLength: 1000
|
|
type: string
|
|
metadata:
|
|
additionalProperties:
|
|
type: string
|
|
description: 'Metadata consists of entries, each of which includes a key
|
|
and a value.
|
|
|
|
Limitations:
|
|
|
|
* Maximum 20 key-value pairs per request. Otherwise, error "177" occurs:
|
|
"Metadata size exceeds limit"
|
|
|
|
* Maximum 20 characters per key. Otherwise, error "178" occurs: "Metadata
|
|
key size exceeds limit"
|
|
|
|
* A key cannot have the name `checkout.linkId`. Any value that you provide
|
|
with this key is going to be replaced by the real payment link ID.'
|
|
maxLength: 80
|
|
type: object
|
|
platformChargebackLogic:
|
|
description: Dictates the behavior of how a potential chargeback should
|
|
be booked when using Adyen Platforms.
|
|
$ref: '#/components/schemas/PlatformChargebackLogic'
|
|
recurringProcessingModel:
|
|
description: "Defines a recurring payment type. Required when `storePaymentMethodMode`\
|
|
\ is set to **askForConsent** or **enabled**.\nPossible values:\n* **Subscription**\
|
|
\ \u2013 A transaction for a fixed or variable amount, which follows a\
|
|
\ fixed schedule.\n* **CardOnFile** \u2013 With a card-on-file (CoF) transaction,\
|
|
\ card details are stored to enable one-click or omnichannel journeys,\
|
|
\ or simply to streamline the checkout process. Any subscription not following\
|
|
\ a fixed schedule is also considered a card-on-file transaction.\n* **UnscheduledCardOnFile**\
|
|
\ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\
|
|
\ that occurs on a non-fixed schedule and/or has variable amounts. For\
|
|
\ example, automatic top-ups when a cardholder's balance drops below a\
|
|
\ certain amount.\n"
|
|
enum:
|
|
- CardOnFile
|
|
- Subscription
|
|
- UnscheduledCardOnFile
|
|
maxLength: 50
|
|
type: string
|
|
reference:
|
|
description: A reference that is used to uniquely identify the payment in
|
|
future communications about the payment status.
|
|
type: string
|
|
requiredShopperFields:
|
|
x-addedInVersion: '67'
|
|
description: "List of fields that the shopper has to provide on the payment\
|
|
\ page before completing the payment. For more information, refer to [Provide\
|
|
\ shopper information](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#shopper-information).\n\
|
|
\nPossible values:\n* **billingAddress** \u2013 The address where to send\
|
|
\ the invoice.\n* **deliveryAddress** \u2013 The address where the purchased\
|
|
\ goods should be delivered.\n* **shopperEmail** \u2013 The shopper's\
|
|
\ email address.\n* **shopperName** \u2013 The shopper's full name.\n\
|
|
* **telephoneNumber** \u2013 The shopper's phone number.\n"
|
|
items:
|
|
enum:
|
|
- billingAddress
|
|
- deliveryAddress
|
|
- shopperEmail
|
|
- shopperName
|
|
- telephoneNumber
|
|
type: string
|
|
type: array
|
|
returnUrl:
|
|
description: 'Website URL used for redirection after payment is completed.
|
|
|
|
If provided, a **Continue** button will be shown on the payment page.
|
|
If shoppers select the button, they are redirected to the specified URL.'
|
|
maxLength: 8000
|
|
type: string
|
|
reusable:
|
|
description: Indicates whether the payment link can be reused for multiple
|
|
payments. If not provided, this defaults to **false** which means the
|
|
link can be used for one successful payment only.
|
|
type: boolean
|
|
riskData:
|
|
x-addedInVersion: '65'
|
|
description: Any risk-related settings to apply to the payment.
|
|
$ref: '#/components/schemas/RiskData'
|
|
shopperEmail:
|
|
description: The shopper's email address.
|
|
maxLength: 500
|
|
type: string
|
|
shopperLocale:
|
|
description: 'The language to be used in the payment page, specified by
|
|
a combination of a language and country code. For example, `en-US`.
|
|
|
|
|
|
For a list of shopper locales that Pay by Link supports, refer to [Language
|
|
and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).'
|
|
maxLength: 32
|
|
type: string
|
|
shopperName:
|
|
description: The shopper's full name. This object is required for some payment
|
|
methods such as AfterPay, Klarna, or if you're enrolled in the PayPal
|
|
Seller Protection program.
|
|
$ref: '#/components/schemas/Name'
|
|
shopperReference:
|
|
description: 'Your reference to uniquely identify this shopper, for example
|
|
user ID or account ID. The value is case-sensitive and must be at least
|
|
three characters.
|
|
|
|
> Your reference must not include personally identifiable information
|
|
(PII) such as name or email address.'
|
|
maxLength: 256
|
|
minLength: 3
|
|
type: string
|
|
shopperStatement:
|
|
x-addedInVersion: '69'
|
|
description: "The text to be shown on the shopper's bank statement.\n We\
|
|
\ recommend sending a maximum of 22 characters, otherwise banks might\
|
|
\ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
|
|
\ spaces, and special characters **. , ' _ - ? + * /**."
|
|
maxLength: 10000
|
|
type: string
|
|
showRemovePaymentMethodButton:
|
|
default: true
|
|
description: Set to **false** to hide the button that lets the shopper remove
|
|
a stored payment method.
|
|
type: boolean
|
|
socialSecurityNumber:
|
|
x-addedInVersion: '69'
|
|
description: The shopper's social security number.
|
|
maxLength: 32
|
|
type: string
|
|
splitCardFundingSources:
|
|
x-addedInVersion: '69'
|
|
default: false
|
|
description: Boolean value indicating whether the card payment method should
|
|
be split into separate debit and credit options.
|
|
type: boolean
|
|
splits:
|
|
description: An array of objects specifying how to split a payment when
|
|
using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information),
|
|
[Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information),
|
|
or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
|
|
items:
|
|
$ref: '#/components/schemas/Split'
|
|
type: array
|
|
store:
|
|
description: The physical store, for which this payment is processed.
|
|
type: string
|
|
storePaymentMethodMode:
|
|
x-addedInVersion: '68'
|
|
description: "Indicates if the details of the payment method will be stored\
|
|
\ for the shopper. Possible values:\n* **disabled** \u2013 No details\
|
|
\ will be stored (default).\n* **askForConsent** \u2013 If the `shopperReference`\
|
|
\ is provided, the UI lets the shopper choose if they want their payment\
|
|
\ details to be stored.\n* **enabled** \u2013 If the `shopperReference`\
|
|
\ is provided, the details will be stored without asking the shopper for\
|
|
\ consent. \n When set to **askForConsent** or **enabled**, you must also\
|
|
\ include the `recurringProcessingModel` parameter."
|
|
enum:
|
|
- askForConsent
|
|
- disabled
|
|
- enabled
|
|
type: string
|
|
telephoneNumber:
|
|
x-addedInVersion: '68'
|
|
description: The shopper's telephone number.
|
|
maxLength: 32
|
|
type: string
|
|
themeId:
|
|
x-addedInVersion: '67'
|
|
description: A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes)
|
|
to customize the appearance of the payment page. If not specified, the
|
|
payment page is rendered according to the theme set as default in your
|
|
Customer Area.
|
|
type: string
|
|
threeDS2RequestData:
|
|
description: The cardholder phone number need to be part of the authentication
|
|
message for payment data. It is a requirement for Visa Secure Authentication
|
|
Data Field Mandate effective August 2024.
|
|
$ref: '#/components/schemas/CheckoutSessionThreeDS2RequestData'
|
|
required:
|
|
- amount
|
|
- reference
|
|
- merchantAccount
|
|
type: object
|
|
PaymentLinkResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
allowedPaymentMethods:
|
|
description: 'List of payment methods to be presented to the shopper. To
|
|
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
|
|
|
|
|
|
Example: `"allowedPaymentMethods":["ideal","applepay"]`'
|
|
items:
|
|
type: string
|
|
type: array
|
|
amount:
|
|
description: The payment amount and currency.
|
|
$ref: '#/components/schemas/Amount'
|
|
applicationInfo:
|
|
description: Information about your application. For more details, see [Building
|
|
Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
|
|
$ref: '#/components/schemas/ApplicationInfo'
|
|
billingAddress:
|
|
description: The address where to send the invoice.
|
|
$ref: '#/components/schemas/Address'
|
|
blockedPaymentMethods:
|
|
description: 'List of payment methods to be hidden from the shopper. To
|
|
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
|
|
|
|
|
|
Example: `"blockedPaymentMethods":["ideal","applepay"]`'
|
|
items:
|
|
type: string
|
|
type: array
|
|
captureDelayHours:
|
|
x-addedInVersion: '69'
|
|
description: The delay between the authorisation and scheduled auto-capture,
|
|
specified in hours.
|
|
format: int32
|
|
type: integer
|
|
countryCode:
|
|
description: The shopper's two-letter country code.
|
|
maxLength: 100
|
|
type: string
|
|
dateOfBirth:
|
|
x-addedInVersion: '69'
|
|
description: 'The shopper''s date of birth.
|
|
|
|
|
|
Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
|
|
format: date
|
|
type: string
|
|
deliverAt:
|
|
description: 'The date and time when the purchased goods should be delivered.
|
|
|
|
|
|
[ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD,
|
|
for example, **2020-12-18T10:15:30+01:00**.'
|
|
format: date-time
|
|
type: string
|
|
deliveryAddress:
|
|
description: The address where the purchased goods should be delivered.
|
|
$ref: '#/components/schemas/Address'
|
|
description:
|
|
description: 'A short description visible on the payment page.
|
|
|
|
Maximum length: 280 characters.'
|
|
type: string
|
|
expiresAt:
|
|
description: 'The date when the payment link expires.
|
|
|
|
|
|
[ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone
|
|
designator **Z**: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30Z**.
|
|
|
|
|
|
The maximum expiry date is 70 days after the payment link is created.
|
|
|
|
|
|
If not provided, the payment link expires 24 hours after it was created.'
|
|
type: string
|
|
fundOrigin:
|
|
description: The person or entity funding the money.
|
|
$ref: '#/components/schemas/FundOrigin'
|
|
fundRecipient:
|
|
description: the person or entity receiving the money
|
|
$ref: '#/components/schemas/FundRecipient'
|
|
id:
|
|
x-addedInVersion: '51'
|
|
description: A unique identifier of the payment link.
|
|
readOnly: true
|
|
type: string
|
|
installmentOptions:
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/InstallmentOption'
|
|
description: A set of key-value pairs that specifies the installment options
|
|
available per payment method. The key must be a payment method name in
|
|
lowercase. For example, **card** to specify installment options for all
|
|
cards, or **visa** or **mc**. The value must be an object containing the
|
|
installment options.
|
|
type: object
|
|
lineItems:
|
|
description: 'Price and product information about the purchased items, to
|
|
be included on the invoice sent to the shopper.
|
|
|
|
This parameter is required for open invoice (_buy now, pay later_) payment
|
|
methods such Afterpay, Clearpay, Klarna, RatePay, Riverty, and Zip.'
|
|
items:
|
|
$ref: '#/components/schemas/LineItem'
|
|
type: array
|
|
manualCapture:
|
|
description: Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture).
|
|
type: boolean
|
|
mcc:
|
|
x-addedInVersion: '69'
|
|
description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code)
|
|
(MCC) is a four-digit number, which relates to a particular market segment.
|
|
This code reflects the predominant activity that is conducted by the merchant.
|
|
maxLength: 16
|
|
type: string
|
|
merchantAccount:
|
|
description: The merchant account identifier for which the payment link
|
|
is created.
|
|
type: string
|
|
merchantOrderReference:
|
|
description: This reference allows linking multiple transactions to each
|
|
other for reporting purposes (for example, order auth-rate). The reference
|
|
should be unique per billing cycle.
|
|
maxLength: 1000
|
|
type: string
|
|
metadata:
|
|
additionalProperties:
|
|
type: string
|
|
description: 'Metadata consists of entries, each of which includes a key
|
|
and a value.
|
|
|
|
Limitations:
|
|
|
|
* Maximum 20 key-value pairs per request. Otherwise, error "177" occurs:
|
|
"Metadata size exceeds limit"
|
|
|
|
* Maximum 20 characters per key. Otherwise, error "178" occurs: "Metadata
|
|
key size exceeds limit"
|
|
|
|
* A key cannot have the name `checkout.linkId`. Any value that you provide
|
|
with this key is going to be replaced by the real payment link ID.'
|
|
maxLength: 80
|
|
type: object
|
|
platformChargebackLogic:
|
|
description: Dictates the behavior of how a potential chargeback should
|
|
be booked when using Adyen Platforms.
|
|
$ref: '#/components/schemas/PlatformChargebackLogic'
|
|
recurringProcessingModel:
|
|
description: "Defines a recurring payment type. Required when `storePaymentMethodMode`\
|
|
\ is set to **askForConsent** or **enabled**.\nPossible values:\n* **Subscription**\
|
|
\ \u2013 A transaction for a fixed or variable amount, which follows a\
|
|
\ fixed schedule.\n* **CardOnFile** \u2013 With a card-on-file (CoF) transaction,\
|
|
\ card details are stored to enable one-click or omnichannel journeys,\
|
|
\ or simply to streamline the checkout process. Any subscription not following\
|
|
\ a fixed schedule is also considered a card-on-file transaction.\n* **UnscheduledCardOnFile**\
|
|
\ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\
|
|
\ that occurs on a non-fixed schedule and/or has variable amounts. For\
|
|
\ example, automatic top-ups when a cardholder's balance drops below a\
|
|
\ certain amount.\n"
|
|
enum:
|
|
- CardOnFile
|
|
- Subscription
|
|
- UnscheduledCardOnFile
|
|
maxLength: 50
|
|
type: string
|
|
reference:
|
|
description: A reference that is used to uniquely identify the payment in
|
|
future communications about the payment status.
|
|
type: string
|
|
requiredShopperFields:
|
|
x-addedInVersion: '67'
|
|
description: "List of fields that the shopper has to provide on the payment\
|
|
\ page before completing the payment. For more information, refer to [Provide\
|
|
\ shopper information](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#shopper-information).\n\
|
|
\nPossible values:\n* **billingAddress** \u2013 The address where to send\
|
|
\ the invoice.\n* **deliveryAddress** \u2013 The address where the purchased\
|
|
\ goods should be delivered.\n* **shopperEmail** \u2013 The shopper's\
|
|
\ email address.\n* **shopperName** \u2013 The shopper's full name.\n\
|
|
* **telephoneNumber** \u2013 The shopper's phone number.\n"
|
|
items:
|
|
enum:
|
|
- billingAddress
|
|
- deliveryAddress
|
|
- shopperEmail
|
|
- shopperName
|
|
- telephoneNumber
|
|
type: string
|
|
type: array
|
|
returnUrl:
|
|
description: 'Website URL used for redirection after payment is completed.
|
|
|
|
If provided, a **Continue** button will be shown on the payment page.
|
|
If shoppers select the button, they are redirected to the specified URL.'
|
|
maxLength: 8000
|
|
type: string
|
|
reusable:
|
|
description: Indicates whether the payment link can be reused for multiple
|
|
payments. If not provided, this defaults to **false** which means the
|
|
link can be used for one successful payment only.
|
|
type: boolean
|
|
riskData:
|
|
x-addedInVersion: '65'
|
|
description: Any risk-related settings to apply to the payment.
|
|
$ref: '#/components/schemas/RiskData'
|
|
shopperEmail:
|
|
description: The shopper's email address.
|
|
maxLength: 500
|
|
type: string
|
|
shopperLocale:
|
|
description: 'The language to be used in the payment page, specified by
|
|
a combination of a language and country code. For example, `en-US`.
|
|
|
|
|
|
For a list of shopper locales that Pay by Link supports, refer to [Language
|
|
and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).'
|
|
maxLength: 32
|
|
type: string
|
|
shopperName:
|
|
description: The shopper's full name. This object is required for some payment
|
|
methods such as AfterPay, Klarna, or if you're enrolled in the PayPal
|
|
Seller Protection program.
|
|
$ref: '#/components/schemas/Name'
|
|
shopperReference:
|
|
description: 'Your reference to uniquely identify this shopper, for example
|
|
user ID or account ID. The value is case-sensitive and must be at least
|
|
three characters.
|
|
|
|
> Your reference must not include personally identifiable information
|
|
(PII) such as name or email address.'
|
|
maxLength: 256
|
|
minLength: 3
|
|
type: string
|
|
shopperStatement:
|
|
x-addedInVersion: '69'
|
|
description: "The text to be shown on the shopper's bank statement.\n We\
|
|
\ recommend sending a maximum of 22 characters, otherwise banks might\
|
|
\ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
|
|
\ spaces, and special characters **. , ' _ - ? + * /**."
|
|
maxLength: 10000
|
|
type: string
|
|
showRemovePaymentMethodButton:
|
|
default: true
|
|
description: Set to **false** to hide the button that lets the shopper remove
|
|
a stored payment method.
|
|
type: boolean
|
|
socialSecurityNumber:
|
|
x-addedInVersion: '69'
|
|
description: The shopper's social security number.
|
|
maxLength: 32
|
|
type: string
|
|
splitCardFundingSources:
|
|
x-addedInVersion: '69'
|
|
default: false
|
|
description: Boolean value indicating whether the card payment method should
|
|
be split into separate debit and credit options.
|
|
type: boolean
|
|
splits:
|
|
description: An array of objects specifying how to split a payment when
|
|
using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information),
|
|
[Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information),
|
|
or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
|
|
items:
|
|
$ref: '#/components/schemas/Split'
|
|
type: array
|
|
status:
|
|
description: 'Status of the payment link. Possible values:
|
|
|
|
* **active**: The link can be used to make payments.
|
|
|
|
* **expired**: The expiry date for the payment link has passed. Shoppers
|
|
can no longer use the link to make payments.
|
|
|
|
* **completed**: The shopper completed the payment.
|
|
|
|
* **paymentPending**: The shopper is in the process of making the payment.
|
|
Applies to payment methods with an asynchronous flow.'
|
|
enum:
|
|
- active
|
|
- completed
|
|
- expired
|
|
- paid
|
|
- paymentPending
|
|
type: string
|
|
store:
|
|
description: The physical store, for which this payment is processed.
|
|
type: string
|
|
storePaymentMethodMode:
|
|
x-addedInVersion: '68'
|
|
description: "Indicates if the details of the payment method will be stored\
|
|
\ for the shopper. Possible values:\n* **disabled** \u2013 No details\
|
|
\ will be stored (default).\n* **askForConsent** \u2013 If the `shopperReference`\
|
|
\ is provided, the UI lets the shopper choose if they want their payment\
|
|
\ details to be stored.\n* **enabled** \u2013 If the `shopperReference`\
|
|
\ is provided, the details will be stored without asking the shopper for\
|
|
\ consent. \n When set to **askForConsent** or **enabled**, you must also\
|
|
\ include the `recurringProcessingModel` parameter."
|
|
enum:
|
|
- askForConsent
|
|
- disabled
|
|
- enabled
|
|
type: string
|
|
telephoneNumber:
|
|
x-addedInVersion: '68'
|
|
description: The shopper's telephone number.
|
|
maxLength: 32
|
|
type: string
|
|
themeId:
|
|
x-addedInVersion: '67'
|
|
description: A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes)
|
|
to customize the appearance of the payment page. If not specified, the
|
|
payment page is rendered according to the theme set as default in your
|
|
Customer Area.
|
|
type: string
|
|
threeDS2RequestData:
|
|
description: The cardholder phone number need to be part of the authentication
|
|
message for payment data. It is a requirement for Visa Secure Authentication
|
|
Data Field Mandate effective August 2024.
|
|
$ref: '#/components/schemas/CheckoutSessionThreeDS2RequestData'
|
|
updatedAt:
|
|
description: 'The date when the payment link status was updated.
|
|
|
|
|
|
[ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD,
|
|
for example, **2020-12-18T10:15:30+01:00**.'
|
|
format: date-time
|
|
type: string
|
|
url:
|
|
description: The URL at which the shopper can complete the payment.
|
|
readOnly: true
|
|
type: string
|
|
required:
|
|
- amount
|
|
- reference
|
|
- merchantAccount
|
|
- id
|
|
- url
|
|
- status
|
|
type: object
|
|
PaymentMethod:
|
|
additionalProperties: false
|
|
properties:
|
|
apps:
|
|
description: A list of apps for this payment method.
|
|
items:
|
|
$ref: '#/components/schemas/PaymentMethodUPIApps'
|
|
type: array
|
|
brand:
|
|
x-addedInVersion: '65'
|
|
description: 'Brand for the selected gift card. For example: plastix, hmclub.'
|
|
type: string
|
|
brands:
|
|
x-addedInVersion: '49'
|
|
description: 'List of possible brands. For example: visa, mc.'
|
|
items:
|
|
type: string
|
|
type: array
|
|
configuration:
|
|
additionalProperties:
|
|
type: string
|
|
description: The configuration of the payment method.
|
|
type: object
|
|
fundingSource:
|
|
x-addedInVersion: '53'
|
|
description: The funding source of the payment method.
|
|
enum:
|
|
- credit
|
|
- debit
|
|
type: string
|
|
group:
|
|
description: The group where this payment method belongs to.
|
|
$ref: '#/components/schemas/PaymentMethodGroup'
|
|
inputDetails:
|
|
deprecated: true
|
|
description: All input details to be provided to complete the payment with
|
|
this payment method.
|
|
items:
|
|
$ref: '#/components/schemas/InputDetail'
|
|
type: array
|
|
issuers:
|
|
x-addedInVersion: '68'
|
|
description: A list of issuers for this payment method.
|
|
items:
|
|
$ref: '#/components/schemas/PaymentMethodIssuer'
|
|
type: array
|
|
name:
|
|
description: The displayable name of this payment method.
|
|
type: string
|
|
type:
|
|
description: The unique payment method code.
|
|
type: string
|
|
type: object
|
|
PaymentMethodGroup:
|
|
additionalProperties: false
|
|
properties:
|
|
name:
|
|
description: The name of the group.
|
|
type: string
|
|
paymentMethodData:
|
|
description: Echo data to be used if the payment method is displayed as
|
|
part of this group.
|
|
type: string
|
|
type:
|
|
description: The unique code of the group.
|
|
type: string
|
|
type: object
|
|
PaymentMethodIssuer:
|
|
additionalProperties: false
|
|
properties:
|
|
disabled:
|
|
default: false
|
|
description: A boolean value indicating whether this issuer is unavailable.
|
|
Can be `true` whenever the issuer is offline.
|
|
type: boolean
|
|
id:
|
|
description: The unique identifier of this issuer, to submit in requests
|
|
to /payments.
|
|
type: string
|
|
name:
|
|
description: A localized name of the issuer.
|
|
type: string
|
|
required:
|
|
- id
|
|
- name
|
|
type: object
|
|
PaymentMethodToStore:
|
|
additionalProperties: false
|
|
properties:
|
|
brand:
|
|
description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.'
|
|
type: string
|
|
cvc:
|
|
description: The card verification code. Only collect raw card data if you
|
|
are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
|
|
type: string
|
|
encryptedCard:
|
|
description: The encrypted card.
|
|
maxLength: 40000
|
|
type: string
|
|
encryptedCardNumber:
|
|
description: The encrypted card number.
|
|
maxLength: 15000
|
|
type: string
|
|
encryptedExpiryMonth:
|
|
description: The encrypted card expiry month.
|
|
maxLength: 15000
|
|
type: string
|
|
encryptedExpiryYear:
|
|
description: The encrypted card expiry year.
|
|
maxLength: 15000
|
|
type: string
|
|
encryptedSecurityCode:
|
|
description: The encrypted card verification code.
|
|
maxLength: 15000
|
|
type: string
|
|
expiryMonth:
|
|
description: The card expiry month. Only collect raw card data if you are
|
|
[fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
|
|
type: string
|
|
expiryYear:
|
|
description: The card expiry year. Only collect raw card data if you are
|
|
[fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
|
|
type: string
|
|
holderName:
|
|
description: The name of the card holder.
|
|
type: string
|
|
number:
|
|
description: The card number. Only collect raw card data if you are [fully
|
|
PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
|
|
type: string
|
|
type:
|
|
description: Set to **scheme**.
|
|
type: string
|
|
type: object
|
|
PaymentMethodUPIApps:
|
|
additionalProperties: false
|
|
properties:
|
|
id:
|
|
description: The unique identifier of this app, to submit in requests to
|
|
/payments.
|
|
type: string
|
|
name:
|
|
description: A localized name of the app.
|
|
type: string
|
|
required:
|
|
- id
|
|
- name
|
|
type: object
|
|
PaymentMethodsRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
additionalData:
|
|
additionalProperties:
|
|
type: string
|
|
x-anyOf:
|
|
- $ref: '#/components/schemas/AdditionalData3DSecure'
|
|
- $ref: '#/components/schemas/AdditionalDataAirline'
|
|
- $ref: '#/components/schemas/AdditionalDataCarRental'
|
|
- $ref: '#/components/schemas/AdditionalDataCommon'
|
|
- $ref: '#/components/schemas/AdditionalDataLevel23'
|
|
- $ref: '#/components/schemas/AdditionalDataLodging'
|
|
- $ref: '#/components/schemas/AdditionalDataOpenInvoice'
|
|
- $ref: '#/components/schemas/AdditionalDataOpi'
|
|
- $ref: '#/components/schemas/AdditionalDataRatepay'
|
|
- $ref: '#/components/schemas/AdditionalDataRetry'
|
|
- $ref: '#/components/schemas/AdditionalDataRisk'
|
|
- $ref: '#/components/schemas/AdditionalDataRiskStandalone'
|
|
- $ref: '#/components/schemas/AdditionalDataSubMerchant'
|
|
- $ref: '#/components/schemas/AdditionalDataTemporaryServices'
|
|
- $ref: '#/components/schemas/AdditionalDataWallets'
|
|
description: 'This field contains additional data, which may be required
|
|
for a particular payment request.
|
|
|
|
|
|
The `additionalData` object consists of entries, each of which includes
|
|
the key and value.'
|
|
type: object
|
|
allowedPaymentMethods:
|
|
x-addedInVersion: '37'
|
|
description: 'List of payment methods to be presented to the shopper. To
|
|
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
|
|
|
|
|
|
Example: `"allowedPaymentMethods":["ideal","applepay"]`'
|
|
items:
|
|
type: string
|
|
type: array
|
|
amount:
|
|
description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)).
|
|
For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
|
|
requests, set amount to 0 (zero).
|
|
$ref: '#/components/schemas/Amount'
|
|
blockedPaymentMethods:
|
|
x-addedInVersion: '37'
|
|
description: 'List of payment methods to be hidden from the shopper. To
|
|
refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
|
|
|
|
|
|
Example: `"blockedPaymentMethods":["ideal","applepay"]`'
|
|
items:
|
|
type: string
|
|
type: array
|
|
channel:
|
|
description: 'The platform where a payment transaction takes place. This
|
|
field can be used for filtering out payment methods that are only available
|
|
on specific platforms. Possible values:
|
|
|
|
* iOS
|
|
|
|
* Android
|
|
|
|
* Web'
|
|
enum:
|
|
- iOS
|
|
- Android
|
|
- Web
|
|
type: string
|
|
countryCode:
|
|
description: The shopper's country code.
|
|
type: string
|
|
merchantAccount:
|
|
description: The merchant account identifier, with which you want to process
|
|
the transaction.
|
|
type: string
|
|
order:
|
|
x-addedInVersion: '64'
|
|
description: The order information required for partial payments.
|
|
$ref: '#/components/schemas/EncryptedOrderData'
|
|
shopperConversionId:
|
|
description: A unique ID that can be used to associate `/paymentMethods`
|
|
and `/payments` requests with the same shopper transaction, offering insights
|
|
into conversion rates.
|
|
maxLength: 256
|
|
type: string
|
|
shopperLocale:
|
|
x-addedInVersion: '7'
|
|
description: The combination of a language code and a country code to specify
|
|
the language to be used in the payment.
|
|
type: string
|
|
shopperReference:
|
|
description: "Required for recurring payments. \nYour reference to uniquely\
|
|
\ identify this shopper, for example user ID or account ID. The value\
|
|
\ is case-sensitive and must be at least three characters.\n> Your reference\
|
|
\ must not include personally identifiable information (PII) such as name\
|
|
\ or email address."
|
|
type: string
|
|
splitCardFundingSources:
|
|
x-addedInVersion: '53'
|
|
default: false
|
|
description: Boolean value indicating whether the card payment method should
|
|
be split into separate debit and credit options.
|
|
type: boolean
|
|
store:
|
|
x-addedInVersion: '23'
|
|
description: Required for Adyen for Platforms integrations if you are a
|
|
platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference)
|
|
(on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference)
|
|
(in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store))
|
|
for the ecommerce or point-of-sale store that is processing the payment.
|
|
maxLength: 16
|
|
minLength: 1
|
|
type: string
|
|
storeFiltrationMode:
|
|
description: "Specifies how payment methods should be filtered based on\
|
|
\ the 'store' parameter:\n - 'exclusive': Only payment methods belonging\
|
|
\ to the specified 'store' are returned.\n - 'inclusive': Payment methods\
|
|
\ from the 'store' and those not associated with any other store are returned."
|
|
enum:
|
|
- exclusive
|
|
- inclusive
|
|
- skipFilter
|
|
type: string
|
|
required:
|
|
- merchantAccount
|
|
type: object
|
|
PaymentMethodsResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
paymentMethods:
|
|
description: Detailed list of payment methods required to generate payment
|
|
forms.
|
|
items:
|
|
$ref: '#/components/schemas/PaymentMethod'
|
|
type: array
|
|
storedPaymentMethods:
|
|
x-addedInVersion: '49'
|
|
description: List of all stored payment methods.
|
|
items:
|
|
$ref: '#/components/schemas/StoredPaymentMethod'
|
|
type: array
|
|
type: object
|
|
PaymentRefundRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
amount:
|
|
description: The amount that you want to refund. The `currency` must match
|
|
the currency used in authorisation, the `value` must be smaller than or
|
|
equal to the authorised amount.
|
|
$ref: '#/components/schemas/Amount'
|
|
applicationInfo:
|
|
description: Information about your application. For more details, see [Building
|
|
Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
|
|
$ref: '#/components/schemas/ApplicationInfo'
|
|
lineItems:
|
|
description: 'Price and product information of the refunded items, required
|
|
for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
|
|
|
|
> This field is required for partial refunds with 3x 4x Oney, Affirm,
|
|
Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
|
|
items:
|
|
$ref: '#/components/schemas/LineItem'
|
|
type: array
|
|
merchantAccount:
|
|
description: The merchant account that is used to process the payment.
|
|
type: string
|
|
merchantRefundReason:
|
|
description: 'The reason for the refund request.
|
|
|
|
|
|
Possible values:
|
|
|
|
|
|
* **FRAUD**
|
|
|
|
|
|
* **CUSTOMER REQUEST**
|
|
|
|
|
|
* **RETURN**
|
|
|
|
|
|
* **DUPLICATE**
|
|
|
|
|
|
* **OTHER**
|
|
|
|
|
|
'
|
|
enum:
|
|
- FRAUD
|
|
- CUSTOMER REQUEST
|
|
- RETURN
|
|
- DUPLICATE
|
|
- OTHER
|
|
nullable: true
|
|
type: string
|
|
reference:
|
|
description: 'Your reference for the refund request. Maximum length: 80
|
|
characters.'
|
|
type: string
|
|
splits:
|
|
description: An array of objects specifying how the amount should be split
|
|
between accounts when using Adyen for Platforms. For more information,
|
|
see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/split-payments)
|
|
or [platforms](https://docs.adyen.com/platforms/online-payments/split-payments/).
|
|
items:
|
|
$ref: '#/components/schemas/Split'
|
|
type: array
|
|
store:
|
|
description: The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores)
|
|
that is processing the refund. This must be the same as the store name
|
|
configured in your Customer Area. Otherwise, you get an error and the
|
|
refund fails.
|
|
type: string
|
|
required:
|
|
- merchantAccount
|
|
- amount
|
|
type: object
|
|
PaymentRefundResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
amount:
|
|
description: The refund amount.
|
|
$ref: '#/components/schemas/Amount'
|
|
capturePspReference:
|
|
description: This is only available for PayPal refunds. The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
|
|
of the specific capture to refund.
|
|
type: string
|
|
lineItems:
|
|
description: 'Price and product information of the refunded items, required
|
|
for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
|
|
|
|
> This field is required for partial refunds with 3x 4x Oney, Affirm,
|
|
Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
|
|
items:
|
|
$ref: '#/components/schemas/LineItem'
|
|
type: array
|
|
merchantAccount:
|
|
description: The merchant account that is used to process the payment.
|
|
type: string
|
|
merchantRefundReason:
|
|
description: Your reason for the refund request.
|
|
enum:
|
|
- FRAUD
|
|
- CUSTOMER REQUEST
|
|
- RETURN
|
|
- DUPLICATE
|
|
- OTHER
|
|
nullable: true
|
|
type: string
|
|
paymentPspReference:
|
|
description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
|
|
of the payment to refund. '
|
|
type: string
|
|
pspReference:
|
|
description: Adyen's 16-character reference associated with the refund request.
|
|
type: string
|
|
reference:
|
|
description: Your reference for the refund request.
|
|
type: string
|
|
splits:
|
|
description: An array of objects specifying how the amount should be split
|
|
between accounts when using Adyen for Platforms. For more information,
|
|
see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/split-payments)
|
|
or [platforms](https://docs.adyen.com/platforms/online-payments/split-payments/).
|
|
items:
|
|
$ref: '#/components/schemas/Split'
|
|
type: array
|
|
status:
|
|
description: The status of your request. This will always have the value
|
|
**received**.
|
|
enum:
|
|
- received
|
|
type: string
|
|
store:
|
|
description: The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores)
|
|
that is processing the refund. This must be the same as the store name
|
|
configured in your Customer Area. Otherwise, you get an error and the
|
|
refund fails.
|
|
type: string
|
|
required:
|
|
- status
|
|
- merchantAccount
|
|
- amount
|
|
- pspReference
|
|
- paymentPspReference
|
|
type: object
|
|
PaymentRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
accountInfo:
|
|
x-addedInVersion: '40'
|
|
description: 'Shopper account information for 3D Secure 2.
|
|
|
|
> For 3D Secure 2 transactions, we recommend that you include this object
|
|
to increase the chances of achieving a frictionless flow.'
|
|
$ref: '#/components/schemas/AccountInfo'
|
|
additionalAmount:
|
|
description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
|
|
request to use a non-zero value, assign this value to `additionalAmount`
|
|
(while the amount must be still set to 0 to trigger BIN or card verification).
|
|
|
|
Required to be in the same currency as the `amount`. '
|
|
$ref: '#/components/schemas/Amount'
|
|
additionalData:
|
|
additionalProperties:
|
|
type: string
|
|
x-anyOf:
|
|
- $ref: '#/components/schemas/AdditionalData3DSecure'
|
|
- $ref: '#/components/schemas/AdditionalDataAirline'
|
|
- $ref: '#/components/schemas/AdditionalDataCarRental'
|
|
- $ref: '#/components/schemas/AdditionalDataCommon'
|
|
- $ref: '#/components/schemas/AdditionalDataLevel23'
|
|
- $ref: '#/components/schemas/AdditionalDataLodging'
|
|
- $ref: '#/components/schemas/AdditionalDataOpenInvoice'
|
|
- $ref: '#/components/schemas/AdditionalDataOpi'
|
|
- $ref: '#/components/schemas/AdditionalDataRatepay'
|
|
- $ref: '#/components/schemas/AdditionalDataRetry'
|
|
- $ref: '#/components/schemas/AdditionalDataRisk'
|
|
- $ref: '#/components/schemas/AdditionalDataRiskStandalone'
|
|
- $ref: '#/components/schemas/AdditionalDataSubMerchant'
|
|
- $ref: '#/components/schemas/AdditionalDataTemporaryServices'
|
|
- $ref: '#/components/schemas/AdditionalDataWallets'
|
|
description: 'This field contains additional data, which may be required
|
|
for a particular payment request.
|
|
|
|
|
|
The `additionalData` object consists of entries, each of which includes
|
|
the key and value.'
|
|
type: object
|
|
amount:
|
|
description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)).
|
|
For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
|
|
requests, set amount to 0 (zero).
|
|
$ref: '#/components/schemas/Amount'
|
|
applicationInfo:
|
|
x-addedInVersion: '40'
|
|
description: Information about your application. For more details, see [Building
|
|
Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
|
|
$ref: '#/components/schemas/ApplicationInfo'
|
|
authenticationData:
|
|
x-addedInVersion: '69'
|
|
description: Data for 3DS authentication.
|
|
$ref: '#/components/schemas/AuthenticationData'
|
|
bankAccount:
|
|
description: 'The details of the bank account, from which the payment should
|
|
be made.
|
|
|
|
> Either `bankAccount` or `card` field must be provided in a payment request.'
|
|
$ref: '#/components/schemas/CheckoutBankAccount'
|
|
billingAddress:
|
|
description: 'The address where to send the invoice.
|
|
|
|
> The `billingAddress` object is required in the following scenarios.
|
|
Include all of the fields within this object.
|
|
|
|
>* For 3D Secure 2 transactions in all browser-based and mobile implementations.
|
|
|
|
>* For cross-border payouts to and from Canada.'
|
|
$ref: '#/components/schemas/BillingAddress'
|
|
browserInfo:
|
|
description: 'The shopper''s browser information.
|
|
|
|
> For 3D Secure, the full object is required for web integrations. For
|
|
mobile app integrations, include the `userAgent` and `acceptHeader` fields
|
|
to indicate that your integration can support a redirect in case a payment
|
|
is routed to 3D Secure 2 redirect.'
|
|
$ref: '#/components/schemas/BrowserInfo'
|
|
captureDelayHours:
|
|
description: The delay between the authorisation and scheduled auto-capture,
|
|
specified in hours.
|
|
format: int32
|
|
type: integer
|
|
channel:
|
|
description: 'The platform where a payment transaction takes place. This
|
|
field is optional for filtering out payment methods that are only available
|
|
on specific platforms. If this value is not set, then we will try to infer
|
|
it from the `sdkVersion` or `token`.
|
|
|
|
|
|
Possible values:
|
|
|
|
* iOS
|
|
|
|
* Android
|
|
|
|
* Web'
|
|
enum:
|
|
- iOS
|
|
- Android
|
|
- Web
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: Checkout attempt ID that corresponds to the Id generated by
|
|
the client SDK for tracking user payment journey.
|
|
maxLength: 256
|
|
type: string
|
|
company:
|
|
x-addedInVersion: '32'
|
|
description: Information regarding the company.
|
|
$ref: '#/components/schemas/Company'
|
|
conversionId:
|
|
x-addedInVersion: '49'
|
|
deprecated: true
|
|
x-deprecatedInVersion: '68'
|
|
x-deprecatedMessage: Use `checkoutAttemptId` instead
|
|
description: Conversion ID that corresponds to the Id generated by the client
|
|
SDK for tracking user payment journey.
|
|
type: string
|
|
countryCode:
|
|
description: 'The shopper country.
|
|
|
|
|
|
Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
|
|
|
|
Example: NL or DE'
|
|
maxLength: 100
|
|
type: string
|
|
dateOfBirth:
|
|
description: 'The shopper''s date of birth.
|
|
|
|
|
|
Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
|
|
format: date-time
|
|
type: string
|
|
dccQuote:
|
|
description: The forex quote as returned in the response of the forex service.
|
|
$ref: '#/components/schemas/ForexQuote'
|
|
deliverAt:
|
|
x-addedInVersion: '70'
|
|
description: 'The date and time the purchased goods should be delivered.
|
|
|
|
|
|
Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD
|
|
|
|
|
|
Example: 2017-07-17T13:42:40.428+01:00'
|
|
format: date-time
|
|
type: string
|
|
deliveryAddress:
|
|
description: The address where the purchased goods should be delivered.
|
|
$ref: '#/components/schemas/DeliveryAddress'
|
|
deliveryDate:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '70'
|
|
x-deprecatedMessage: Use `deliverAt` instead.
|
|
description: 'The date and time the purchased goods should be delivered.
|
|
|
|
|
|
Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD
|
|
|
|
|
|
Example: 2017-07-17T13:42:40.428+01:00'
|
|
format: date-time
|
|
type: string
|
|
deviceFingerprint:
|
|
description: A string containing the shopper's device fingerprint. For more
|
|
information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
|
|
maxLength: 5000
|
|
type: string
|
|
enableOneClick:
|
|
x-addedInVersion: '32'
|
|
description: When true and `shopperReference` is provided, the shopper will
|
|
be asked if the payment details should be stored for future [one-click
|
|
payments](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
|
|
type: boolean
|
|
enablePayOut:
|
|
x-addedInVersion: '32'
|
|
description: When true and `shopperReference` is provided, the payment details
|
|
will be tokenized for payouts.
|
|
type: boolean
|
|
enableRecurring:
|
|
x-addedInVersion: '32'
|
|
description: When true and `shopperReference` is provided, the payment details
|
|
will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types)
|
|
where the shopper is not present, such as subscription or automatic top-up
|
|
payments.
|
|
type: boolean
|
|
enhancedSchemeData:
|
|
x-addedInVersion: '70'
|
|
description: '[Enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/)
|
|
that may be required for processing the payment and/or interchange savings
|
|
can apply.'
|
|
$ref: '#/components/schemas/EnhancedSchemeData'
|
|
entityType:
|
|
description: The type of the entity the payment is processed for.
|
|
enum:
|
|
- NaturalPerson
|
|
- CompanyName
|
|
type: string
|
|
fraudOffset:
|
|
description: An integer value that is added to the normal fraud score. The
|
|
value can be either positive or negative.
|
|
format: int32
|
|
type: integer
|
|
fundOrigin:
|
|
description: The person or entity funding the money.
|
|
$ref: '#/components/schemas/FundOrigin'
|
|
fundRecipient:
|
|
description: the person or entity receiving the money
|
|
$ref: '#/components/schemas/FundRecipient'
|
|
industryUsage:
|
|
x-addedInVersion: '70'
|
|
description: "The reason for the amount update. Possible values: \n* **delayedCharge**\
|
|
\ \n* **noShow** \n* **installment**"
|
|
enum:
|
|
- delayedCharge
|
|
- installment
|
|
- noShow
|
|
type: string
|
|
installments:
|
|
description: Contains installment settings. For more information, refer
|
|
to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).
|
|
$ref: '#/components/schemas/Installments'
|
|
lineItems:
|
|
x-addedInVersion: '32'
|
|
description: 'Price and product information about the purchased items, to
|
|
be included on the invoice sent to the shopper.
|
|
|
|
> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna,
|
|
Ratepay, Riverty, and Zip.'
|
|
items:
|
|
$ref: '#/components/schemas/LineItem'
|
|
type: array
|
|
localizedShopperStatement:
|
|
x-addedInVersion: '68'
|
|
additionalProperties:
|
|
type: string
|
|
description: "The `localizedShopperStatement` field lets you use dynamic\
|
|
\ values for your shopper statement in a local character set.\nIf not\
|
|
\ supplied, left empty, or for cross-border transactions, **shopperStatement**\
|
|
\ is used.\n\nAdyen currently supports the ja-Kana character set for Visa\
|
|
\ and Mastercard payments in Japan using Japanese cards. This character\
|
|
\ set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and\
|
|
\ special characters. \n* Half-width or full-width characters."
|
|
type: object
|
|
mandate:
|
|
description: The mandate details to initiate recurring transaction.
|
|
$ref: '#/components/schemas/Mandate'
|
|
mcc:
|
|
description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code)
|
|
(MCC) is a four-digit number, which relates to a particular market segment.
|
|
This code reflects the predominant activity that is conducted by the merchant.
|
|
type: string
|
|
merchantAccount:
|
|
description: The merchant account identifier, with which you want to process
|
|
the transaction.
|
|
type: string
|
|
merchantOrderReference:
|
|
description: 'This reference allows linking multiple transactions to each
|
|
other for reporting purposes (i.e. order auth-rate). The reference should
|
|
be unique per billing cycle.
|
|
|
|
The same merchant order reference should never be reused after the first
|
|
authorised attempt. If used, this field should be supplied for all incoming
|
|
authorisations.
|
|
|
|
> We strongly recommend you send the `merchantOrderReference` value to
|
|
benefit from linking payment requests when authorisation retries take
|
|
place. In addition, we recommend you provide `retry.orderAttemptNumber`,
|
|
`retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
|
|
maxLength: 1000
|
|
type: string
|
|
merchantRiskIndicator:
|
|
x-addedInVersion: '40'
|
|
description: 'Additional risk fields for 3D Secure 2.
|
|
|
|
> For 3D Secure 2 transactions, we recommend that you include this object
|
|
to increase the chances of achieving a frictionless flow.'
|
|
$ref: '#/components/schemas/MerchantRiskIndicator'
|
|
metadata:
|
|
additionalProperties:
|
|
type: string
|
|
description: 'Metadata consists of entries, each of which includes a key
|
|
and a value.
|
|
|
|
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,
|
|
Visa Secure, or Cartes Bancaires).
|
|
$ref: '#/components/schemas/ThreeDSecureData'
|
|
order:
|
|
description: The order information required for partial payments.
|
|
$ref: '#/components/schemas/EncryptedOrderData'
|
|
orderReference:
|
|
description: When you are doing multiple partial (gift card) payments, this
|
|
is the `pspReference` of the first payment. We use this to link the multiple
|
|
payments to each other. As your own reference for linking multiple payments,
|
|
use the `merchantOrderReference`instead.
|
|
type: string
|
|
origin:
|
|
x-addedInVersion: '40'
|
|
description: 'Required for the 3D Secure 2 `channel` **Web** integration.
|
|
|
|
|
|
Set this parameter to the origin URL of the page that you are loading
|
|
the 3D Secure Component from.'
|
|
maxLength: 80
|
|
type: string
|
|
paymentMethod:
|
|
description: The type and required details of a payment method to use.
|
|
oneOf:
|
|
- $ref: '#/components/schemas/AchDetails'
|
|
- $ref: '#/components/schemas/AffirmDetails'
|
|
- $ref: '#/components/schemas/AfterpayDetails'
|
|
- $ref: '#/components/schemas/AmazonPayDetails'
|
|
- $ref: '#/components/schemas/AncvDetails'
|
|
- $ref: '#/components/schemas/AndroidPayDetails'
|
|
- $ref: '#/components/schemas/ApplePayDetails'
|
|
- $ref: '#/components/schemas/BacsDirectDebitDetails'
|
|
- $ref: '#/components/schemas/BillDeskDetails'
|
|
- $ref: '#/components/schemas/BlikDetails'
|
|
- $ref: '#/components/schemas/CardDetails'
|
|
- $ref: '#/components/schemas/CashAppDetails'
|
|
- $ref: '#/components/schemas/CellulantDetails'
|
|
- $ref: '#/components/schemas/DokuDetails'
|
|
- $ref: '#/components/schemas/DragonpayDetails'
|
|
- $ref: '#/components/schemas/EBankingFinlandDetails'
|
|
- $ref: '#/components/schemas/EcontextVoucherDetails'
|
|
- $ref: '#/components/schemas/EftDetails'
|
|
- $ref: '#/components/schemas/FastlaneDetails'
|
|
- $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails'
|
|
- $ref: '#/components/schemas/GooglePayDetails'
|
|
- $ref: '#/components/schemas/IdealDetails'
|
|
- $ref: '#/components/schemas/KlarnaDetails'
|
|
- $ref: '#/components/schemas/MasterpassDetails'
|
|
- $ref: '#/components/schemas/MbwayDetails'
|
|
- $ref: '#/components/schemas/MobilePayDetails'
|
|
- $ref: '#/components/schemas/MolPayDetails'
|
|
- $ref: '#/components/schemas/OpenInvoiceDetails'
|
|
- $ref: '#/components/schemas/PayByBankAISDirectDebitDetails'
|
|
- $ref: '#/components/schemas/PayByBankDetails'
|
|
- $ref: '#/components/schemas/PayPalDetails'
|
|
- $ref: '#/components/schemas/PayPayDetails'
|
|
- $ref: '#/components/schemas/PayToDetails'
|
|
- $ref: '#/components/schemas/PayUUpiDetails'
|
|
- $ref: '#/components/schemas/PayWithGoogleDetails'
|
|
- $ref: '#/components/schemas/PaymentDetails'
|
|
- $ref: '#/components/schemas/PixDetails'
|
|
- $ref: '#/components/schemas/PseDetails'
|
|
- $ref: '#/components/schemas/RakutenPayDetails'
|
|
- $ref: '#/components/schemas/RatepayDetails'
|
|
- $ref: '#/components/schemas/RivertyDetails'
|
|
- $ref: '#/components/schemas/SamsungPayDetails'
|
|
- $ref: '#/components/schemas/SepaDirectDebitDetails'
|
|
- $ref: '#/components/schemas/StoredPaymentMethodDetails'
|
|
- $ref: '#/components/schemas/TwintDetails'
|
|
- $ref: '#/components/schemas/UpiCollectDetails'
|
|
- $ref: '#/components/schemas/UpiIntentDetails'
|
|
- $ref: '#/components/schemas/VippsDetails'
|
|
- $ref: '#/components/schemas/VisaCheckoutDetails'
|
|
- $ref: '#/components/schemas/WeChatPayDetails'
|
|
- $ref: '#/components/schemas/WeChatPayMiniProgramDetails'
|
|
- $ref: '#/components/schemas/ZipDetails'
|
|
platformChargebackLogic:
|
|
x-addedInVersion: '68'
|
|
description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).
|
|
$ref: '#/components/schemas/PlatformChargebackLogic'
|
|
recurringExpiry:
|
|
description: Date after which no further authorisations shall be performed.
|
|
Only for 3D Secure 2.
|
|
type: string
|
|
recurringFrequency:
|
|
description: Minimum number of days between authorisations. Only for 3D
|
|
Secure 2.
|
|
type: string
|
|
recurringProcessingModel:
|
|
x-addedInVersion: '32'
|
|
description: "Defines a recurring payment type. Required when creating a\
|
|
\ token to store payment details or using stored payment details.\nAllowed\
|
|
\ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\
|
|
\ amount, which follows a fixed schedule.\n* `CardOnFile` \u2013 With\
|
|
\ a card-on-file (CoF) transaction, card details are stored to enable\
|
|
\ one-click or omnichannel journeys, or simply to streamline the checkout\
|
|
\ process. Any subscription not following a fixed schedule is also considered\
|
|
\ a card-on-file transaction.\n* `UnscheduledCardOnFile` \u2013 An unscheduled\
|
|
\ card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed\
|
|
\ schedule and/or have variable amounts. For example, automatic top-ups\
|
|
\ when a cardholder's balance drops below a certain amount.\n"
|
|
enum:
|
|
- CardOnFile
|
|
- Subscription
|
|
- UnscheduledCardOnFile
|
|
type: string
|
|
redirectFromIssuerMethod:
|
|
x-addedInVersion: '32'
|
|
description: Specifies the redirect method (GET or POST) when redirecting
|
|
back from the issuer.
|
|
type: string
|
|
redirectToIssuerMethod:
|
|
x-addedInVersion: '32'
|
|
description: Specifies the redirect method (GET or POST) when redirecting
|
|
to the issuer.
|
|
type: string
|
|
reference:
|
|
description: 'The reference to uniquely identify a payment. This reference
|
|
is used in all communication with you about the payment status. We recommend
|
|
using a unique value per payment; however, it is not a requirement.
|
|
|
|
If you need to provide multiple references for a transaction, separate
|
|
them with hyphens ("-").
|
|
|
|
Maximum length: 80 characters.'
|
|
type: string
|
|
returnUrl:
|
|
description: "The URL to return to in case of a redirection.\nThe format\
|
|
\ depends on the channel. \n* For web, include the protocol `http://`\
|
|
\ or `https://`. You can also include your own additional query parameters,\
|
|
\ for example, shopper ID or order reference number.\nExample: `https://your-company.example.com/checkout?shopperOrder=12xy`\n\
|
|
* For iOS, use the custom URL for your app. To know more about setting\
|
|
\ custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).\n\
|
|
Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\
|
|
\ on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).\n\
|
|
Example: `my-app://your.package.name`\n\nIf the URL to return to includes\
|
|
\ non-ASCII characters, like spaces or special letters, URL encode the\
|
|
\ value.\n> The URL must not include personally identifiable information\
|
|
\ (PII), for example name or email address."
|
|
type: string
|
|
riskData:
|
|
description: Contains risk data, such as client-side data, used to identify
|
|
risk for a transaction.
|
|
$ref: '#/components/schemas/RiskData'
|
|
sessionValidity:
|
|
description: 'The date and time until when the session remains valid, in
|
|
[ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
|
|
|
|
|
|
For example: 2020-07-18T15:42:40.428+01:00'
|
|
type: string
|
|
shopperConversionId:
|
|
description: A unique ID that can be used to associate `/paymentMethods`
|
|
and `/payments` requests with the same shopper transaction, offering insights
|
|
into conversion rates.
|
|
maxLength: 256
|
|
type: string
|
|
shopperEmail:
|
|
description: 'The shopper''s email address. We recommend that you provide
|
|
this data, as it is used in velocity fraud checks.
|
|
|
|
> For 3D Secure 2 transactions, schemes require `shopperEmail` for all
|
|
browser-based and mobile implementations.'
|
|
type: string
|
|
shopperIP:
|
|
description: 'The shopper''s IP address. In general, we recommend that you
|
|
provide this data, as it is used in a number of risk checks (for instance,
|
|
number of payment attempts or location-based checks).
|
|
|
|
> For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based
|
|
implementations.
|
|
|
|
This field is also mandatory for some merchants depending on your business
|
|
model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
|
|
maxLength: 1000
|
|
type: string
|
|
shopperInteraction:
|
|
description: 'Specifies the sales channel, through which the shopper gives
|
|
their card details, and whether the shopper is a returning customer.
|
|
|
|
For the web service API, Adyen assumes Ecommerce shopper interaction by
|
|
default.
|
|
|
|
|
|
This field has the following possible values:
|
|
|
|
* `Ecommerce` - Online transactions where the cardholder is present (online).
|
|
For better authorisation rates, we recommend sending the card security
|
|
code (CSC) along with the request.
|
|
|
|
* `ContAuth` - Card on file and/or subscription transactions, where the
|
|
cardholder is known to the merchant (returning customer). If the shopper
|
|
is present (online), you can supply also the CSC to improve authorisation
|
|
(one-click payment).
|
|
|
|
* `Moto` - Mail-order and telephone-order transactions where the shopper
|
|
is in contact with the merchant via email or telephone.
|
|
|
|
* `POS` - Point-of-sale transactions where the shopper is physically present
|
|
to make a payment using a secure payment terminal.'
|
|
enum:
|
|
- Ecommerce
|
|
- ContAuth
|
|
- Moto
|
|
- POS
|
|
type: string
|
|
shopperLocale:
|
|
description: The combination of a language code and a country code to specify
|
|
the language to be used in the payment.
|
|
type: string
|
|
shopperName:
|
|
description: The shopper's full name.
|
|
$ref: '#/components/schemas/Name'
|
|
shopperReference:
|
|
description: "Required for recurring payments. \nYour reference to uniquely\
|
|
\ identify this shopper, for example user ID or account ID. Minimum length:\
|
|
\ 3 characters.\n> Your reference must not include personally identifiable\
|
|
\ information (PII), for example name or email address."
|
|
maxLength: 256
|
|
minLength: 3
|
|
type: string
|
|
shopperStatement:
|
|
description: "The text to be shown on the shopper's bank statement.\n We\
|
|
\ recommend sending a maximum of 22 characters, otherwise banks might\
|
|
\ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
|
|
\ spaces, and special characters **. , ' _ - ? + * /**."
|
|
maxLength: 10000
|
|
type: string
|
|
socialSecurityNumber:
|
|
description: The shopper's social security number.
|
|
type: string
|
|
splits:
|
|
x-addedInVersion: '37'
|
|
description: An array of objects specifying how to split a payment when
|
|
using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information),
|
|
[Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information),
|
|
or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
|
|
items:
|
|
$ref: '#/components/schemas/Split'
|
|
type: array
|
|
store:
|
|
description: Required for Adyen for Platforms integrations if you are a
|
|
platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference)
|
|
(on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference)
|
|
(in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store))
|
|
for the ecommerce or point-of-sale store that is processing the payment.
|
|
maxLength: 64
|
|
minLength: 1
|
|
type: string
|
|
storePaymentMethod:
|
|
x-addedInVersion: '49'
|
|
description: When true and `shopperReference` is provided, the payment details
|
|
will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
|
|
type: boolean
|
|
subMerchants:
|
|
description: This field contains additional information on the submerchant,
|
|
who is onboarded to an acquirer through a payment facilitator or aggregator
|
|
items:
|
|
$ref: '#/components/schemas/SubMerchantInfo'
|
|
type: array
|
|
telephoneNumber:
|
|
description: The shopper's telephone number.
|
|
type: string
|
|
threeDS2RequestData:
|
|
x-addedInVersion: '40'
|
|
description: Request fields for 3D Secure 2. To check if any of the following
|
|
fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments)
|
|
or [Classic integration](https://docs.adyen.com/classic-integration) documentation.
|
|
$ref: '#/components/schemas/ThreeDS2RequestFields'
|
|
threeDSAuthenticationOnly:
|
|
x-addedInVersion: '50'
|
|
deprecated: true
|
|
x-deprecatedInVersion: '69'
|
|
x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
|
|
default: false
|
|
description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
|
|
and not the payment authorisation.
|
|
type: boolean
|
|
trustedShopper:
|
|
x-addedInVersion: '37'
|
|
description: Set to true if the payment should be routed to a trusted MID.
|
|
type: boolean
|
|
required:
|
|
- merchantAccount
|
|
- reference
|
|
- amount
|
|
- paymentMethod
|
|
- returnUrl
|
|
type: object
|
|
PaymentResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
action:
|
|
x-addedInVersion: '49'
|
|
description: Action to be taken for completing the payment.
|
|
oneOf:
|
|
- $ref: '#/components/schemas/CheckoutAwaitAction'
|
|
- $ref: '#/components/schemas/CheckoutBankTransferAction'
|
|
- $ref: '#/components/schemas/CheckoutDelegatedAuthenticationAction'
|
|
- $ref: '#/components/schemas/CheckoutNativeRedirectAction'
|
|
- $ref: '#/components/schemas/CheckoutQrCodeAction'
|
|
- $ref: '#/components/schemas/CheckoutRedirectAction'
|
|
- $ref: '#/components/schemas/CheckoutSDKAction'
|
|
- $ref: '#/components/schemas/CheckoutThreeDS2Action'
|
|
- $ref: '#/components/schemas/CheckoutVoucherAction'
|
|
additionalData:
|
|
additionalProperties:
|
|
type: string
|
|
x-anyOf:
|
|
- $ref: '#/components/schemas/ResponseAdditionalData3DSecure'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataCard'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataCommon'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataDomesticError'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataOpi'
|
|
- $ref: '#/components/schemas/ResponseAdditionalDataSepa'
|
|
description: 'Contains additional information about the payment. Some data
|
|
fields are included only if you select them first: Go to **Customer Area**
|
|
> **Developers** > **Additional data**.'
|
|
type: object
|
|
amount:
|
|
x-addedInVersion: '52'
|
|
description: Authorised amount in the transaction.
|
|
$ref: '#/components/schemas/Amount'
|
|
donationToken:
|
|
x-addedInVersion: '66'
|
|
description: Donation Token containing payment details for Adyen Giving.
|
|
type: string
|
|
fraudResult:
|
|
description: The fraud result properties of the payment.
|
|
$ref: '#/components/schemas/FraudResult'
|
|
merchantReference:
|
|
x-addedInVersion: '49'
|
|
description: 'The reference to uniquely identify a payment. This reference
|
|
is used in all communication with you about the payment status. We recommend
|
|
using a unique value per payment; however, it is not a requirement.
|
|
|
|
If you need to provide multiple references for a transaction, separate
|
|
them with hyphens ("-").
|
|
|
|
Maximum length: 80 characters.'
|
|
type: string
|
|
order:
|
|
description: Contains updated information regarding the order in case order
|
|
information was provided in the request.
|
|
$ref: '#/components/schemas/CheckoutOrderResponse'
|
|
paymentMethod:
|
|
x-addedInVersion: '69'
|
|
description: "Details about the payment method used in the transaction.\
|
|
\ \nOnly returned if `resultCode` is **Authorised**."
|
|
$ref: '#/components/schemas/ResponsePaymentMethod'
|
|
pspReference:
|
|
description: 'Adyen''s 16-character string reference associated with the
|
|
transaction/request. This value is globally unique; quote it when communicating
|
|
with us about this request.
|
|
|
|
|
|
> For payment methods that require a redirect or additional action, you
|
|
will get this value in the `/payments/details` response.'
|
|
type: string
|
|
refusalReason:
|
|
description: 'If the payment''s authorisation is refused or an error occurs
|
|
during authorisation, this field holds Adyen''s mapped reason for the
|
|
refusal or a description of the error. When a transaction fails, the authorisation
|
|
response includes `resultCode` and `refusalReason` values.
|
|
|
|
|
|
For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).'
|
|
type: string
|
|
refusalReasonCode:
|
|
x-addedInVersion: '37'
|
|
description: Code that specifies the refusal reason. For more information,
|
|
see [Authorisation 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* **PartiallyAuthorised** \u2013 The payment\
|
|
\ has been authorised for a partial amount.\nThis happens for card payments\
|
|
\ when the merchant supports Partial Authorisations and the cardholder\
|
|
\ has insufficient funds.\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."
|
|
enum:
|
|
- AuthenticationFinished
|
|
- AuthenticationNotRequired
|
|
- Authorised
|
|
- Cancelled
|
|
- ChallengeShopper
|
|
- Error
|
|
- IdentifyShopper
|
|
- PartiallyAuthorised
|
|
- Pending
|
|
- PresentToShopper
|
|
- Received
|
|
- RedirectShopper
|
|
- Refused
|
|
- Success
|
|
type: string
|
|
threeDS2ResponseData:
|
|
x-addedInVersion: '67'
|
|
description: Response of the 3D Secure 2 authentication.
|
|
$ref: '#/components/schemas/ThreeDS2ResponseData'
|
|
threeDS2Result:
|
|
x-addedInVersion: '41'
|
|
description: Result of the 3D Secure 2 authentication.
|
|
$ref: '#/components/schemas/ThreeDS2Result'
|
|
threeDSPaymentData:
|
|
x-addedInVersion: '67'
|
|
description: When non-empty, contains a value that you must submit to the
|
|
`/payments/details` endpoint as `paymentData`.
|
|
type: string
|
|
type: object
|
|
PaymentReversalRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
applicationInfo:
|
|
description: Information about your application. For more details, see [Building
|
|
Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
|
|
$ref: '#/components/schemas/ApplicationInfo'
|
|
merchantAccount:
|
|
description: The merchant account that is used to process the payment.
|
|
type: string
|
|
reference:
|
|
description: 'Your reference for the reversal request. Maximum length: 80
|
|
characters.'
|
|
type: string
|
|
required:
|
|
- merchantAccount
|
|
type: object
|
|
PaymentReversalResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
merchantAccount:
|
|
description: The merchant account that is used to process the payment.
|
|
type: string
|
|
paymentPspReference:
|
|
description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
|
|
of the payment to reverse. '
|
|
type: string
|
|
pspReference:
|
|
description: Adyen's 16-character reference associated with the reversal
|
|
request.
|
|
type: string
|
|
reference:
|
|
description: Your reference for the reversal request.
|
|
type: string
|
|
status:
|
|
description: The status of your request. This will always have the value
|
|
**received**.
|
|
enum:
|
|
- received
|
|
type: string
|
|
required:
|
|
- status
|
|
- merchantAccount
|
|
- pspReference
|
|
- paymentPspReference
|
|
type: object
|
|
PaypalUpdateOrderRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
amount:
|
|
description: The updated final payment amount. This amount is the item total
|
|
plus the shipping costs of the selected `deliveryMethod`.
|
|
$ref: '#/components/schemas/Amount'
|
|
deliveryMethods:
|
|
description: The list of new delivery methods and the cost of each.
|
|
items:
|
|
$ref: '#/components/schemas/DeliveryMethod'
|
|
type: array
|
|
paymentData:
|
|
description: The `paymentData` from the client side. This value changes
|
|
every time you make a `/paypal/updateOrder` request.
|
|
type: string
|
|
pspReference:
|
|
description: The original `pspReference` from the `/payments` response.
|
|
type: string
|
|
sessionId:
|
|
description: The original `sessionId` from the `/sessions` response.
|
|
type: string
|
|
taxTotal:
|
|
description: 'Total tax amount from the order. '
|
|
$ref: '#/components/schemas/TaxTotal'
|
|
type: object
|
|
PaypalUpdateOrderResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
paymentData:
|
|
description: The updated paymentData.
|
|
type: string
|
|
status:
|
|
description: The status of the request. This indicates whether the order
|
|
was successfully updated with PayPal.
|
|
enum:
|
|
- error
|
|
- success
|
|
type: string
|
|
required:
|
|
- paymentData
|
|
- status
|
|
type: object
|
|
Phone:
|
|
additionalProperties: false
|
|
properties:
|
|
cc:
|
|
description: "Country code. Length: 1\u20133 characters."
|
|
maxLength: 3
|
|
minLength: 1
|
|
type: string
|
|
subscriber:
|
|
description: 'Subscriber number. Maximum length: 15 characters.'
|
|
maxLength: 15
|
|
type: string
|
|
type: object
|
|
PixDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
pixRecurring:
|
|
$ref: '#/components/schemas/PixRecurring'
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
description: The payment method type.
|
|
enum:
|
|
- pix
|
|
type: string
|
|
title: Stored Payment Method
|
|
type: object
|
|
PixRecurring:
|
|
additionalProperties: false
|
|
properties:
|
|
billingDate:
|
|
description: The date on which the shopper's payment method will be charged,
|
|
in YYYY-MM-DD format.
|
|
type: string
|
|
endsAt:
|
|
description: End date of the billing plan, in YYYY-MM-DD format. The end
|
|
date must align with the frequency and the start date of the billing plan.
|
|
If left blank, the subscription will continue indefinitely unless it is
|
|
cancelled by the shopper.
|
|
type: string
|
|
frequency:
|
|
description: The frequency at which the shopper will be charged.
|
|
enum:
|
|
- weekly
|
|
- monthly
|
|
- quarterly
|
|
- half-yearly
|
|
- yearly
|
|
type: string
|
|
minAmount:
|
|
description: For a billing plan where the payment amounts are variable,
|
|
the minimum amount to charge the shopper for each recurring payment. When
|
|
a shopper approves the billing plan, they can also specify a maximum amount
|
|
in their banking app.
|
|
$ref: '#/components/schemas/Amount'
|
|
originalPspReference:
|
|
description: The pspReference for the failed recurring payment. Find this
|
|
in AUTHORISATION webhook you received after the billing date.
|
|
type: string
|
|
recurringAmount:
|
|
description: For a billing plan where the payment amount is fixed, the amount
|
|
the shopper will be charged for each recurring payment.
|
|
$ref: '#/components/schemas/Amount'
|
|
recurringStatement:
|
|
description: 'The text that that will be shown on the shopper''s bank statement
|
|
for the recurring payments. We recommend to add a descriptive text about
|
|
the subscription to let your shoppers recognize your recurring payments.
|
|
|
|
Maximum length: 35 characters.'
|
|
type: string
|
|
retryPolicy:
|
|
description: When set to true, you can retry for failed recurring payments.
|
|
The default value is true.
|
|
type: boolean
|
|
startsAt:
|
|
description: Start date of the billing plan, in YYYY-MM-DD format. The default
|
|
value is the transaction date.
|
|
type: string
|
|
title: pixRecurring
|
|
type: object
|
|
PlatformChargebackLogic:
|
|
additionalProperties: false
|
|
properties:
|
|
behavior:
|
|
description: 'The method of handling the chargeback.
|
|
|
|
|
|
Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**,
|
|
**deductAccordingToSplitRatio**.'
|
|
enum:
|
|
- deductAccordingToSplitRatio
|
|
- deductFromLiableAccount
|
|
- deductFromOneBalanceAccount
|
|
type: string
|
|
costAllocationAccount:
|
|
description: The unique identifier of the balance account to which the chargeback
|
|
fees are booked. By default, the chargeback fees are booked to your liable
|
|
balance account.
|
|
type: string
|
|
targetAccount:
|
|
description: 'The unique identifier of the balance account against which
|
|
the disputed amount is booked.
|
|
|
|
|
|
Required if `behavior` is **deductFromOneBalanceAccount**.'
|
|
type: string
|
|
type: object
|
|
PseDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
bank:
|
|
description: The shopper's bank.
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
clientType:
|
|
description: The client type.
|
|
type: string
|
|
identification:
|
|
description: The identification code.
|
|
type: string
|
|
identificationType:
|
|
description: The identification type.
|
|
type: string
|
|
type:
|
|
description: The payment method type.
|
|
enum:
|
|
- pse_payulatam
|
|
type: string
|
|
required:
|
|
- bank
|
|
- clientType
|
|
- identificationType
|
|
- identification
|
|
title: PSE Latam
|
|
type: object
|
|
RakutenPayDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: rakutenpay
|
|
description: '**rakutenpay**'
|
|
enum:
|
|
- rakutenpay
|
|
type: string
|
|
title: RakutenPay
|
|
type: object
|
|
RatepayDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
billingAddress:
|
|
description: The address where to send the invoice.
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
deliveryAddress:
|
|
description: The address where the goods should be delivered.
|
|
type: string
|
|
personalDetails:
|
|
description: Shopper name, date of birth, phone number, and email address.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: ratepay
|
|
description: '**ratepay**'
|
|
enum:
|
|
- ratepay
|
|
- ratepay_directdebit
|
|
type: string
|
|
required:
|
|
- type
|
|
title: Ratepay
|
|
type: object
|
|
Recurring:
|
|
additionalProperties: false
|
|
properties:
|
|
contract:
|
|
description: "The type of recurring contract to be used.\nPossible values:\n\
|
|
* `ONECLICK` \u2013 Payment details can be used to initiate a one-click\
|
|
\ payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n\
|
|
* `RECURRING` \u2013 Payment details can be used without the card security\
|
|
\ code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n\
|
|
* `ONECLICK,RECURRING` \u2013 Payment details can be used regardless of\
|
|
\ whether the shopper is on your site or not.\n* `PAYOUT` \u2013 Payment\
|
|
\ details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts)."
|
|
enum:
|
|
- ONECLICK
|
|
- RECURRING
|
|
- PAYOUT
|
|
type: string
|
|
recurringDetailName:
|
|
description: A descriptive name for this detail.
|
|
type: string
|
|
recurringExpiry:
|
|
x-addedInVersion: '40'
|
|
description: Date after which no further authorisations shall be performed.
|
|
Only for 3D Secure 2.
|
|
format: date-time
|
|
type: string
|
|
recurringFrequency:
|
|
x-addedInVersion: '40'
|
|
description: Minimum number of days between authorisations. Only for 3D
|
|
Secure 2.
|
|
type: string
|
|
tokenService:
|
|
x-addedInVersion: '25'
|
|
description: The name of the token service.
|
|
enum:
|
|
- VISATOKENSERVICE
|
|
- MCTOKENSERVICE
|
|
- AMEXTOKENSERVICE
|
|
- TOKEN_SHARING
|
|
type: string
|
|
type: object
|
|
ResponseAdditionalData3DSecure:
|
|
additionalProperties: false
|
|
properties:
|
|
cardHolderInfo:
|
|
description: 'Information provided by the issuer to the cardholder. If this
|
|
field is present, you need to display this information to the cardholder. '
|
|
type: string
|
|
cavv:
|
|
description: The Cardholder Authentication Verification Value (CAVV) for
|
|
the 3D Secure authentication session, as a Base64-encoded 20-byte array.
|
|
type: string
|
|
cavvAlgorithm:
|
|
description: The CAVV algorithm used.
|
|
type: string
|
|
scaExemptionRequested:
|
|
description: "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\
|
|
\ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\
|
|
\ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** "
|
|
type: string
|
|
threeds2.cardEnrolled:
|
|
description: Indicates whether a card is enrolled for 3D Secure 2.
|
|
type: boolean
|
|
type: object
|
|
ResponseAdditionalDataBillingAddress:
|
|
additionalProperties: false
|
|
properties:
|
|
billingAddress.city:
|
|
description: The billing address city passed in the payment request.
|
|
type: string
|
|
billingAddress.country:
|
|
description: 'The billing address country passed in the payment request.
|
|
|
|
|
|
Example: NL'
|
|
type: string
|
|
billingAddress.houseNumberOrName:
|
|
description: The billing address house number or name passed in the payment
|
|
request.
|
|
type: string
|
|
billingAddress.postalCode:
|
|
description: 'The billing address postal code passed in the payment request.
|
|
|
|
|
|
Example: 1011 DJ'
|
|
type: string
|
|
billingAddress.stateOrProvince:
|
|
description: 'The billing address state or province passed in the payment
|
|
request.
|
|
|
|
|
|
Example: NH'
|
|
type: string
|
|
billingAddress.street:
|
|
description: The billing address street passed in the payment request.
|
|
type: string
|
|
type: object
|
|
ResponseAdditionalDataCard:
|
|
additionalProperties: false
|
|
properties:
|
|
cardBin:
|
|
description: 'The first six digits of the card number.
|
|
|
|
|
|
This is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin)
|
|
for card numbers with a six-digit BIN.
|
|
|
|
|
|
Example: 521234'
|
|
type: string
|
|
cardHolderName:
|
|
description: The cardholder name passed in the payment request.
|
|
type: string
|
|
cardIssuingBank:
|
|
description: The bank or the financial institution granting lines of credit
|
|
through card association branded payment cards. This information can be
|
|
included when available.
|
|
type: string
|
|
cardIssuingCountry:
|
|
description: 'The country where the card was issued.
|
|
|
|
|
|
Example: US'
|
|
type: string
|
|
cardIssuingCurrency:
|
|
description: "The currency in which the card is issued, if this information\
|
|
\ is available. Provided as the currency code or currency number from\
|
|
\ the ISO-4217 standard. \n\nExample: USD"
|
|
type: string
|
|
cardPaymentMethod:
|
|
description: 'The card payment method used for the transaction.
|
|
|
|
|
|
Example: amex'
|
|
type: string
|
|
cardProductId:
|
|
description: 'The Card Product ID represents the type of card following
|
|
card scheme product definitions and can be returned for Adyen Acquiring
|
|
service level payments.
|
|
|
|
|
|
Possible values Visa:
|
|
|
|
* **A** - Visa Traditional
|
|
|
|
* **B** - Visa Traditional Rewards
|
|
|
|
* **C** - Visa Signature
|
|
|
|
* **D** - Visa Signature Preferred
|
|
|
|
* **F** - Visa Classic
|
|
|
|
|
|
Possible values Mastercard:
|
|
|
|
* **MCC** - Mastercard Card
|
|
|
|
* **MCE** - Mastercard Electronic Card
|
|
|
|
* **MCF** - Mastercard Corporate Fleet Card
|
|
|
|
* **MCG** - Gold Mastercard Card
|
|
|
|
* **MCH** - Mastercard Premium Charge
|
|
|
|
* **MCI** - Mastercard Select Debit
|
|
|
|
'
|
|
enum:
|
|
- A
|
|
- B
|
|
- C
|
|
- D
|
|
- F
|
|
- MCC
|
|
- MCE
|
|
- MCF
|
|
- MCG
|
|
- MCH
|
|
- MCI
|
|
type: string
|
|
cardSummary:
|
|
description: 'The last four digits of a card number.
|
|
|
|
|
|
> Returned only in case of a card payment.'
|
|
type: string
|
|
issuerBin:
|
|
description: 'The first eight digits of the card number. Only returned if
|
|
the card number is 16 digits or more.
|
|
|
|
|
|
This is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin)
|
|
for card numbers with an eight-digit BIN.
|
|
|
|
|
|
Example: 52123423'
|
|
type: string
|
|
type: object
|
|
ResponseAdditionalDataCommon:
|
|
additionalProperties: false
|
|
properties:
|
|
acquirerAccountCode:
|
|
description: 'The name of the Adyen acquirer account.
|
|
|
|
|
|
Example: PayPalSandbox_TestAcquirer
|
|
|
|
|
|
> Only relevant for PayPal transactions.'
|
|
type: string
|
|
acquirerCode:
|
|
description: 'The name of the acquirer processing the payment request.
|
|
|
|
|
|
Example: TestPmmAcquirer'
|
|
type: string
|
|
acquirerReference:
|
|
description: 'The reference number that can be used for reconciliation in
|
|
case a non-Adyen acquirer is used for settlement.
|
|
|
|
|
|
Example: 7C9N3FNBKT9'
|
|
type: string
|
|
alias:
|
|
description: 'The Adyen alias of the card.
|
|
|
|
|
|
Example: H167852639363479'
|
|
type: string
|
|
aliasType:
|
|
description: 'The type of the card alias.
|
|
|
|
|
|
Example: Default'
|
|
type: string
|
|
authCode:
|
|
description: 'Authorisation code:
|
|
|
|
* When the payment is authorised successfully, this field holds the authorisation
|
|
code for the payment.
|
|
|
|
* When the payment is not authorised, this field is empty.
|
|
|
|
|
|
Example: 58747'
|
|
type: string
|
|
authorisationMid:
|
|
description: Merchant ID known by the acquirer.
|
|
type: string
|
|
authorisedAmountCurrency:
|
|
description: The currency of the authorised amount, as a three-character
|
|
[ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
|
|
type: string
|
|
authorisedAmountValue:
|
|
description: 'Value of the amount authorised.
|
|
|
|
|
|
This amount is represented in minor units according to the [following
|
|
table](https://docs.adyen.com/development-resources/currency-codes).'
|
|
type: string
|
|
avsResult:
|
|
description: 'The AVS result code of the payment, which provides information
|
|
about the outcome of the AVS check.
|
|
|
|
|
|
For possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs).'
|
|
type: string
|
|
avsResultRaw:
|
|
description: 'Raw AVS result received from the acquirer, where available.
|
|
|
|
|
|
Example: D'
|
|
type: string
|
|
bic:
|
|
description: 'BIC of a bank account.
|
|
|
|
|
|
Example: TESTNL01
|
|
|
|
|
|
> Only relevant for SEPA Direct Debit transactions.'
|
|
type: string
|
|
coBrandedWith:
|
|
description: Includes the co-branded card information.
|
|
type: string
|
|
cvcResult:
|
|
description: The result of CVC verification.
|
|
example: 1 Matches
|
|
type: string
|
|
cvcResultRaw:
|
|
description: The raw result of CVC verification.
|
|
example: M
|
|
type: string
|
|
dsTransID:
|
|
description: Supported for 3D Secure 2. The unique transaction identifier
|
|
assigned by the DS to identify a single transaction.
|
|
type: string
|
|
eci:
|
|
description: 'The Electronic Commerce Indicator returned from the schemes
|
|
for the 3DS payment session.
|
|
|
|
|
|
Example: 02'
|
|
type: string
|
|
expiryDate:
|
|
description: 'The expiry date on the card.
|
|
|
|
|
|
Example: 6/2016
|
|
|
|
|
|
> Returned only in case of a card payment.'
|
|
type: string
|
|
extraCostsCurrency:
|
|
description: 'The currency of the extra amount charged due to additional
|
|
amounts set in the skin used in the HPP payment request.
|
|
|
|
|
|
Example: EUR'
|
|
type: string
|
|
extraCostsValue:
|
|
description: The value of the extra amount charged due to additional amounts
|
|
set in the skin used in the HPP payment request. The amount is in minor
|
|
units.
|
|
type: string
|
|
fraudCheck-[itemNr]-[FraudCheckname]:
|
|
description: The fraud score due to a particular fraud check. The fraud
|
|
check name is found in the key of the key-value pair.
|
|
type: string
|
|
fraudManualReview:
|
|
description: Indicates if the payment is sent to manual review.
|
|
type: string
|
|
fraudResultType:
|
|
description: The fraud result properties of the payment.
|
|
enum:
|
|
- GREEN
|
|
- FRAUD
|
|
type: string
|
|
fraudRiskLevel:
|
|
description: The risk level of the payment as determined by the FDM machine
|
|
learning model.
|
|
enum:
|
|
- Very low
|
|
- Low
|
|
- Medium
|
|
- High
|
|
- Very high
|
|
type: string
|
|
fundingSource:
|
|
description: 'Information regarding the funding type of the card. The possible
|
|
return values are:
|
|
|
|
* CHARGE
|
|
|
|
* CREDIT
|
|
|
|
* DEBIT
|
|
|
|
* PREPAID
|
|
|
|
* PREPAID_RELOADABLE
|
|
|
|
|
|
* PREPAID_NONRELOADABLE
|
|
|
|
* DEFFERED_DEBIT
|
|
|
|
|
|
> This functionality requires additional configuration on Adyen''s end.
|
|
To enable it, contact the Support Team.
|
|
|
|
|
|
For receiving this field in the notification, enable **Include Funding
|
|
Source** in **Notifications** > **Additional settings**.'
|
|
type: string
|
|
fundsAvailability:
|
|
description: 'Indicates availability of funds.
|
|
|
|
|
|
Visa:
|
|
|
|
* "I" (fast funds are supported)
|
|
|
|
* "N" (otherwise)
|
|
|
|
|
|
Mastercard:
|
|
|
|
* "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM
|
|
list)
|
|
|
|
* "N" (otherwise)
|
|
|
|
|
|
> Returned when you verify a card BIN or estimate costs, and only if payoutEligible
|
|
is "Y" or "D".'
|
|
type: string
|
|
inferredRefusalReason:
|
|
description: 'Provides the more granular indication of why a transaction
|
|
was refused. When a transaction fails with either "Refused", "Restricted
|
|
Card", "Transaction Not Permitted", "Not supported" or "DeclinedNon Generic"
|
|
refusalReason from the issuer, Adyen cross references its PSP-wide data
|
|
for extra insight into the refusal reason. If an inferred refusal reason
|
|
is available, the `inferredRefusalReason`, field is populated and the
|
|
`refusalReason`, is set to "Not Supported".
|
|
|
|
|
|
Possible values:
|
|
|
|
|
|
* 3D Secure Mandated
|
|
|
|
* Closed Account
|
|
|
|
* ContAuth Not Supported
|
|
|
|
* CVC Mandated
|
|
|
|
* Ecommerce Not Allowed
|
|
|
|
* Crossborder Not Supported
|
|
|
|
* Card Updated
|
|
|
|
|
|
* Low Authrate Bin
|
|
|
|
* Non-reloadable prepaid card'
|
|
type: string
|
|
isCardCommercial:
|
|
description: Indicates if the card is used for business purposes only.
|
|
type: string
|
|
issuerCountry:
|
|
description: 'The issuing country of the card based on the BIN list that
|
|
Adyen maintains.
|
|
|
|
|
|
Example: JP'
|
|
type: string
|
|
liabilityShift:
|
|
description: A Boolean value indicating whether a liability shift was offered
|
|
for this payment.
|
|
type: string
|
|
mcBankNetReferenceNumber:
|
|
description: 'The `mcBankNetReferenceNumber`, is a minimum of six characters
|
|
and a maximum of nine characters long.
|
|
|
|
|
|
> Contact Support Team to enable this field.'
|
|
type: string
|
|
merchantAdviceCode:
|
|
description: 'The Merchant Advice Code (MAC) can be returned by Mastercard
|
|
issuers for refused payments. If present, the MAC contains information
|
|
about why the payment failed, and whether it can be retried.
|
|
|
|
|
|
For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).'
|
|
type: string
|
|
merchantReference:
|
|
description: The reference provided for the transaction.
|
|
type: string
|
|
networkTxReference:
|
|
description: 'Returned in the response if you are not tokenizing with Adyen
|
|
and are using the Merchant-initiated transactions (MIT) framework from
|
|
Mastercard or Visa.
|
|
|
|
|
|
This contains either the Mastercard Trace ID or the Visa Transaction ID.'
|
|
type: string
|
|
ownerName:
|
|
description: 'The owner name of a bank account.
|
|
|
|
|
|
Only relevant for SEPA Direct Debit transactions.'
|
|
type: string
|
|
paymentAccountReference:
|
|
description: The Payment Account Reference (PAR) value links a network token
|
|
with the underlying primary account number (PAN). The PAR value consists
|
|
of 29 uppercase alphanumeric characters.
|
|
type: string
|
|
paymentMethod:
|
|
description: The payment method used in the transaction.
|
|
type: string
|
|
paymentMethodVariant:
|
|
description: 'The Adyen sub-variant of the payment method used for the payment
|
|
request.
|
|
|
|
|
|
For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).
|
|
|
|
|
|
Example: mcpro'
|
|
type: string
|
|
payoutEligible:
|
|
description: 'Indicates whether a payout is eligible or not for this card.
|
|
|
|
|
|
Visa:
|
|
|
|
* "Y"
|
|
|
|
* "N"
|
|
|
|
|
|
Mastercard:
|
|
|
|
* "Y" (domestic and cross-border)
|
|
|
|
|
|
* "D" (only domestic)
|
|
|
|
* "N" (no MoneySend)
|
|
|
|
* "U" (unknown)'
|
|
type: string
|
|
realtimeAccountUpdaterStatus:
|
|
description: 'The response code from the Real Time Account Updater service.
|
|
|
|
|
|
Possible return values are:
|
|
|
|
* CardChanged
|
|
|
|
* CardExpiryChanged
|
|
|
|
* CloseAccount
|
|
|
|
|
|
* ContactCardAccountHolder'
|
|
type: string
|
|
receiptFreeText:
|
|
description: Message to be displayed on the terminal.
|
|
type: string
|
|
recurring.contractTypes:
|
|
x-addedInVersion: '40'
|
|
description: The recurring contract types applicable to the transaction.
|
|
type: string
|
|
recurring.firstPspReference:
|
|
description: 'The `pspReference`, of the first recurring payment that created
|
|
the recurring detail.
|
|
|
|
|
|
This functionality requires additional configuration on Adyen''s end.
|
|
To enable it, contact the Support Team.'
|
|
type: string
|
|
recurring.recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '68'
|
|
x-deprecatedMessage: Use tokenization.storedPaymentMethodId instead.
|
|
description: The reference that uniquely identifies the recurring transaction.
|
|
type: string
|
|
recurring.shopperReference:
|
|
x-addedInVersion: '40'
|
|
deprecated: true
|
|
x-deprecatedInVersion: '68'
|
|
x-deprecatedMessage: Use tokenization.shopperReference instead.
|
|
description: The provided reference of the shopper for a recurring transaction.
|
|
type: string
|
|
recurringProcessingModel:
|
|
x-addedInVersion: '40'
|
|
description: The processing model used for the recurring transaction.
|
|
enum:
|
|
- CardOnFile
|
|
- Subscription
|
|
- UnscheduledCardOnFile
|
|
type: string
|
|
referred:
|
|
description: 'If the payment is referred, this field is set to true.
|
|
|
|
|
|
This field is unavailable if the payment is referred and is usually not
|
|
returned with ecommerce transactions.
|
|
|
|
|
|
Example: true'
|
|
type: string
|
|
refusalReasonRaw:
|
|
description: 'Raw refusal reason received from the acquirer, where available.
|
|
|
|
|
|
Example: AUTHORISED'
|
|
type: string
|
|
requestAmount:
|
|
description: The amount of the payment request.
|
|
type: string
|
|
requestCurrencyCode:
|
|
description: The currency of the payment request.
|
|
type: string
|
|
shopperInteraction:
|
|
description: 'The shopper interaction type of the payment request.
|
|
|
|
|
|
Example: Ecommerce'
|
|
type: string
|
|
shopperReference:
|
|
description: 'The shopperReference passed in the payment request.
|
|
|
|
|
|
Example: AdyenTestShopperXX'
|
|
type: string
|
|
terminalId:
|
|
description: 'The terminal ID used in a point-of-sale payment.
|
|
|
|
|
|
Example: 06022622'
|
|
type: string
|
|
threeDAuthenticated:
|
|
description: 'A Boolean value indicating whether 3DS authentication was
|
|
completed on this payment.
|
|
|
|
|
|
Example: true'
|
|
type: string
|
|
threeDAuthenticatedResponse:
|
|
description: 'The raw 3DS authentication result from the card issuer.
|
|
|
|
|
|
Example: N'
|
|
type: string
|
|
threeDOffered:
|
|
description: 'A Boolean value indicating whether 3DS was offered for this
|
|
payment.
|
|
|
|
|
|
Example: true'
|
|
type: string
|
|
threeDOfferedResponse:
|
|
description: 'The raw enrollment result from the 3DS directory services
|
|
of the card schemes.
|
|
|
|
|
|
Example: Y'
|
|
type: string
|
|
threeDSVersion:
|
|
description: The 3D Secure 2 version.
|
|
type: string
|
|
tokenization.shopperReference:
|
|
description: The reference for the shopper that you sent when tokenizing
|
|
the payment details.
|
|
type: string
|
|
tokenization.store.operationType:
|
|
description: 'The operation performed on the token. Possible values:
|
|
|
|
|
|
* **created**: the token has been created.
|
|
|
|
* **updated**: the existing token has been updated.
|
|
|
|
* **alreadyExisting**: the details have already been stored.
|
|
|
|
'
|
|
enum:
|
|
- created
|
|
- updated
|
|
- alreadyExisting
|
|
type: string
|
|
tokenization.storedPaymentMethodId:
|
|
description: The reference that uniquely identifies tokenized payment details.
|
|
type: string
|
|
visaTransactionId:
|
|
description: 'The `visaTransactionId`, has a fixed length of 15 numeric
|
|
characters.
|
|
|
|
|
|
> Contact Support Team to enable this field.'
|
|
type: string
|
|
xid:
|
|
description: "The 3DS transaction ID of the 3DS session sent in notifications.\
|
|
\ The value is Base64-encoded and is returned for transactions with directoryResponse\
|
|
\ 'N' or 'Y'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA="
|
|
type: string
|
|
type: object
|
|
ResponseAdditionalDataDomesticError:
|
|
additionalProperties: false
|
|
properties:
|
|
domesticRefusalReasonRaw:
|
|
description: "The reason the transaction was declined, given by the local\
|
|
\ issuer. \nCurrently available for merchants in Japan."
|
|
type: string
|
|
domesticShopperAdvice:
|
|
description: "The action the shopper should take, in a local language. \n\
|
|
Currently available in Japanese, for merchants in Japan."
|
|
type: string
|
|
type: object
|
|
ResponseAdditionalDataInstallments:
|
|
additionalProperties: false
|
|
properties:
|
|
installmentPaymentData.installmentType:
|
|
description: Type of installment. The value of `installmentType` should
|
|
be **IssuerFinanced**.
|
|
type: string
|
|
installmentPaymentData.option[itemNr].annualPercentageRate:
|
|
description: Annual interest rate.
|
|
type: string
|
|
installmentPaymentData.option[itemNr].firstInstallmentAmount:
|
|
description: First Installment Amount in minor units.
|
|
type: string
|
|
installmentPaymentData.option[itemNr].installmentFee:
|
|
description: Installment fee amount in minor units.
|
|
type: string
|
|
installmentPaymentData.option[itemNr].interestRate:
|
|
description: Interest rate for the installment period.
|
|
type: string
|
|
installmentPaymentData.option[itemNr].maximumNumberOfInstallments:
|
|
description: Maximum number of installments possible for this payment.
|
|
type: string
|
|
installmentPaymentData.option[itemNr].minimumNumberOfInstallments:
|
|
description: Minimum number of installments possible for this payment.
|
|
type: string
|
|
installmentPaymentData.option[itemNr].numberOfInstallments:
|
|
description: Total number of installments possible for this payment.
|
|
type: string
|
|
installmentPaymentData.option[itemNr].subsequentInstallmentAmount:
|
|
description: Subsequent Installment Amount in minor units.
|
|
type: string
|
|
installmentPaymentData.option[itemNr].totalAmountDue:
|
|
description: Total amount in minor units.
|
|
type: string
|
|
installmentPaymentData.paymentOptions:
|
|
description: 'Possible values:
|
|
|
|
* PayInInstallmentsOnly
|
|
|
|
* PayInFullOnly
|
|
|
|
* PayInFullOrInstallments'
|
|
type: string
|
|
installments.value:
|
|
description: 'The number of installments that the payment amount should
|
|
be charged with.
|
|
|
|
|
|
Example: 5
|
|
|
|
> Only relevant for card payments in countries that support installments.'
|
|
type: string
|
|
type: object
|
|
ResponseAdditionalDataNetworkTokens:
|
|
additionalProperties: false
|
|
properties:
|
|
networkToken.available:
|
|
description: Indicates whether a network token is available for the specified
|
|
card.
|
|
type: string
|
|
networkToken.bin:
|
|
description: The Bank Identification Number of a tokenized card, which is
|
|
the first six digits of a card number.
|
|
type: string
|
|
networkToken.tokenSummary:
|
|
description: The last four digits of a network token.
|
|
type: string
|
|
type: object
|
|
ResponseAdditionalDataOpi:
|
|
additionalProperties: false
|
|
properties:
|
|
opi.transToken:
|
|
description: 'Returned in the response if you included `opi.includeTransToken:
|
|
true` in an ecommerce payment request. This contains an Oracle Payment
|
|
Interface token that you can store in your Oracle Opera database to identify
|
|
tokenized ecommerce transactions. For more information and required settings,
|
|
see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
|
|
type: string
|
|
type: object
|
|
ResponseAdditionalDataSepa:
|
|
additionalProperties: false
|
|
properties:
|
|
sepadirectdebit.dateOfSignature:
|
|
description: 'The transaction signature date.
|
|
|
|
|
|
Format: yyyy-MM-dd'
|
|
type: string
|
|
sepadirectdebit.mandateId:
|
|
description: Its value corresponds to the pspReference value of the transaction.
|
|
type: string
|
|
sepadirectdebit.sequenceType:
|
|
description: 'This field can take one of the following values:
|
|
|
|
* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct
|
|
debit transaction.
|
|
|
|
|
|
* First: (FRST) Initial/first collection in a series of direct debit instructions.
|
|
|
|
* Recurring: (RCUR) Direct debit instruction to carry out regular direct
|
|
debit transactions initiated by the creditor.
|
|
|
|
* Final: (FNAL) Last/final collection in a series of direct debit instructions.
|
|
|
|
|
|
Example: OOFF'
|
|
type: string
|
|
type: object
|
|
ResponsePaymentMethod:
|
|
additionalProperties: false
|
|
properties:
|
|
brand:
|
|
description: The card brand that the shopper used to pay. Only returned
|
|
if `paymentMethod.type` is **scheme**.
|
|
type: string
|
|
type:
|
|
description: The `paymentMethod.type` value used in the request.
|
|
type: string
|
|
title: paymentResponse
|
|
type: object
|
|
RiskData:
|
|
additionalProperties: false
|
|
properties:
|
|
clientData:
|
|
description: Contains client-side data, like the device fingerprint, cookies,
|
|
and specific browser settings.
|
|
maxLength: 5000
|
|
type: string
|
|
customFields:
|
|
x-addedInVersion: '65'
|
|
additionalProperties:
|
|
type: string
|
|
description: Any custom fields used as part of the input to configured risk
|
|
rules.
|
|
type: object
|
|
fraudOffset:
|
|
x-addedInVersion: '65'
|
|
description: An integer value that is added to the normal fraud score. The
|
|
value can be either positive or negative.
|
|
format: int32
|
|
type: integer
|
|
profileReference:
|
|
x-addedInVersion: '65'
|
|
description: The risk profile to assign to this payment. When left empty,
|
|
the merchant-level account's default risk profile will be applied.
|
|
type: string
|
|
type: object
|
|
RivertyDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
billingAddress:
|
|
description: The address where to send the invoice.
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
deliveryAddress:
|
|
description: The address where the goods should be delivered.
|
|
type: string
|
|
deviceFingerprint:
|
|
description: A string containing the shopper's device fingerprint. For more
|
|
information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
|
|
maxLength: 5000
|
|
type: string
|
|
iban:
|
|
description: 'The iban number of the customer '
|
|
maxLength: 34
|
|
type: string
|
|
personalDetails:
|
|
description: Shopper name, date of birth, phone number, and email address.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: riverty
|
|
description: '**riverty**'
|
|
enum:
|
|
- riverty
|
|
- riverty_account
|
|
- sepadirectdebit_riverty
|
|
type: string
|
|
required:
|
|
- type
|
|
title: Riverty
|
|
type: object
|
|
SDKEphemPubKey:
|
|
additionalProperties: false
|
|
properties:
|
|
crv:
|
|
description: The `crv` value as received from the 3D Secure 2 SDK.
|
|
type: string
|
|
kty:
|
|
description: The `kty` value as received from the 3D Secure 2 SDK.
|
|
type: string
|
|
x:
|
|
description: The `x` value as received from the 3D Secure 2 SDK.
|
|
type: string
|
|
y:
|
|
description: The `y` value as received from the 3D Secure 2 SDK.
|
|
type: string
|
|
type: object
|
|
SamsungPayDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
fundingSource:
|
|
description: The funding source that should be used when multiple sources
|
|
are available. For Brazilian combo cards, by default the funding source
|
|
is credit. To use debit, set this value to **debit**.
|
|
enum:
|
|
- credit
|
|
- debit
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
samsungPayToken:
|
|
description: The payload you received from the Samsung Pay SDK response.
|
|
maxLength: 10000
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: samsungpay
|
|
description: '**samsungpay**'
|
|
enum:
|
|
- samsungpay
|
|
type: string
|
|
required:
|
|
- samsungPayToken
|
|
title: Samsung Pay
|
|
type: object
|
|
SepaDirectDebitDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
iban:
|
|
description: The International Bank Account Number (IBAN).
|
|
type: string
|
|
ownerName:
|
|
description: The name of the bank account holder.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
transferInstrumentId:
|
|
description: The unique identifier of your user's verified transfer instrument,
|
|
which you can use to top up their balance accounts.
|
|
type: string
|
|
type:
|
|
default: sepadirectdebit
|
|
description: '**sepadirectdebit**'
|
|
enum:
|
|
- sepadirectdebit
|
|
- sepadirectdebit_amazonpay
|
|
type: string
|
|
required:
|
|
- iban
|
|
- ownerName
|
|
title: SEPA Direct Debit
|
|
type: object
|
|
ServiceError:
|
|
additionalProperties: false
|
|
properties:
|
|
additionalData:
|
|
x-addedInVersion: '46'
|
|
additionalProperties:
|
|
type: string
|
|
description: Contains additional information about the payment. Some data
|
|
fields are included only if you select them first. Go to **Customer Area**
|
|
> **Developers** > **Additional data**.
|
|
type: object
|
|
errorCode:
|
|
description: The error code mapped to the error message.
|
|
type: string
|
|
errorType:
|
|
description: The category of the error.
|
|
type: string
|
|
message:
|
|
description: A short explanation of the issue.
|
|
type: string
|
|
pspReference:
|
|
description: The PSP reference of the payment.
|
|
type: string
|
|
status:
|
|
description: The HTTP response status.
|
|
format: int32
|
|
type: integer
|
|
type: object
|
|
SessionResultResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
id:
|
|
description: A unique identifier of the session.
|
|
type: string
|
|
status:
|
|
description: 'The status of the session. The status included in the response
|
|
doesn''t get updated. Don''t make the request again to check for payment
|
|
status updates.
|
|
|
|
|
|
Possible values:
|
|
|
|
* **completed**: the shopper completed the payment, and the payment was
|
|
authorized.
|
|
|
|
* **paymentPending**: the shopper is in the process of making the payment.
|
|
This applies to payment methods with an asynchronous flow, like voucher
|
|
payments where the shopper completes the payment in a physical shop.
|
|
|
|
* **refused**: the session has been refused, because of too many refused
|
|
payment attempts. The shopper can no longer complete the payment with
|
|
this session.
|
|
|
|
* **canceled**: the shopper canceled the payment.
|
|
|
|
* **expired**: the session expired. The shopper can no longer complete
|
|
the payment with this session. By default, the session expires one hour
|
|
after it is created.'
|
|
enum:
|
|
- active
|
|
- canceled
|
|
- completed
|
|
- expired
|
|
- paymentPending
|
|
- refused
|
|
type: string
|
|
type: object
|
|
ShopperInteractionDevice:
|
|
additionalProperties: false
|
|
properties:
|
|
locale:
|
|
description: Locale on the shopper interaction device.
|
|
type: string
|
|
os:
|
|
description: Operating system running on the shopper interaction device.
|
|
type: string
|
|
osVersion:
|
|
description: Version of the operating system on the shopper interaction
|
|
device.
|
|
type: string
|
|
type: object
|
|
Split:
|
|
additionalProperties: false
|
|
properties:
|
|
account:
|
|
description: 'The unique identifier of the account to which the split amount
|
|
is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.
|
|
|
|
|
|
* [Classic Platforms integration](https://docs.adyen.com/classic-platforms):
|
|
The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode)
|
|
of the account to which the split amount is booked.
|
|
|
|
* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):
|
|
The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id)
|
|
of the account to which the split amount is booked.'
|
|
type: string
|
|
amount:
|
|
description: 'The amount of the split item.
|
|
|
|
|
|
* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).
|
|
|
|
* Required if `type` is **BalanceAccount**, **Commission**, **Default**,
|
|
or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)
|
|
integration.'
|
|
$ref: '#/components/schemas/SplitAmount'
|
|
description:
|
|
description: Your description for the split item.
|
|
type: string
|
|
reference:
|
|
description: 'Your unique reference for the part of the payment booked to
|
|
the specified `account`.
|
|
|
|
|
|
This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms))
|
|
or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).
|
|
|
|
|
|
For the other types, we also recommend providing a **unique** reference
|
|
so you can reconcile the split and the associated payment in the transaction
|
|
overview and in the reports.'
|
|
type: string
|
|
type:
|
|
description: "The part of the payment you want to book to the specified\
|
|
\ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\
|
|
* **BalanceAccount**: books part of the payment (specified in `amount`)\
|
|
\ to the specified `account`.\n* Transaction fees types that you can book\
|
|
\ to the specified `account`:\n * **AcquiringFees**: the aggregated\
|
|
\ amount of the interchange and scheme fees.\n * **PaymentFee**: the\
|
|
\ aggregated amount of all transaction fees.\n * **AdyenFees**: the\
|
|
\ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\
|
|
\ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\
|
|
\ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\
|
|
\ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\
|
|
\ * **Interchange**: the fees paid to the issuer for each payment made\
|
|
\ with the card network.\n * **SchemeFee**: the fees paid to the card\
|
|
\ scheme for using their network. \n* **Commission**: your platform's\
|
|
\ commission on the payment (specified in `amount`), booked to your liable\
|
|
\ balance account.\n* **Remainder**: the amount left over after a currency\
|
|
\ conversion, booked to the specified `account`.\n* **TopUp**: allows\
|
|
\ you and your users to top up balance accounts using direct debit, card\
|
|
\ payments, or other payment methods.\n* **VAT**: the value-added tax\
|
|
\ charged on the payment, booked to your platforms liable balance account.\n\
|
|
* **Commission**: your platform's commission (specified in `amount`) on\
|
|
\ the payment, booked to your liable balance account.\n* **Default**:\
|
|
\ in very specific use cases, allows you to book the specified `amount`\
|
|
\ to the specified `account`. For more information, contact Adyen support.\n\
|
|
\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms):\
|
|
\ **Commission**, **Default**, **MarketPlace**, **PaymentFee**, **VAT**."
|
|
enum:
|
|
- AcquiringFees
|
|
- AdyenCommission
|
|
- AdyenFees
|
|
- AdyenMarkup
|
|
- BalanceAccount
|
|
- Commission
|
|
- Default
|
|
- Interchange
|
|
- MarketPlace
|
|
- PaymentFee
|
|
- Remainder
|
|
- SchemeFee
|
|
- Surcharge
|
|
- Tip
|
|
- TopUp
|
|
- VAT
|
|
type: string
|
|
required:
|
|
- type
|
|
type: object
|
|
SplitAmount:
|
|
additionalProperties: false
|
|
properties:
|
|
currency:
|
|
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
|
|
By default, this is the original payment currency.
|
|
maxLength: 3
|
|
minLength: 3
|
|
type: string
|
|
value:
|
|
description: The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
|
format: int64
|
|
type: integer
|
|
required:
|
|
- value
|
|
type: object
|
|
StandalonePaymentCancelRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
applicationInfo:
|
|
description: Information about your application. For more details, see [Building
|
|
Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
|
|
$ref: '#/components/schemas/ApplicationInfo'
|
|
merchantAccount:
|
|
description: The merchant account that is used to process the payment.
|
|
type: string
|
|
paymentReference:
|
|
description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference)
|
|
of the payment that you want to cancel.
|
|
type: string
|
|
reference:
|
|
description: 'Your reference for the cancel request. Maximum length: 80
|
|
characters.'
|
|
type: string
|
|
required:
|
|
- merchantAccount
|
|
- paymentReference
|
|
type: object
|
|
StandalonePaymentCancelResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
merchantAccount:
|
|
description: The merchant account that is used to process the payment.
|
|
type: string
|
|
paymentReference:
|
|
description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference)
|
|
of the payment to cancel.
|
|
type: string
|
|
pspReference:
|
|
description: Adyen's 16-character reference associated with the cancel request.
|
|
type: string
|
|
reference:
|
|
description: Your reference for the cancel request.
|
|
type: string
|
|
status:
|
|
description: The status of your request. This will always have the value
|
|
**received**.
|
|
enum:
|
|
- received
|
|
type: string
|
|
required:
|
|
- status
|
|
- merchantAccount
|
|
- pspReference
|
|
- paymentReference
|
|
type: object
|
|
StoredPaymentMethod:
|
|
additionalProperties: false
|
|
properties:
|
|
bankAccountNumber:
|
|
description: The bank account number (without separators).
|
|
type: string
|
|
bankLocationId:
|
|
description: The location id of the bank. The field value is `nil` in most
|
|
cases.
|
|
type: string
|
|
brand:
|
|
description: The brand of the card.
|
|
type: string
|
|
expiryMonth:
|
|
description: The two-digit month when the card expires
|
|
type: string
|
|
expiryYear:
|
|
description: The last two digits of the year the card expires. For example,
|
|
**22** for the year 2022.
|
|
type: string
|
|
holderName:
|
|
description: The unique payment method code.
|
|
type: string
|
|
iban:
|
|
x-addedInVersion: '67'
|
|
description: The IBAN of the bank account.
|
|
type: string
|
|
id:
|
|
description: A unique identifier of this stored payment method.
|
|
type: string
|
|
label:
|
|
x-addedInVersion: '70'
|
|
description: "The shopper\u2019s issuer account label"
|
|
type: string
|
|
lastFour:
|
|
description: The last four digits of the PAN.
|
|
type: string
|
|
name:
|
|
description: The display name of the stored payment method.
|
|
type: string
|
|
networkTxReference:
|
|
x-addedInVersion: '68'
|
|
description: 'Returned in the response if you are not tokenizing with Adyen
|
|
and are using the Merchant-initiated transactions (MIT) framework from
|
|
Mastercard or Visa.
|
|
|
|
|
|
This contains either the Mastercard Trace ID or the Visa Transaction ID.'
|
|
type: string
|
|
ownerName:
|
|
x-addedInVersion: '67'
|
|
description: The name of the bank account holder.
|
|
type: string
|
|
shopperEmail:
|
|
description: "The shopper\u2019s email address."
|
|
type: string
|
|
supportedRecurringProcessingModels:
|
|
x-addedInVersion: '70'
|
|
description: The supported recurring processing models for this stored payment
|
|
method.
|
|
items:
|
|
type: string
|
|
type: array
|
|
supportedShopperInteractions:
|
|
description: The supported shopper interactions for this stored payment
|
|
method.
|
|
items:
|
|
type: string
|
|
type: array
|
|
type:
|
|
description: The type of payment method.
|
|
type: string
|
|
type: object
|
|
StoredPaymentMethodDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
description: The payment method type.
|
|
enum:
|
|
- bcmc_mobile
|
|
- bcmc_mobile_QR
|
|
- bcmc_mobile_app
|
|
- momo_wallet
|
|
- momo_wallet_app
|
|
- paymaya_wallet
|
|
- grabpay_SG
|
|
- grabpay_MY
|
|
- grabpay_TH
|
|
- grabpay_ID
|
|
- grabpay_VN
|
|
- grabpay_PH
|
|
- oxxo
|
|
- gcash
|
|
- dana
|
|
- kakaopay
|
|
- truemoney
|
|
- paysafecard
|
|
type: string
|
|
title: Stored Payment Method
|
|
type: object
|
|
StoredPaymentMethodRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
merchantAccount:
|
|
description: The merchant account identifier, with which you want to process
|
|
the transaction.
|
|
type: string
|
|
paymentMethod:
|
|
description: Contains the information required to store a payment method.
|
|
$ref: '#/components/schemas/PaymentMethodToStore'
|
|
recurringProcessingModel:
|
|
x-addedInVersion: '70'
|
|
description: "Defines a recurring payment type. Required when creating a\
|
|
\ token to store payment details.\nAllowed values:\n* `Subscription` \u2013\
|
|
\ A transaction for a fixed or variable amount, which follows a fixed\
|
|
\ schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\
|
|
\ card details are stored to enable one-click or omnichannel journeys,\
|
|
\ or simply to streamline the checkout process. Any subscription not following\
|
|
\ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\
|
|
\ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\
|
|
\ that occurs on a non-fixed schedule and/or have variable amounts. For\
|
|
\ example, automatic top-ups when a cardholder's balance drops below a\
|
|
\ certain amount.\n"
|
|
enum:
|
|
- CardOnFile
|
|
- Subscription
|
|
- UnscheduledCardOnFile
|
|
type: string
|
|
shopperEmail:
|
|
description: The shopper's email address. We recommend that you provide
|
|
this data, as it is used in velocity fraud checks.
|
|
type: string
|
|
shopperIP:
|
|
description: The IP address of a shopper.
|
|
type: string
|
|
shopperReference:
|
|
description: A unique identifier for the shopper (for example, user ID or
|
|
account ID).
|
|
type: string
|
|
required:
|
|
- merchantAccount
|
|
- shopperReference
|
|
- paymentMethod
|
|
- recurringProcessingModel
|
|
type: object
|
|
StoredPaymentMethodResource:
|
|
additionalProperties: false
|
|
properties:
|
|
brand:
|
|
description: The brand of the card.
|
|
type: string
|
|
expiryMonth:
|
|
description: The month the card expires.
|
|
type: string
|
|
expiryYear:
|
|
description: The last two digits of the year the card expires. For example,
|
|
**22** for the year 2022.
|
|
type: string
|
|
externalResponseCode:
|
|
x-addedInVersion: '68'
|
|
description: The response code returned by an external system (for example
|
|
after a provisioning operation).
|
|
type: string
|
|
externalTokenReference:
|
|
x-addedInVersion: '68'
|
|
description: The token reference of a linked token in an external system
|
|
(for example a network token reference).
|
|
type: string
|
|
holderName:
|
|
description: The unique payment method code.
|
|
type: string
|
|
iban:
|
|
description: The IBAN of the bank account.
|
|
type: string
|
|
id:
|
|
description: A unique identifier of this stored payment method.
|
|
type: string
|
|
issuerName:
|
|
x-addedInVersion: '68'
|
|
description: The name of the issuer of token or card.
|
|
type: string
|
|
lastFour:
|
|
description: The last four digits of the PAN.
|
|
type: string
|
|
name:
|
|
description: The display name of the stored payment method.
|
|
type: string
|
|
networkTxReference:
|
|
description: 'Returned in the response if you are not tokenizing with Adyen
|
|
and are using the Merchant-initiated transactions (MIT) framework from
|
|
Mastercard or Visa.
|
|
|
|
|
|
This contains either the Mastercard Trace ID or the Visa Transaction ID.'
|
|
type: string
|
|
ownerName:
|
|
x-addedInVersion: '67'
|
|
description: The name of the bank account holder.
|
|
type: string
|
|
shopperEmail:
|
|
description: "The shopper\u2019s email address."
|
|
type: string
|
|
shopperReference:
|
|
description: 'Your reference to uniquely identify this shopper, for example
|
|
user ID or account ID. The value is case-sensitive and must be at least
|
|
three characters.
|
|
|
|
> Your reference must not include personally identifiable information
|
|
(PII) such as name or email address.'
|
|
maxLength: 256
|
|
minLength: 3
|
|
type: string
|
|
supportedRecurringProcessingModels:
|
|
x-addedInVersion: '70'
|
|
description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\
|
|
\ \u2013 A transaction for a fixed or variable amount, which follows a\
|
|
\ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\
|
|
\ card details are stored to enable one-click or omnichannel journeys,\
|
|
\ or simply to streamline the checkout process. Any subscription not following\
|
|
\ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\
|
|
\ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\
|
|
\ that occurs on a non-fixed schedule and/or have variable amounts. For\
|
|
\ example, automatic top-ups when a cardholder's balance drops below a\
|
|
\ certain amount."
|
|
items:
|
|
type: string
|
|
type: array
|
|
type:
|
|
description: The type of payment method.
|
|
type: string
|
|
type: object
|
|
SubInputDetail:
|
|
additionalProperties: false
|
|
properties:
|
|
configuration:
|
|
additionalProperties:
|
|
type: string
|
|
description: Configuration parameters for the required input.
|
|
type: object
|
|
items:
|
|
description: In case of a select, the items to choose from.
|
|
items:
|
|
$ref: '#/components/schemas/Item'
|
|
type: array
|
|
key:
|
|
description: The value to provide in the result.
|
|
type: string
|
|
optional:
|
|
description: True if this input is optional to provide.
|
|
type: boolean
|
|
type:
|
|
description: The type of the required input.
|
|
type: string
|
|
value:
|
|
description: The value can be pre-filled, if available.
|
|
type: string
|
|
type: object
|
|
SubMerchant:
|
|
additionalProperties: false
|
|
properties:
|
|
city:
|
|
description: 'The city of the sub-merchant''s address.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* Maximum length: 13 characters'
|
|
type: string
|
|
country:
|
|
description: "The three-letter country code of the sub-merchant's address.\
|
|
\ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\
|
|
* Fixed length: 3 characters"
|
|
type: string
|
|
mcc:
|
|
description: "The sub-merchant's 4-digit Merchant Category Code (MCC). \n\
|
|
* Format: Numeric\n* Fixed length: 4 digits"
|
|
type: string
|
|
name:
|
|
description: 'The name of the sub-merchant. Based on scheme specifications,
|
|
this value will overwrite the shopper statement that will appear in the
|
|
card statement.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* Maximum length: 22 characters'
|
|
type: string
|
|
taxId:
|
|
description: 'The tax ID of the sub-merchant.
|
|
|
|
* Format: Numeric
|
|
|
|
* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ'
|
|
type: string
|
|
type: object
|
|
SubMerchantInfo:
|
|
additionalProperties: false
|
|
properties:
|
|
address:
|
|
description: 'Required for transactions performed by registered payment
|
|
facilitators. The sub-merchant''s address.
|
|
|
|
'
|
|
$ref: '#/components/schemas/BillingAddress'
|
|
amount:
|
|
description: Required for transactions performed by registered payment facilitators.
|
|
The amount of the payment corresponding to each sub-merchant. This value
|
|
will be different than the request amount if shopper is purchasing items
|
|
at different sub-merchants' shops.
|
|
$ref: '#/components/schemas/Amount'
|
|
email:
|
|
description: Required for transactions performed by registered payment facilitators.
|
|
The email associated with the sub-merchant's account.
|
|
maxLength: 320
|
|
type: string
|
|
id:
|
|
description: "Required for transactions performed by registered payment\
|
|
\ facilitators. A unique identifier that you create for the sub-merchant,\
|
|
\ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\
|
|
* Maximum length: 15 characters"
|
|
type: string
|
|
mcc:
|
|
description: "Required for transactions performed by registered payment\
|
|
\ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\
|
|
\ \n* Format: Numeric\n* Fixed length: 4 digits"
|
|
type: string
|
|
name:
|
|
description: 'Required for transactions performed by registered payment
|
|
facilitators. The name of the sub-merchant. Based on scheme specifications,
|
|
this value will overwrite the shopper statement that will appear in the
|
|
card statement.
|
|
|
|
* Format: Alphanumeric
|
|
|
|
* Maximum length: 22 characters'
|
|
type: string
|
|
phoneNumber:
|
|
description: Required for transactions performed by registered payment facilitators.
|
|
The phone number associated with the sub-merchant's account.
|
|
maxLength: 20
|
|
type: string
|
|
registeredSince:
|
|
type: string
|
|
taxId:
|
|
description: 'Required for transactions performed by registered payment
|
|
facilitators. The tax ID of the sub-merchant.
|
|
|
|
* Format: Numeric
|
|
|
|
* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ'
|
|
type: string
|
|
url:
|
|
description: Required for transactions performed by registered payment facilitators.
|
|
The sub-merchant's URL on the platform, i.e. the sub-merchant's shop.
|
|
maxLength: 320
|
|
type: string
|
|
type: object
|
|
TaxTotal:
|
|
additionalProperties: false
|
|
properties:
|
|
amount:
|
|
$ref: '#/components/schemas/Amount'
|
|
type: object
|
|
ThreeDS2RequestData:
|
|
additionalProperties: false
|
|
properties:
|
|
acctInfo:
|
|
x-addedInVersion: '68'
|
|
description: "Additional information about the Cardholder\u2019s account\
|
|
\ provided by the 3DS Requestor."
|
|
$ref: '#/components/schemas/AcctInfo'
|
|
acctType:
|
|
x-addedInVersion: '68'
|
|
description: "Indicates the type of account. For example, for a multi-account\
|
|
\ card product. Length: 2 characters. Allowed values:\n* **01** \u2014\
|
|
\ Not applicable\n* **02** \u2014 Credit\n* **03** \u2014 Debit"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
maxLength: 2
|
|
minLength: 2
|
|
type: string
|
|
acquirerBIN:
|
|
x-addedInVersion: '49'
|
|
description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
|
|
The acquiring BIN enrolled for 3D Secure 2. This string should match the
|
|
value that you will use in the authorisation. Use 123456 on the Test platform.
|
|
type: string
|
|
acquirerMerchantID:
|
|
x-addedInVersion: '49'
|
|
description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
|
|
The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer.
|
|
This string should match the value that you will use in the authorisation.
|
|
Use 123456 on the Test platform.
|
|
type: string
|
|
addrMatch:
|
|
x-addedInVersion: '68'
|
|
description: "Indicates whether the Cardholder Shipping Address and Cardholder\
|
|
\ Billing Address are the same. Allowed values:\n* **Y** \u2014 Shipping\
|
|
\ Address matches Billing Address.\n* **N** \u2014 Shipping Address does\
|
|
\ not match Billing Address."
|
|
enum:
|
|
- Y
|
|
- N
|
|
maxLength: 1
|
|
minLength: 1
|
|
type: string
|
|
authenticationOnly:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '50'
|
|
x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead.
|
|
default: false
|
|
description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
|
|
and not the payment authorisation.
|
|
type: boolean
|
|
challengeIndicator:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '68'
|
|
x-deprecatedMessage: Use `threeDSRequestorChallengeInd` instead.
|
|
description: 'Possibility to specify a preference for receiving a challenge
|
|
from the issuer.
|
|
|
|
Allowed values:
|
|
|
|
* `noPreference`
|
|
|
|
* `requestNoChallenge`
|
|
|
|
* `requestChallenge`
|
|
|
|
* `requestChallengeAsMandate`
|
|
|
|
'
|
|
enum:
|
|
- noPreference
|
|
- requestNoChallenge
|
|
- requestChallenge
|
|
- requestChallengeAsMandate
|
|
type: string
|
|
deviceChannel:
|
|
description: 'The environment of the shopper.
|
|
|
|
Allowed values:
|
|
|
|
* `app`
|
|
|
|
* `browser`'
|
|
type: string
|
|
deviceRenderOptions:
|
|
description: 'Display options for the 3D Secure 2 SDK.
|
|
|
|
Optional and only for `deviceChannel` **app**.'
|
|
$ref: '#/components/schemas/DeviceRenderOptions'
|
|
homePhone:
|
|
x-addedInVersion: '68'
|
|
description: The home phone number provided by the Cardholder.
|
|
$ref: '#/components/schemas/Phone'
|
|
mcc:
|
|
x-addedInVersion: '49'
|
|
description: Required for merchants that have been enrolled for 3D Secure
|
|
2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
|
|
The `mcc` is a four-digit code with which the previously given `acquirerMerchantID`
|
|
is registered at the scheme.
|
|
type: string
|
|
merchantName:
|
|
x-addedInVersion: '49'
|
|
description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
|
|
The merchant name that the issuer presents to the shopper if they get
|
|
a challenge. We recommend to use the same value that you will use in the
|
|
authorization. Maximum length is 40 characters.
|
|
|
|
> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration).
|
|
Use this field if you are enrolled for 3D Secure 2 with us and want to
|
|
override the merchant name already configured on your account.'
|
|
type: string
|
|
messageVersion:
|
|
description: The `messageVersion` value indicating the 3D Secure 2 protocol
|
|
version.
|
|
type: string
|
|
mobilePhone:
|
|
x-addedInVersion: '68'
|
|
description: The mobile phone number provided by the Cardholder.
|
|
$ref: '#/components/schemas/Phone'
|
|
notificationURL:
|
|
description: URL to where the issuer should send the `CRes`. Required if
|
|
you are not using components for `channel` **Web** or if you are using
|
|
classic integration `deviceChannel` **browser**.
|
|
type: string
|
|
payTokenInd:
|
|
x-addedInVersion: '68'
|
|
description: Value **true** indicates that the transaction was de-tokenised
|
|
prior to being received by the ACS.
|
|
type: boolean
|
|
paymentAuthenticationUseCase:
|
|
x-addedInVersion: '68'
|
|
description: Indicates the type of payment for which an authentication is
|
|
requested (message extension)
|
|
type: string
|
|
purchaseInstalData:
|
|
x-addedInVersion: '68'
|
|
description: "Indicates the maximum number of authorisations permitted for\
|
|
\ instalment payments. Length: 1\u20133 characters."
|
|
maxLength: 3
|
|
minLength: 1
|
|
type: string
|
|
recurringExpiry:
|
|
x-addedInVersion: '68'
|
|
description: 'Date after which no further authorisations shall be performed.
|
|
Format: YYYYMMDD'
|
|
type: string
|
|
recurringFrequency:
|
|
x-addedInVersion: '68'
|
|
description: 'Indicates the minimum number of days between authorisations.
|
|
Maximum length: 4 characters.'
|
|
maxLength: 4
|
|
type: string
|
|
sdkAppID:
|
|
description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK.
|
|
|
|
Required for `deviceChannel` set to **app**.'
|
|
type: string
|
|
sdkEncData:
|
|
description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK.
|
|
|
|
Required for `deviceChannel` set to **app**.'
|
|
type: string
|
|
sdkEphemPubKey:
|
|
description: 'The `sdkEphemPubKey` value as received from the 3D Secure
|
|
2 SDK.
|
|
|
|
Required for `deviceChannel` set to **app**.'
|
|
$ref: '#/components/schemas/SDKEphemPubKey'
|
|
sdkMaxTimeout:
|
|
default: 60
|
|
description: 'The maximum amount of time in minutes for the 3D Secure 2
|
|
authentication process.
|
|
|
|
Optional and only for `deviceChannel` set to **app**. Defaults to **60**
|
|
minutes.'
|
|
format: int32
|
|
type: integer
|
|
sdkReferenceNumber:
|
|
description: 'The `sdkReferenceNumber` value as received from the 3D Secure
|
|
2 SDK.
|
|
|
|
Only for `deviceChannel` set to **app**.'
|
|
type: string
|
|
sdkTransID:
|
|
description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK.
|
|
|
|
Only for `deviceChannel` set to **app**.'
|
|
type: string
|
|
sdkVersion:
|
|
x-addedInVersion: '40'
|
|
description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\
|
|
\ set to **app**."
|
|
type: string
|
|
threeDSCompInd:
|
|
description: Completion indicator for the device fingerprinting.
|
|
type: string
|
|
threeDSRequestorAuthenticationInd:
|
|
x-addedInVersion: '68'
|
|
description: Indicates the type of Authentication request.
|
|
type: string
|
|
threeDSRequestorAuthenticationInfo:
|
|
x-addedInVersion: '68'
|
|
description: Information about how the 3DS Requestor authenticated the cardholder
|
|
before or during the transaction
|
|
$ref: '#/components/schemas/ThreeDSRequestorAuthenticationInfo'
|
|
threeDSRequestorChallengeInd:
|
|
x-addedInVersion: '68'
|
|
description: "Indicates whether a challenge is requested for this transaction.\
|
|
\ Possible values:\n* **01** \u2014 No preference\n* **02** \u2014 No\
|
|
\ challenge requested\n* **03** \u2014 Challenge requested (3DS Requestor\
|
|
\ preference)\n* **04** \u2014 Challenge requested (Mandate)\n* **05**\
|
|
\ \u2014 No challenge (transactional risk analysis is already performed)\n\
|
|
* **06** \u2014 Data Only"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
- '05'
|
|
- '06'
|
|
type: string
|
|
threeDSRequestorID:
|
|
description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only)
|
|
for Visa. Unique 3D Secure requestor identifier assigned by the Directory
|
|
Server when you enrol for 3D Secure 2.
|
|
type: string
|
|
threeDSRequestorName:
|
|
description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only)
|
|
for Visa. Unique 3D Secure requestor name assigned by the Directory Server
|
|
when you enrol for 3D Secure 2.
|
|
type: string
|
|
threeDSRequestorPriorAuthenticationInfo:
|
|
x-addedInVersion: '68'
|
|
description: Information about how the 3DS Requestor authenticated the cardholder
|
|
as part of a previous 3DS transaction.
|
|
$ref: '#/components/schemas/ThreeDSRequestorPriorAuthenticationInfo'
|
|
threeDSRequestorURL:
|
|
description: URL of the (customer service) website that will be shown to
|
|
the shopper in case of technical errors during the 3D Secure 2 process.
|
|
type: string
|
|
transType:
|
|
x-addedInVersion: '68'
|
|
description: "Identifies the type of transaction being authenticated. Length:\
|
|
\ 2 characters. Allowed values:\n* **01** \u2014 Goods/Service Purchase\n\
|
|
* **03** \u2014 Check Acceptance\n* **10** \u2014 Account Funding\n* **11**\
|
|
\ \u2014 Quasi-Cash Transaction\n* **28** \u2014 Prepaid Activation and\
|
|
\ Load"
|
|
enum:
|
|
- '01'
|
|
- '03'
|
|
- '10'
|
|
- '11'
|
|
- '28'
|
|
maxLength: 2
|
|
minLength: 2
|
|
type: string
|
|
transactionType:
|
|
x-addedInVersion: '50'
|
|
description: Identify the type of the transaction being authenticated.
|
|
enum:
|
|
- goodsOrServicePurchase
|
|
- checkAcceptance
|
|
- accountFunding
|
|
- quasiCashTransaction
|
|
- prepaidActivationAndLoad
|
|
type: string
|
|
whiteListStatus:
|
|
x-addedInVersion: '49'
|
|
description: The `whiteListStatus` value returned from a previous 3D Secure
|
|
2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.
|
|
type: string
|
|
workPhone:
|
|
x-addedInVersion: '68'
|
|
description: The work phone number provided by the Cardholder.
|
|
$ref: '#/components/schemas/Phone'
|
|
required:
|
|
- deviceChannel
|
|
type: object
|
|
ThreeDS2RequestFields:
|
|
additionalProperties: false
|
|
properties:
|
|
acctInfo:
|
|
x-addedInVersion: '68'
|
|
description: "Additional information about the Cardholder\u2019s account\
|
|
\ provided by the 3DS Requestor."
|
|
$ref: '#/components/schemas/AcctInfo'
|
|
acctType:
|
|
x-addedInVersion: '68'
|
|
description: "Indicates the type of account. For example, for a multi-account\
|
|
\ card product. Length: 2 characters. Allowed values:\n* **01** \u2014\
|
|
\ Not applicable\n* **02** \u2014 Credit\n* **03** \u2014 Debit"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
maxLength: 2
|
|
minLength: 2
|
|
type: string
|
|
acquirerBIN:
|
|
x-addedInVersion: '49'
|
|
description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
|
|
The acquiring BIN enrolled for 3D Secure 2. This string should match the
|
|
value that you will use in the authorisation. Use 123456 on the Test platform.
|
|
type: string
|
|
acquirerMerchantID:
|
|
x-addedInVersion: '49'
|
|
description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
|
|
The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer.
|
|
This string should match the value that you will use in the authorisation.
|
|
Use 123456 on the Test platform.
|
|
type: string
|
|
addrMatch:
|
|
x-addedInVersion: '68'
|
|
description: "Indicates whether the Cardholder Shipping Address and Cardholder\
|
|
\ Billing Address are the same. Allowed values:\n* **Y** \u2014 Shipping\
|
|
\ Address matches Billing Address.\n* **N** \u2014 Shipping Address does\
|
|
\ not match Billing Address."
|
|
enum:
|
|
- Y
|
|
- N
|
|
maxLength: 1
|
|
minLength: 1
|
|
type: string
|
|
authenticationOnly:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '50'
|
|
x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead.
|
|
default: false
|
|
description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
|
|
and not the payment authorisation.
|
|
type: boolean
|
|
challengeIndicator:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '68'
|
|
x-deprecatedMessage: Use `threeDSRequestorChallengeInd` instead.
|
|
description: 'Possibility to specify a preference for receiving a challenge
|
|
from the issuer.
|
|
|
|
Allowed values:
|
|
|
|
* `noPreference`
|
|
|
|
* `requestNoChallenge`
|
|
|
|
* `requestChallenge`
|
|
|
|
* `requestChallengeAsMandate`
|
|
|
|
'
|
|
enum:
|
|
- noPreference
|
|
- requestNoChallenge
|
|
- requestChallenge
|
|
- requestChallengeAsMandate
|
|
type: string
|
|
deviceRenderOptions:
|
|
description: 'Display options for the 3D Secure 2 SDK.
|
|
|
|
Optional and only for `deviceChannel` **app**.'
|
|
$ref: '#/components/schemas/DeviceRenderOptions'
|
|
homePhone:
|
|
x-addedInVersion: '68'
|
|
description: The home phone number provided by the Cardholder.
|
|
$ref: '#/components/schemas/Phone'
|
|
mcc:
|
|
x-addedInVersion: '49'
|
|
description: Required for merchants that have been enrolled for 3D Secure
|
|
2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
|
|
The `mcc` is a four-digit code with which the previously given `acquirerMerchantID`
|
|
is registered at the scheme.
|
|
type: string
|
|
merchantName:
|
|
x-addedInVersion: '49'
|
|
description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
|
|
The merchant name that the issuer presents to the shopper if they get
|
|
a challenge. We recommend to use the same value that you will use in the
|
|
authorization. Maximum length is 40 characters.
|
|
|
|
> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration).
|
|
Use this field if you are enrolled for 3D Secure 2 with us and want to
|
|
override the merchant name already configured on your account.'
|
|
type: string
|
|
messageVersion:
|
|
description: The `messageVersion` value indicating the 3D Secure 2 protocol
|
|
version.
|
|
type: string
|
|
mobilePhone:
|
|
x-addedInVersion: '68'
|
|
description: The mobile phone number provided by the Cardholder.
|
|
$ref: '#/components/schemas/Phone'
|
|
notificationURL:
|
|
description: URL to where the issuer should send the `CRes`. Required if
|
|
you are not using components for `channel` **Web** or if you are using
|
|
classic integration `deviceChannel` **browser**.
|
|
type: string
|
|
payTokenInd:
|
|
x-addedInVersion: '68'
|
|
description: Value **true** indicates that the transaction was de-tokenised
|
|
prior to being received by the ACS.
|
|
type: boolean
|
|
paymentAuthenticationUseCase:
|
|
x-addedInVersion: '68'
|
|
description: Indicates the type of payment for which an authentication is
|
|
requested (message extension)
|
|
type: string
|
|
purchaseInstalData:
|
|
x-addedInVersion: '68'
|
|
description: "Indicates the maximum number of authorisations permitted for\
|
|
\ instalment payments. Length: 1\u20133 characters."
|
|
maxLength: 3
|
|
minLength: 1
|
|
type: string
|
|
recurringExpiry:
|
|
x-addedInVersion: '68'
|
|
description: 'Date after which no further authorisations shall be performed.
|
|
Format: YYYYMMDD'
|
|
type: string
|
|
recurringFrequency:
|
|
x-addedInVersion: '68'
|
|
description: 'Indicates the minimum number of days between authorisations.
|
|
Maximum length: 4 characters.'
|
|
maxLength: 4
|
|
type: string
|
|
sdkAppID:
|
|
description: The `sdkAppID` value as received from the 3D Secure 2 SDK.
|
|
type: string
|
|
sdkEphemPubKey:
|
|
description: The `sdkEphemPubKey` value as received from the 3D Secure 2
|
|
SDK.
|
|
$ref: '#/components/schemas/SDKEphemPubKey'
|
|
sdkMaxTimeout:
|
|
default: 60
|
|
description: 'The maximum amount of time in minutes for the 3D Secure 2
|
|
authentication process.
|
|
|
|
Optional and only for `deviceChannel` set to **app**. Defaults to **60**
|
|
minutes.'
|
|
format: int32
|
|
type: integer
|
|
sdkReferenceNumber:
|
|
description: The `sdkReferenceNumber` value as received from the 3D Secure
|
|
2 SDK.
|
|
type: string
|
|
sdkTransID:
|
|
description: The `sdkTransID` value as received from the 3D Secure 2 SDK.
|
|
type: string
|
|
threeDSCompInd:
|
|
description: Completion indicator for the device fingerprinting.
|
|
type: string
|
|
threeDSRequestorAuthenticationInd:
|
|
x-addedInVersion: '68'
|
|
description: Indicates the type of Authentication request.
|
|
type: string
|
|
threeDSRequestorAuthenticationInfo:
|
|
x-addedInVersion: '68'
|
|
description: Information about how the 3DS Requestor authenticated the cardholder
|
|
before or during the transaction
|
|
$ref: '#/components/schemas/ThreeDSRequestorAuthenticationInfo'
|
|
threeDSRequestorChallengeInd:
|
|
x-addedInVersion: '68'
|
|
description: "Indicates whether a challenge is requested for this transaction.\
|
|
\ Possible values:\n* **01** \u2014 No preference\n* **02** \u2014 No\
|
|
\ challenge requested\n* **03** \u2014 Challenge requested (3DS Requestor\
|
|
\ preference)\n* **04** \u2014 Challenge requested (Mandate)\n* **05**\
|
|
\ \u2014 No challenge (transactional risk analysis is already performed)\n\
|
|
* **06** \u2014 Data Only"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
- '05'
|
|
- '06'
|
|
type: string
|
|
threeDSRequestorID:
|
|
description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only)
|
|
for Visa. Unique 3D Secure requestor identifier assigned by the Directory
|
|
Server when you enrol for 3D Secure 2.
|
|
type: string
|
|
threeDSRequestorName:
|
|
description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only)
|
|
for Visa. Unique 3D Secure requestor name assigned by the Directory Server
|
|
when you enrol for 3D Secure 2.
|
|
type: string
|
|
threeDSRequestorPriorAuthenticationInfo:
|
|
x-addedInVersion: '68'
|
|
description: Information about how the 3DS Requestor authenticated the cardholder
|
|
as part of a previous 3DS transaction.
|
|
$ref: '#/components/schemas/ThreeDSRequestorPriorAuthenticationInfo'
|
|
threeDSRequestorURL:
|
|
description: URL of the (customer service) website that will be shown to
|
|
the shopper in case of technical errors during the 3D Secure 2 process.
|
|
type: string
|
|
transType:
|
|
x-addedInVersion: '68'
|
|
description: "Identifies the type of transaction being authenticated. Length:\
|
|
\ 2 characters. Allowed values:\n* **01** \u2014 Goods/Service Purchase\n\
|
|
* **03** \u2014 Check Acceptance\n* **10** \u2014 Account Funding\n* **11**\
|
|
\ \u2014 Quasi-Cash Transaction\n* **28** \u2014 Prepaid Activation and\
|
|
\ Load"
|
|
enum:
|
|
- '01'
|
|
- '03'
|
|
- '10'
|
|
- '11'
|
|
- '28'
|
|
maxLength: 2
|
|
minLength: 2
|
|
type: string
|
|
transactionType:
|
|
x-addedInVersion: '50'
|
|
description: Identify the type of the transaction being authenticated.
|
|
enum:
|
|
- goodsOrServicePurchase
|
|
- checkAcceptance
|
|
- accountFunding
|
|
- quasiCashTransaction
|
|
- prepaidActivationAndLoad
|
|
type: string
|
|
whiteListStatus:
|
|
x-addedInVersion: '49'
|
|
description: The `whiteListStatus` value returned from a previous 3D Secure
|
|
2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.
|
|
type: string
|
|
workPhone:
|
|
x-addedInVersion: '68'
|
|
description: The work phone number provided by the Cardholder.
|
|
$ref: '#/components/schemas/Phone'
|
|
type: object
|
|
ThreeDS2ResponseData:
|
|
additionalProperties: false
|
|
properties:
|
|
acsChallengeMandated:
|
|
type: string
|
|
acsOperatorID:
|
|
type: string
|
|
acsReferenceNumber:
|
|
type: string
|
|
acsSignedContent:
|
|
type: string
|
|
acsTransID:
|
|
type: string
|
|
acsURL:
|
|
type: string
|
|
authenticationType:
|
|
type: string
|
|
cardHolderInfo:
|
|
type: string
|
|
cavvAlgorithm:
|
|
type: string
|
|
challengeIndicator:
|
|
type: string
|
|
dsReferenceNumber:
|
|
type: string
|
|
dsTransID:
|
|
type: string
|
|
exemptionIndicator:
|
|
type: string
|
|
messageVersion:
|
|
type: string
|
|
riskScore:
|
|
type: string
|
|
sdkEphemPubKey:
|
|
type: string
|
|
threeDSServerTransID:
|
|
type: string
|
|
transStatus:
|
|
type: string
|
|
transStatusReason:
|
|
type: string
|
|
type: object
|
|
ThreeDS2Result:
|
|
additionalProperties: false
|
|
properties:
|
|
authenticationValue:
|
|
description: The `authenticationValue` value as defined in the 3D Secure
|
|
2 specification.
|
|
type: string
|
|
cavvAlgorithm:
|
|
x-addedInVersion: '50'
|
|
description: The algorithm used by the ACS to calculate the authentication
|
|
value, only for Cartes Bancaires integrations.
|
|
type: string
|
|
challengeCancel:
|
|
x-addedInVersion: '67'
|
|
description: Indicator informing the Access Control Server (ACS) and the
|
|
Directory Server (DS) that the authentication has been cancelled. For
|
|
possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
- '05'
|
|
- '06'
|
|
- '07'
|
|
type: string
|
|
dsTransID:
|
|
description: The `dsTransID` value as defined in the 3D Secure 2 specification.
|
|
type: string
|
|
eci:
|
|
description: The `eci` value as defined in the 3D Secure 2 specification.
|
|
type: string
|
|
exemptionIndicator:
|
|
x-addedInVersion: '67'
|
|
description: 'Indicates the exemption type that was applied by the issuer
|
|
to the authentication, if exemption applied.
|
|
|
|
Allowed values:
|
|
|
|
* `lowValue`
|
|
|
|
* `secureCorporate`
|
|
|
|
* `trustedBeneficiary`
|
|
|
|
* `transactionRiskAnalysis`
|
|
|
|
'
|
|
enum:
|
|
- lowValue
|
|
- secureCorporate
|
|
- trustedBeneficiary
|
|
- transactionRiskAnalysis
|
|
type: string
|
|
messageVersion:
|
|
x-addedInVersion: '49'
|
|
description: The `messageVersion` value as defined in the 3D Secure 2 specification.
|
|
type: string
|
|
riskScore:
|
|
x-addedInVersion: '67'
|
|
description: Risk score calculated by Cartes Bancaires Directory Server
|
|
(DS).
|
|
type: string
|
|
threeDSRequestorChallengeInd:
|
|
x-addedInVersion: '68'
|
|
description: "Indicates whether a challenge is requested for this transaction.\
|
|
\ Possible values:\n* **01** \u2014 No preference\n* **02** \u2014 No\
|
|
\ challenge requested\n* **03** \u2014 Challenge requested (3DS Requestor\
|
|
\ preference)\n* **04** \u2014 Challenge requested (Mandate)\n* **05**\
|
|
\ \u2014 No challenge (transactional risk analysis is already performed)\n\
|
|
* **06** \u2014 Data Only"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
- '05'
|
|
- '06'
|
|
type: string
|
|
threeDSServerTransID:
|
|
description: The `threeDSServerTransID` value as defined in the 3D Secure
|
|
2 specification.
|
|
type: string
|
|
timestamp:
|
|
description: The `timestamp` value of the 3D Secure 2 authentication.
|
|
type: string
|
|
transStatus:
|
|
description: The `transStatus` value as defined in the 3D Secure 2 specification.
|
|
type: string
|
|
transStatusReason:
|
|
description: Provides information on why the `transStatus` field has the
|
|
specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).
|
|
type: string
|
|
whiteListStatus:
|
|
x-addedInVersion: '49'
|
|
description: The `whiteListStatus` value as defined in the 3D Secure 2 specification.
|
|
type: string
|
|
type: object
|
|
ThreeDSRequestData:
|
|
additionalProperties: false
|
|
properties:
|
|
challengeWindowSize:
|
|
x-addedInVersion: '69'
|
|
description: "Dimensions of the 3DS2 challenge window to be displayed to\
|
|
\ the cardholder.\n\nPossible values:\n\n* **01** - size of 250x400 \n\
|
|
* **02** - size of 390x400\n* **03** - size of 500x600\n* **04** - size\
|
|
\ of 600x400\n* **05** - Fullscreen"
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
- '05'
|
|
type: string
|
|
dataOnly:
|
|
x-addedInVersion: '69'
|
|
description: Flag for data only flow.
|
|
enum:
|
|
- 'false'
|
|
- 'true'
|
|
type: string
|
|
nativeThreeDS:
|
|
x-addedInVersion: '69'
|
|
description: 'Indicates if [native 3D Secure authentication](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)
|
|
should be used when available.
|
|
|
|
|
|
Possible values:
|
|
|
|
* **preferred**: Use native 3D Secure authentication when available.
|
|
|
|
* **disabled**: Only use the redirect 3D Secure authentication flow.'
|
|
enum:
|
|
- preferred
|
|
- disabled
|
|
type: string
|
|
threeDSVersion:
|
|
x-addedInVersion: '69'
|
|
description: 'The version of 3D Secure to use.
|
|
|
|
|
|
Possible values:
|
|
|
|
|
|
* **2.1.0**
|
|
|
|
* **2.2.0**'
|
|
enum:
|
|
- 2.1.0
|
|
- 2.2.0
|
|
type: string
|
|
type: object
|
|
ThreeDSRequestorAuthenticationInfo:
|
|
additionalProperties: false
|
|
properties:
|
|
threeDSReqAuthData:
|
|
description: 'Data that documents and supports a specific authentication
|
|
process. Maximum length: 2048 bytes.'
|
|
type: string
|
|
threeDSReqAuthMethod:
|
|
description: "Mechanism used by the Cardholder to authenticate to the 3DS\
|
|
\ Requestor. Allowed values:\n* **01** \u2014 No 3DS Requestor authentication\
|
|
\ occurred (for example, cardholder \u201Clogged in\u201D as guest).\n\
|
|
* **02** \u2014 Login to the cardholder account at the 3DS Requestor system\
|
|
\ using 3DS Requestor\u2019s own credentials.\n* **03** \u2014 Login to\
|
|
\ the cardholder account at the 3DS Requestor system using federated ID.\n\
|
|
* **04** \u2014 Login to the cardholder account at the 3DS Requestor system\
|
|
\ using issuer credentials.\n* **05** \u2014 Login to the cardholder account\
|
|
\ at the 3DS Requestor system using third-party authentication.\n* **06**\
|
|
\ \u2014 Login to the cardholder account at the 3DS Requestor system using\
|
|
\ FIDO Authenticator."
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
- '05'
|
|
- '06'
|
|
maxLength: 2
|
|
minLength: 2
|
|
type: string
|
|
threeDSReqAuthTimestamp:
|
|
description: 'Date and time in UTC of the cardholder authentication. Format:
|
|
YYYYMMDDHHMM'
|
|
maxLength: 12
|
|
minLength: 12
|
|
type: string
|
|
type: object
|
|
ThreeDSRequestorPriorAuthenticationInfo:
|
|
additionalProperties: false
|
|
properties:
|
|
threeDSReqPriorAuthData:
|
|
description: 'Data that documents and supports a specific authentication
|
|
process. Maximum length: 2048 bytes.'
|
|
type: string
|
|
threeDSReqPriorAuthMethod:
|
|
description: "Mechanism used by the Cardholder to previously authenticate\
|
|
\ to the 3DS Requestor. Allowed values:\n* **01** \u2014 Frictionless\
|
|
\ authentication occurred by ACS.\n* **02** \u2014 Cardholder challenge\
|
|
\ occurred by ACS.\n* **03** \u2014 AVS verified.\n* **04** \u2014 Other\
|
|
\ issuer methods."
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
maxLength: 2
|
|
minLength: 2
|
|
type: string
|
|
threeDSReqPriorAuthTimestamp:
|
|
description: 'Date and time in UTC of the prior cardholder authentication.
|
|
Format: YYYYMMDDHHMM'
|
|
maxLength: 12
|
|
minLength: 12
|
|
type: string
|
|
threeDSReqPriorRef:
|
|
description: 'This data element provides additional information to the ACS
|
|
to determine the best approach for handing a request. This data element
|
|
contains an ACS Transaction ID for a prior authenticated transaction.
|
|
For example, the first recurring transaction that was authenticated with
|
|
the cardholder. Length: 30 characters.'
|
|
maxLength: 36
|
|
minLength: 36
|
|
type: string
|
|
type: object
|
|
ThreeDSecureData:
|
|
additionalProperties: false
|
|
properties:
|
|
authenticationResponse:
|
|
description: 'In 3D Secure 2, this is the `transStatus` from the challenge
|
|
result. If the transaction was frictionless, omit this parameter.
|
|
|
|
|
|
'
|
|
enum:
|
|
- Y
|
|
- N
|
|
- U
|
|
- A
|
|
type: string
|
|
cavv:
|
|
description: The cardholder authentication value (base64 encoded, 20 bytes
|
|
in a decoded form).
|
|
format: byte
|
|
type: string
|
|
cavvAlgorithm:
|
|
description: The CAVV algorithm used. Include this only for 3D Secure 1.
|
|
type: string
|
|
challengeCancel:
|
|
x-addedInVersion: '67'
|
|
description: Indicator informing the Access Control Server (ACS) and the
|
|
Directory Server (DS) that the authentication has been cancelled. For
|
|
possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).
|
|
enum:
|
|
- '01'
|
|
- '02'
|
|
- '03'
|
|
- '04'
|
|
- '05'
|
|
- '06'
|
|
- '07'
|
|
type: string
|
|
directoryResponse:
|
|
description: 'In 3D Secure 2, this is the `transStatus` from the `ARes`.
|
|
|
|
|
|
'
|
|
enum:
|
|
- A
|
|
- C
|
|
- D
|
|
- I
|
|
- N
|
|
- R
|
|
- U
|
|
- Y
|
|
type: string
|
|
dsTransID:
|
|
x-addedInVersion: '40'
|
|
description: Supported for 3D Secure 2. The unique transaction identifier
|
|
assigned by the Directory Server (DS) to identify a single transaction.
|
|
type: string
|
|
eci:
|
|
description: The electronic commerce indicator.
|
|
type: string
|
|
riskScore:
|
|
x-addedInVersion: '67'
|
|
description: Risk score calculated by Directory Server (DS). Required for
|
|
Cartes Bancaires integrations.
|
|
type: string
|
|
threeDSVersion:
|
|
x-addedInVersion: '40'
|
|
description: The version of the 3D Secure protocol.
|
|
type: string
|
|
tokenAuthenticationVerificationValue:
|
|
x-addedInVersion: '68'
|
|
description: Network token authentication verification value (TAVV). The
|
|
network token cryptogram.
|
|
format: byte
|
|
type: string
|
|
transStatusReason:
|
|
x-addedInVersion: '67'
|
|
description: Provides information on why the `transStatus` field has the
|
|
specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).
|
|
type: string
|
|
xid:
|
|
description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded,
|
|
20 bytes in a decoded form).
|
|
format: byte
|
|
type: string
|
|
type: object
|
|
Ticket:
|
|
additionalProperties: false
|
|
properties:
|
|
issueAddress:
|
|
description: 'The address of the organization that issued the ticket.
|
|
|
|
* minLength: 0 characters
|
|
|
|
* maxLength: 16 characters'
|
|
type: string
|
|
issueDate:
|
|
description: 'The date that the ticket was issued to the passenger.
|
|
|
|
* minLength: 10 characters
|
|
|
|
* maxLength: 10 characters
|
|
|
|
* Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): yyyy-MM-dd'
|
|
format: date
|
|
type: string
|
|
number:
|
|
description: 'The ticket''s unique identifier.
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 15 characters
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
type: object
|
|
TravelAgency:
|
|
additionalProperties: false
|
|
properties:
|
|
code:
|
|
description: 'The unique identifier from IATA or ARC for the travel agency
|
|
that issues the ticket.
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 8 characters
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
name:
|
|
description: 'The name of the travel agency.
|
|
|
|
|
|
* Encoding: ASCII
|
|
|
|
* minLength: 1 character
|
|
|
|
* maxLength: 25 characters
|
|
|
|
* Must not start with a space or be all spaces.
|
|
|
|
* Must not be all zeros.'
|
|
type: string
|
|
type: object
|
|
TwintDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
subtype:
|
|
description: The type of flow to initiate.
|
|
type: string
|
|
type:
|
|
description: The payment method type.
|
|
enum:
|
|
- twint
|
|
type: string
|
|
title: Twint
|
|
type: object
|
|
UpdatePaymentLinkRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
status:
|
|
description: 'Status of the payment link. Possible values:
|
|
|
|
* **expired**'
|
|
enum:
|
|
- expired
|
|
type: string
|
|
required:
|
|
- status
|
|
type: object
|
|
UpiCollectDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
billingSequenceNumber:
|
|
description: The sequence number for the debit. For example, send **2**
|
|
if this is the second debit for the subscription. The sequence number
|
|
is included in the notification sent to the shopper.
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
shopperNotificationReference:
|
|
description: The `shopperNotificationReference` returned in the response
|
|
when you requested to notify the shopper. Used for recurring payment only.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: upi_collect
|
|
description: '**upi_collect**'
|
|
enum:
|
|
- upi_collect
|
|
type: string
|
|
virtualPaymentAddress:
|
|
description: The virtual payment address for UPI.
|
|
type: string
|
|
required:
|
|
- type
|
|
- billingSequenceNumber
|
|
title: UPI Collect
|
|
type: object
|
|
UpiIntentDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
appId:
|
|
description: TPAP (Third Party Application) Id that is being used to make
|
|
the UPI payment
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
shopperNotificationReference:
|
|
description: The `shopperNotificationReference` returned in the response
|
|
when you requested to notify the shopper. Used for recurring payment only.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: upi_intent
|
|
description: '**upi_intent**'
|
|
enum:
|
|
- upi_intent
|
|
type: string
|
|
required:
|
|
- type
|
|
title: UPI Intent
|
|
type: object
|
|
UtilityRequest:
|
|
additionalProperties: false
|
|
properties:
|
|
originDomains:
|
|
description: The list of origin domains, for which origin keys are requested.
|
|
items:
|
|
type: string
|
|
type: array
|
|
required:
|
|
- originDomains
|
|
type: object
|
|
UtilityResponse:
|
|
additionalProperties: false
|
|
properties:
|
|
originKeys:
|
|
x-addedInVersion: '1'
|
|
additionalProperties:
|
|
type: string
|
|
description: The list of origin keys for all requested domains. For each
|
|
list item, the key is the domain and the value is the origin key.
|
|
type: object
|
|
type: object
|
|
VippsDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
telephoneNumber:
|
|
description: ''
|
|
type: string
|
|
type:
|
|
default: vipps
|
|
description: '**vipps**'
|
|
enum:
|
|
- vipps
|
|
type: string
|
|
required:
|
|
- telephoneNumber
|
|
title: Vipps
|
|
type: object
|
|
VisaCheckoutDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
fundingSource:
|
|
description: The funding source that should be used when multiple sources
|
|
are available. For Brazilian combo cards, by default the funding source
|
|
is credit. To use debit, set this value to **debit**.
|
|
enum:
|
|
- credit
|
|
- debit
|
|
type: string
|
|
type:
|
|
default: visacheckout
|
|
description: '**visacheckout**'
|
|
enum:
|
|
- visacheckout
|
|
type: string
|
|
visaCheckoutCallId:
|
|
description: The Visa Click to Pay Call ID value. When your shopper selects
|
|
a payment and/or a shipping address from Visa Click to Pay, you will receive
|
|
a Visa Click to Pay Call ID.
|
|
type: string
|
|
required:
|
|
- visaCheckoutCallId
|
|
title: Visa Checkout
|
|
type: object
|
|
WeChatPayDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
type:
|
|
default: wechatpay
|
|
description: '**wechatpay**'
|
|
enum:
|
|
- wechatpay
|
|
- wechatpay_pos
|
|
type: string
|
|
title: WeChat Pay
|
|
type: object
|
|
WeChatPayMiniProgramDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
appId:
|
|
type: string
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
openid:
|
|
type: string
|
|
type:
|
|
default: wechatpayMiniProgram
|
|
description: '**wechatpayMiniProgram**'
|
|
enum:
|
|
- wechatpayMiniProgram
|
|
type: string
|
|
title: WeChat Pay - Mini Program
|
|
type: object
|
|
ZipDetails:
|
|
additionalProperties: false
|
|
properties:
|
|
checkoutAttemptId:
|
|
x-addedInVersion: '68'
|
|
description: The checkout attempt identifier.
|
|
type: string
|
|
clickAndCollect:
|
|
description: Set this to **true** if the shopper would like to pick up and
|
|
collect their order, instead of having the goods delivered to them.
|
|
type: string
|
|
recurringDetailReference:
|
|
deprecated: true
|
|
x-deprecatedInVersion: '49'
|
|
x-deprecatedMessage: Use `storedPaymentMethodId` instead.
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
type: string
|
|
storedPaymentMethodId:
|
|
x-addedInVersion: '49'
|
|
description: This is the `recurringDetailReference` returned in the response
|
|
when you created the token.
|
|
maxLength: 64
|
|
type: string
|
|
type:
|
|
default: zip
|
|
description: '**zip**'
|
|
enum:
|
|
- zip
|
|
- zip_pos
|
|
type: string
|
|
title: Zip
|
|
type: object
|
|
securitySchemes:
|
|
ApiKeyAuth:
|
|
in: header
|
|
name: X-API-Key
|
|
type: apiKey
|
|
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.
|
|
value:
|
|
status: 400
|
|
errorCode: '702'
|
|
message: 'Unexpected input: ", expected: }'
|
|
errorType: validation
|
|
generic-401:
|
|
summary: Response code 401. Unauthorized.
|
|
value:
|
|
status: 401
|
|
errorCode: '000'
|
|
message: HTTP Status Response - Unauthorized
|
|
errorType: security
|
|
generic-403:
|
|
summary: Response code 403. Forbidden.
|
|
value:
|
|
status: 403
|
|
errorCode: '901'
|
|
message: Invalid Merchant Account
|
|
errorType: security
|
|
pspReference: 881611827877203B
|
|
generic-422:
|
|
summary: Response code 422. Unprocessable entity.
|
|
value:
|
|
status: 422
|
|
errorCode: '14_030'
|
|
message: Return URL is missing.
|
|
errorType: validation
|
|
pspReference: '8816118280275544'
|
|
generic-500:
|
|
summary: Response code 500. Internal server error.
|
|
value:
|
|
status: 500
|
|
errorCode: '905'
|
|
message: Payment details are not supported
|
|
errorType: configuration
|
|
pspReference: '8516091485743033'
|
|
get-paymentLinks-linkId-basic-200:
|
|
summary: Payment link details
|
|
value:
|
|
amount:
|
|
currency: EUR
|
|
value: 8700
|
|
countryCode: NL
|
|
expiresAt: '2021-04-08T14:06:39Z'
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
reference: shopper-reference-ekvL83
|
|
shopperLocale: hu-HU
|
|
shopperReference: shopper-reference-LZfdWZ
|
|
status: active
|
|
url: https://test.adyen.link/PL61C53A8B97E6915A
|
|
id: PL61C53A8B97E6915A
|
|
get-sessions-sessionId-success-200:
|
|
summary: 'Response code: 200 - Success'
|
|
description: The status of the session with the specified ID.
|
|
value:
|
|
id: CS12345678
|
|
status: completed
|
|
get-storedPaymentMethods-success-200:
|
|
summary: List of stored payment methods for specified shopper
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
storedPaymentMethods:
|
|
- brand: visa
|
|
expiryMonth: '10'
|
|
expiryYear: '30'
|
|
holderName: John Smith
|
|
id: '7219687191761347'
|
|
issuerName: ISSUER_NAME
|
|
lastFour: '1111'
|
|
name: VISA
|
|
shopperEmail: john.smith@example.com
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
supportedRecurringProcessingModels:
|
|
- CardOnFile
|
|
- Subscription
|
|
- UnscheduledCardOnFile
|
|
type: scheme
|
|
patch-paymentLinks-linkId-basic:
|
|
summary: Update the status of a payment link
|
|
value:
|
|
status: expired
|
|
patch-paymentLinks-linkId-basic-200:
|
|
summary: Payment link status updated
|
|
value:
|
|
amount:
|
|
currency: EUR
|
|
value: 8700
|
|
countryCode: NL
|
|
expiresAt: '2021-04-08T14:06:39Z'
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
reference: shopper-reference-ekvL83
|
|
shopperLocale: hu-HU
|
|
shopperReference: shopper-reference-LZfdWZ
|
|
status: expired
|
|
url: https://test.adyen.link/PL61C53A8B97E6915A
|
|
id: PL61C53A8B97E6915A
|
|
post-applePay-sessions-basic:
|
|
summary: Get payment session for Apple Pay
|
|
value:
|
|
displayName: YOUR_MERCHANT_NAME
|
|
domainName: YOUR_DOMAIN_NAME
|
|
merchantIdentifier: YOUR_MERCHANT_ID
|
|
post-applePay-sessions-basic-200:
|
|
summary: Payment session data for Apple Pay
|
|
value:
|
|
data: eyJ2Z...
|
|
post-cancels-cancel-with-own-reference:
|
|
summary: Cancel a payment using your own reference
|
|
description: Example cancel request with your own reference
|
|
value:
|
|
paymentReference: YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT
|
|
reference: YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-cancels-cancel-with-own-reference-201:
|
|
summary: Payment cancellation requested
|
|
description: Example response when a payment cancellation was requested
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
paymentReference: YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT
|
|
reference: YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION
|
|
pspReference: 993617894906488A
|
|
status: received
|
|
post-cardDetails-basic:
|
|
summary: Get a list of brands on a card with the unencrypted card number
|
|
description: Example request for getting a list of brands on a card using the
|
|
first 6 digits of the card number.
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
cardNumber: '411111'
|
|
post-cardDetails-basic-200:
|
|
summary: List of brands on the card
|
|
description: Example response when the card is co-branded.
|
|
value:
|
|
brands:
|
|
- type: visa
|
|
supported: true
|
|
- type: cartebancaire
|
|
supported: true
|
|
fundingSource: CREDIT
|
|
isCardCommercial: false
|
|
issuingCountryCode: FR
|
|
post-cardDetails-supported-brands:
|
|
summary: Get a list of brands on a card specifying your supported card brands
|
|
description: Example request for getting a list of brands on a card using the
|
|
first 6 digits of the card number and including the card brands you support.
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
cardNumber: '411111'
|
|
supportedBrands:
|
|
- visa
|
|
- mc
|
|
- amex
|
|
post-cardDetails-supported-brands-200:
|
|
summary: List of brands on the card when you specify your supported card brands
|
|
description: Example response when the card is co-branded, and you only support
|
|
Visa.
|
|
value:
|
|
brands:
|
|
- type: visa
|
|
supported: true
|
|
- type: cartebancaire
|
|
supported: false
|
|
fundingSource: CREDIT
|
|
isCardCommercial: false
|
|
issuingCountryCode: FR
|
|
post-donationCampaigns-donation-campaigns:
|
|
summary: Get a list of active donation campaigns
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
currency: EUR
|
|
post-donationCampaigns-donation-campaigns-200:
|
|
summary: List of active donation campaigns
|
|
value:
|
|
donationCampaigns:
|
|
- id: DONATION_CAMPAIGN_ID
|
|
campaignName: DONATION_CAMPAIGN_NAME
|
|
donation:
|
|
currency: EUR
|
|
type: fixedAmounts
|
|
donationType: fixedAmounts
|
|
values:
|
|
- 100
|
|
- 200
|
|
- 300
|
|
nonprofitName: NONPROFIT_NAME
|
|
causeName: NONPROFIT_CAUSE
|
|
nonprofitDescription: NONPROFIT_DESCRIPTION.
|
|
nonprofitUrl: NONPROFIT_WEBSITE_URL
|
|
logoUrl: NONPROFIT_LOGO_URL
|
|
bannerUrl: NONPROFIT_BANNER_URL
|
|
termsAndConditionsUrl: NONPROFIT_TERMS_AND_CONDITIONS_URL
|
|
- id: DONATION_CAMPAIGN_ID
|
|
campaignName: DONATION_CAMPAIGN_NAME
|
|
donation:
|
|
currency: EUR
|
|
type: roundup
|
|
donationType: roundup
|
|
maxRoundupAmount: 100
|
|
nonprofitName: NONPROFIT_NAME
|
|
causeName: NONPROFIT_CAUSE
|
|
nonprofitDescription: NONPROFIT_DESCRIPTION.
|
|
nonprofitUrl: NONPROFIT_WEBSITE_URL
|
|
logoUrl: NONPROFIT_LOGO_URL
|
|
bannerUrl: NONPROFIT_BANNER_URL
|
|
termsAndConditionsUrl: NONPROFIT_TERMS_AND_CONDITIONS_URL
|
|
post-donations-donations:
|
|
summary: Start a donation transaction
|
|
value:
|
|
amount:
|
|
currency: EUR
|
|
value: 1000
|
|
reference: YOUR_DONATION_REFERENCE
|
|
paymentMethod:
|
|
type: scheme
|
|
donationToken: YOUR_DONATION_TOKEN
|
|
donationOriginalPspReference: 991559660454807J
|
|
donationAccount: NONPROFIT_ACCOUNT
|
|
returnUrl: https://your-company.example.com/...
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
shopperInteraction: ContAuth
|
|
post-donations-donations-200:
|
|
summary: Successful donation transaction
|
|
value:
|
|
id: UNIQUE_RESOURCE_ID
|
|
status: completed
|
|
donationAccount: NONPROFIT_ACCOUNT
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
amount:
|
|
currency: EUR
|
|
value: 1000
|
|
reference: YOUR_DONATION_REFERENCE
|
|
payment:
|
|
pspReference: '8535762347980628'
|
|
resultCode: Authorised
|
|
amount:
|
|
currency: EUR
|
|
value: 1000
|
|
merchantReference: YOUR_DONATION_REFERENCE
|
|
post-donations-donations-with-campaigns:
|
|
summary: Start a donation transaction for a donation campaign
|
|
value:
|
|
amount:
|
|
currency: EUR
|
|
value: 1000
|
|
reference: YOUR_DONATION_REFERENCE
|
|
paymentMethod:
|
|
type: scheme
|
|
donationToken: YOUR_DONATION_TOKEN
|
|
donationOriginalPspReference: 991559660454807J
|
|
donationCampaignId: DONATION_CAMPAIGN_ID
|
|
returnUrl: https://your-company.example.com/...
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-donations-donations-with-campaigns-200:
|
|
summary: Successful donation to a donation campaign
|
|
value:
|
|
id: UNIQUE_RESOURCE_ID
|
|
status: completed
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
amount:
|
|
currency: EUR
|
|
value: 1000
|
|
reference: YOUR_DONATION_REFERENCE
|
|
payment:
|
|
pspReference: '8535762347980628'
|
|
resultCode: Authorised
|
|
amount:
|
|
currency: EUR
|
|
value: 1000
|
|
merchantReference: YOUR_DONATION_REFERENCE
|
|
post-donations-donations-with-token:
|
|
summary: Start a donation transaction with a token
|
|
value:
|
|
amount:
|
|
currency: EUR
|
|
value: 1000
|
|
reference: YOUR_DONATION_REFERENCE
|
|
paymentMethod:
|
|
type: scheme
|
|
recurringDetailReference: '7219687191761347'
|
|
returnUrl: https://your-company.example.com/...
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
donationAccount: NONPROFIT_ACCOUNT
|
|
shopperInteraction: ContAuth
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
recurringProcessingModel: CardOnFile
|
|
post-donations-donations-with-token-200:
|
|
summary: Successful donation transaction with a token
|
|
value:
|
|
amount:
|
|
currency: EUR
|
|
value: 500
|
|
donationAccount: NONPROFIT_ACCOUNT
|
|
id: UNIQUE_RESOURCE_ID
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
payment:
|
|
pspReference: FJM726V375BV9D82
|
|
resultCode: Authorised
|
|
amount:
|
|
currency: EUR
|
|
value: 500
|
|
merchantReference: YOUR_DONATION_REFERENCE
|
|
reference: '1412563167350061'
|
|
status: completed
|
|
post-donations-donations-with-token-422:
|
|
summary: Example error response when the donation account isn't valid
|
|
value:
|
|
status: 422
|
|
errorCode: '187'
|
|
message: Field 'additionalData.donationAccount' is not valid.
|
|
errorType: validation
|
|
post-orders-basic:
|
|
summary: Create an order
|
|
value:
|
|
reference: YOUR_ORDER_REFERENCE
|
|
amount:
|
|
value: 2500
|
|
currency: EUR
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-orders-basic-200:
|
|
summary: Order created
|
|
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
|
|
amount:
|
|
currency: EUR
|
|
value: 300
|
|
post-orders-cancel-basic:
|
|
summary: Cancel an order
|
|
value:
|
|
order:
|
|
pspReference: '8815517812932012'
|
|
orderData: 823fh892f8f18f4...148f13f9f3f
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-orders-cancel-basic-200:
|
|
summary: Order cancelled
|
|
value:
|
|
pspReference: '8816178914079738'
|
|
resultCode: Received
|
|
post-originKeys-basic:
|
|
summary: Get origin keys
|
|
value:
|
|
originDomains:
|
|
- 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:
|
|
reference: YOUR_ORDER_NUMBER
|
|
amount:
|
|
value: 1250
|
|
currency: BRL
|
|
countryCode: BR
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
shopperEmail: test@email.com
|
|
shopperLocale: pt-BR
|
|
billingAddress:
|
|
street: Roque Petroni Jr
|
|
postalCode: '59000060'
|
|
city: "S\xE3o Paulo"
|
|
houseNumberOrName: '999'
|
|
country: BR
|
|
stateOrProvince: SP
|
|
deliveryAddress:
|
|
street: Roque Petroni Jr
|
|
postalCode: '59000060'
|
|
city: "S\xE3o Paulo"
|
|
houseNumberOrName: '999'
|
|
country: BR
|
|
stateOrProvince: SP
|
|
post-paymentLinks-basic-201:
|
|
summary: Payment link created
|
|
value:
|
|
amount:
|
|
currency: BRL
|
|
value: 1250
|
|
billingAddress:
|
|
city: "S\xE3o Paulo"
|
|
country: BR
|
|
houseNumberOrName: '999'
|
|
postalCode: '59000060'
|
|
stateOrProvince: SP
|
|
street: Roque Petroni Jr
|
|
countryCode: BR
|
|
deliveryAddress:
|
|
city: "S\xE3o Paulo"
|
|
country: BR
|
|
houseNumberOrName: '999'
|
|
postalCode: '59000060'
|
|
stateOrProvince: SP
|
|
street: Roque Petroni Jr
|
|
expiresAt: '2022-10-28T09:16:22Z'
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
reference: YOUR_ORDER_NUMBER
|
|
reusable: false
|
|
shopperEmail: test@email.com
|
|
shopperLocale: pt-BR
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
id: PLE83C39B0A0DE0C1E
|
|
status: active
|
|
url: https://test.adyen.link/PLE83C39B0A0DE0C1E
|
|
post-paymentMethods-balance-basic:
|
|
summary: Get gift card balance specifying amount of 10 EUR
|
|
value:
|
|
paymentMethod:
|
|
type: givex
|
|
number: '4126491073027401'
|
|
cvc: '737'
|
|
amount:
|
|
currency: EUR
|
|
value: 1000
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-paymentMethods-balance-basic-200:
|
|
summary: Gift card balance greater than amount specified in request
|
|
value:
|
|
pspReference: KHQC5N7G84BLNK43
|
|
resultCode: Success
|
|
balance:
|
|
currency: EUR
|
|
value: 5000
|
|
post-paymentMethods-balance-not-enough:
|
|
summary: Get gift card balance specifying amount of 100 EUR
|
|
value:
|
|
paymentMethod:
|
|
type: givex
|
|
number: '4126491073027401'
|
|
cvc: '737'
|
|
amount:
|
|
currency: EUR
|
|
value: 10000
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-paymentMethods-balance-not-enough-200:
|
|
summary: Gift card balance lower than amount specified in request
|
|
value:
|
|
pspReference: FKSPNCQ8HXSKGK82
|
|
resultCode: NotEnoughBalance
|
|
balance:
|
|
currency: EUR
|
|
value: 5000
|
|
post-paymentMethods-basic:
|
|
summary: Get available payment methods
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-paymentMethods-basic-200:
|
|
summary: List of available payment methods
|
|
value:
|
|
paymentMethods:
|
|
- name: ACH Direct Debit
|
|
type: ach
|
|
- name: Adyen Voucher
|
|
type: adyen_test_voucher
|
|
- name: AfterPay Invoice
|
|
type: afterpay_default
|
|
- name: AfterPay DirectDebit
|
|
type: afterpay_directdebit
|
|
- name: Afterpay
|
|
type: afterpaytouch
|
|
- name: Credit Card
|
|
type: scheme
|
|
- name: AliPay
|
|
type: alipay
|
|
- name: AliPay HK
|
|
type: alipay_hk
|
|
- name: AliPay
|
|
type: alipay_wap
|
|
- name: Android Pay
|
|
type: androidpay
|
|
- 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
|
|
- name: Online Banking India
|
|
type: billdesk_online
|
|
- name: UPI
|
|
type: billdesk_upi
|
|
- 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
|
|
- name: Alfamart
|
|
type: doku_alfamart
|
|
- name: BCA Bank Transfer
|
|
type: doku_bca_va
|
|
- name: BNI VA
|
|
type: doku_bni_va
|
|
- name: BRI VA
|
|
type: doku_bri_va
|
|
- name: CIMB VA
|
|
type: doku_cimb_va
|
|
- name: Danamon VA
|
|
type: doku_danamon_va
|
|
- name: Indomaret
|
|
type: doku_indomaret
|
|
- name: Mandiri VA
|
|
type: doku_mandiri_va
|
|
- name: OVO
|
|
type: doku_ovo
|
|
- name: Bank Transfer
|
|
type: doku_permata_lite_atm
|
|
- name: DOKU wallet
|
|
type: doku_wallet
|
|
- 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
|
|
- name: Bank Payment
|
|
type: entercash
|
|
- name: Nationale Entertainment Card
|
|
type: entertainmentcard
|
|
- name: EPS
|
|
type: eps
|
|
- name: Expert Cadeaukaart
|
|
type: expertgiftcard
|
|
- name: 3x Oney
|
|
type: facilypay_3x
|
|
- name: 4x Oney
|
|
type: facilypay_4x
|
|
- name: Fashioncheque
|
|
type: fashioncheque
|
|
- 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
|
|
- 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
|
|
- 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: Naver Pay
|
|
type: kcp_naverpay
|
|
- 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: Buy Now, Pay Later with Billie
|
|
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
|
|
- name: China Online Banking - Credit Card
|
|
type: lianlianpay_ebanking_credit
|
|
- name: China Online Banking - Debit Card
|
|
type: lianlianpay_ebanking_debit
|
|
- name: China Online Banking - Enterprise
|
|
type: lianlianpay_ebanking_enterprise
|
|
- name: Loods5 Cadeaukaart
|
|
type: loods5giftcard
|
|
- name: Loods5 Tegoedbon
|
|
type: loods5prepaidcard
|
|
- name: Love2Shop GiftCard
|
|
type: love2shop
|
|
- name: mada
|
|
type: mada
|
|
- name: Mappin & Webb Card
|
|
type: mappinwebbcard
|
|
- name: MB WAY
|
|
type: mbway
|
|
- name: Amazon Pay
|
|
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
|
|
- name: Vietnam E-Banking
|
|
type: molpay_ebanking_VN
|
|
- 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: Convenience Stores Thailand
|
|
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: Online Banking PL
|
|
type: onlineBanking_PL
|
|
- name: Online banking
|
|
type: openbanking_UK
|
|
- name: Oxxo
|
|
type: oxxo
|
|
- name: Pathe Giftcard
|
|
type: pathegiftcard
|
|
- name: PayBright
|
|
type: paybright
|
|
- name: Maya 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
|
|
- name: PayU UPI
|
|
type: payu_IN_upi
|
|
- name: EFT Pro via PayU
|
|
type: payu_ZA_eftpro
|
|
- 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
|
|
- 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
|
|
- 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: TrueMoney
|
|
type: truemoney
|
|
- name: Trustly
|
|
type: trustly
|
|
- name: Online Banking by Trustpay
|
|
type: trustpay
|
|
- name: TWINT
|
|
type: twint
|
|
- name: Ukash
|
|
type: ukash
|
|
- name: UnionPay
|
|
type: unionpay
|
|
- name: UPI Collect
|
|
type: upi_collect
|
|
- name: Valuelink
|
|
type: valuelink
|
|
- name: V&D Cadeaukaart
|
|
type: vdcadeaucard
|
|
- name: Vipps
|
|
type: vipps
|
|
- 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: SberPay
|
|
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:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
countryCode: NL
|
|
shopperLocale: nl-NL
|
|
amount:
|
|
currency: EUR
|
|
value: 1000
|
|
post-paymentMethods-filtered-200:
|
|
summary: List of available payment methods, based on the specified country and
|
|
amount
|
|
value:
|
|
paymentMethods:
|
|
- name: iDEAL
|
|
type: ideal
|
|
- name: "Hitelk\xE1rtya"
|
|
type: scheme
|
|
- name: PayPal
|
|
type: paypal
|
|
- name: AfterPay Invoice
|
|
type: afterpay_default
|
|
- name: Pay later with Klarna.
|
|
type: klarna
|
|
- 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
|
|
- name: Android Pay
|
|
type: androidpay
|
|
- 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
|
|
- name: Amazon Pay
|
|
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
|
|
- 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
|
|
- 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-stored:
|
|
summary: Get payment methods, including stored card details
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
countryCode: NL
|
|
amount:
|
|
currency: EUR
|
|
value: 1000
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
post-paymentMethods-include-stored-200:
|
|
summary: List of available payment methods, including stored payment details
|
|
value:
|
|
paymentMethods:
|
|
- name: iDEAL
|
|
type: ideal
|
|
- name: Credit Card
|
|
type: scheme
|
|
- name: PayPal
|
|
type: paypal
|
|
- name: AfterPay Invoice
|
|
type: afterpay_default
|
|
- name: Pay later with Klarna.
|
|
type: klarna
|
|
- 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
|
|
- name: Android Pay
|
|
type: androidpay
|
|
- 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
|
|
- name: Amazon Pay
|
|
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
|
|
- 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
|
|
- 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
|
|
storedPaymentMethods:
|
|
- brand: visa
|
|
expiryMonth: '10'
|
|
expiryYear: '30'
|
|
holderName: John Smith
|
|
id: '7219687191761347'
|
|
lastFour: '1111'
|
|
name: VISA
|
|
shopperEmail: john.smith@example.com
|
|
supportedShopperInteractions:
|
|
- CardOnFile
|
|
- Subscription
|
|
- UnscheduledCardOnFile
|
|
type: scheme
|
|
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
|
|
post-payments-card-3d-secure-2-web:
|
|
summary: Make a card payment with 3D Secure 2 native authentication
|
|
value:
|
|
amount:
|
|
currency: EUR
|
|
value: 1000
|
|
reference: YOUR_ORDER_NUMBER
|
|
paymentMethod:
|
|
type: scheme
|
|
encryptedCardNumber: test_4035501428146300
|
|
encryptedExpiryMonth: test_03
|
|
encryptedExpiryYear: test_2030
|
|
encryptedSecurityCode: test_737
|
|
holderName: John Smith
|
|
authenticationData:
|
|
threeDSRequestData:
|
|
nativeThreeDS: preferred
|
|
billingAddress:
|
|
country: US
|
|
city: New York
|
|
street: Redwood Block
|
|
houseNumberOrName: 37C
|
|
stateOrProvince: NY
|
|
postalCode: '10039'
|
|
shopperEmail: s.hopper@test.com
|
|
shopperIP: 192.0.2.1
|
|
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: nl-NL
|
|
colorDepth: 24
|
|
screenHeight: 723
|
|
screenWidth: 1536
|
|
timeZoneOffset: 0
|
|
javaEnabled: true
|
|
channel: Web
|
|
origin: https://your-company.com
|
|
returnUrl: https://your-company.com/checkout/
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-payments-card-3d-secure-2-web-200:
|
|
summary: Successful payment with 3D Secure 2 native authentication, using encrypted
|
|
card details
|
|
value:
|
|
resultCode: IdentifyShopper
|
|
action:
|
|
paymentData: Ab02b4c0!BQABAgCuZFJrQOjSsl\/zt+...
|
|
paymentMethodType: scheme
|
|
authorisationToken: Ab02b4c0!BQABAgAvrX03p...
|
|
subtype: fingerprint
|
|
token: eyJ0aHJlZURTTWV0aG9kTm90aWZpY...
|
|
type: threeDS2
|
|
post-payments-card-3d-secure-redirect:
|
|
summary: Make a card payment with 3D Secure redirect authentication
|
|
value:
|
|
amount:
|
|
currency: USD
|
|
value: 1000
|
|
reference: Your order number
|
|
paymentMethod:
|
|
type: scheme
|
|
number: '4212345678901237'
|
|
expiryMonth: '03'
|
|
expiryYear: '2030'
|
|
holderName: John Smith
|
|
cvc: '737'
|
|
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
|
|
javaEnabled: true
|
|
colorDepth: 10
|
|
screenHeight: 2000
|
|
screenWidth: 3000
|
|
timeZoneOffset: 5
|
|
language: en
|
|
returnUrl: https://your-company.com/...
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-payments-card-3d-secure-redirect-200:
|
|
summary: Successful payment with 3D Secure redirect authentication
|
|
value:
|
|
additionalData:
|
|
cardSummary: '5454'
|
|
threeds2.threeDS2ResponseData.messageVersion: 2.1.0
|
|
threeds2.threeDS2Token: R5CZ2NWPJTGV9D82...
|
|
threeds2.threeDSServerTransID: 8835538461311270...
|
|
cardBin: '545454'
|
|
threeds2.cardEnrolled: 'true'
|
|
paymentMethod: mc
|
|
cardPaymentMethod: mc
|
|
fundingSource: CREDIT
|
|
merchantReference: Your order number
|
|
issuerBin: '54545454'
|
|
threeds2.threeDSMethodURL: https://pal-test.adyen.com/threeds2simulator/acs/startMethod.shtml
|
|
cardIssuingCountry: PL
|
|
pspReference: JLCMPCQ8HXSKGK82
|
|
resultCode: RedirectShopper
|
|
action:
|
|
paymentMethodType: scheme
|
|
url: https://checkoutshopper-test.adyen.com/checkoutshopper/threeDS/redirect...
|
|
method: GET
|
|
type: redirect
|
|
post-payments-card-direct:
|
|
summary: Make a card payment with unencrypted card details
|
|
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-direct-200:
|
|
summary: Successful card payment with unencrypted card details
|
|
value:
|
|
additionalData:
|
|
cvcResult: 1 Matches
|
|
authCode: 044925
|
|
avsResult: 4 AVS not supported for this card type
|
|
avsResultRaw: '4'
|
|
cvcResultRaw: M
|
|
refusalReasonRaw: AUTHORISED
|
|
acquirerCode: TestPmmAcquirer
|
|
acquirerReference: 8PQMP9VEP3H
|
|
pspReference: 993617895204576J
|
|
resultCode: Authorised
|
|
merchantReference: string
|
|
post-payments-card-securedfields:
|
|
summary: Make a card payment
|
|
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-card-securedfields-200:
|
|
summary: Successful card payment
|
|
value:
|
|
additionalData:
|
|
cvcResult: 1 Matches
|
|
authCode: 065696
|
|
avsResult: 4 AVS not supported for this card type
|
|
avsResultRaw: '4'
|
|
cvcResultRaw: M
|
|
refusalReasonRaw: AUTHORISED
|
|
acquirerCode: TestPmmAcquirer
|
|
acquirerReference: 8PQMP9VIE9N
|
|
pspReference: 993617895215577D
|
|
resultCode: Authorised
|
|
merchantReference: string
|
|
post-payments-details-00.redirect:
|
|
summary: Submit the redirect result
|
|
description: Example request when submitting a redirect result
|
|
value:
|
|
details:
|
|
redirectResult: X6XtfGC3!Y...
|
|
post-payments-details-00.redirect-200:
|
|
summary: Payment authorised
|
|
description: Example response when submitting the redirect result
|
|
value:
|
|
resultCode: Authorised
|
|
pspReference: V4HZ4RBFJGXXGN82
|
|
post-payments-details-3d-secure-2-native:
|
|
summary: Submit 3D Secure 2 authentication result
|
|
value:
|
|
details:
|
|
threeDSResult: eyJ0cmFuc1N0YXR1cyI6IlkifQ==
|
|
post-payments-enableOneClick-SF:
|
|
summary: Tokenize card details for one-off payments
|
|
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_SHOPPER_REFERENCE
|
|
storePaymentMethod: true
|
|
shopperInteraction: Ecommerce
|
|
recurringProcessingModel: CardOnFile
|
|
returnUrl: https://your-company.com/...
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-payments-enableOneClick-SF-200:
|
|
summary: Card details tokenized for one-off payments
|
|
value:
|
|
additionalData:
|
|
cvcResult: 1 Matches
|
|
authCode: 082338
|
|
avsResult: 4 AVS not supported for this card type
|
|
avsResultRaw: '4'
|
|
cvcResultRaw: M
|
|
refusalReasonRaw: AUTHORISED
|
|
acquirerCode: TestPmmAcquirer
|
|
acquirerReference: 8PQMP9VC172
|
|
tokenization.shopperReference: YOUR_SHOPPER_REFERENCE
|
|
tokenization.storedPaymentMethodId: M5N7TQ4TG5PFWR50
|
|
tokenization.store.operationType: created
|
|
pspReference: 993617895195570C
|
|
resultCode: Authorised
|
|
merchantReference: string
|
|
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
|
|
returnUrl: https://your-company.com/...
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-payments-ideal-200:
|
|
summary: Successful iDEAL payment
|
|
value:
|
|
resultCode: RedirectShopper
|
|
action:
|
|
paymentMethodType: ideal
|
|
url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ
|
|
method: GET
|
|
type: redirect
|
|
post-payments-klarna:
|
|
summary: Make a Klarna payment
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
reference: YOUR_ORDER_REFERENCE
|
|
paymentMethod:
|
|
type: klarna
|
|
amount:
|
|
currency: SEK
|
|
value: 1000
|
|
shopperLocale: en_US
|
|
countryCode: SE
|
|
telephoneNumber: +46 840 839 298
|
|
shopperEmail: youremail@email.com
|
|
shopperName:
|
|
firstName: Testperson-se
|
|
lastName: Approved
|
|
shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j
|
|
billingAddress:
|
|
city: Ankeborg
|
|
country: SE
|
|
houseNumberOrName: '1'
|
|
postalCode: '12345'
|
|
street: Stargatan
|
|
deliveryAddress:
|
|
city: Ankeborg
|
|
country: SE
|
|
houseNumberOrName: '1'
|
|
postalCode: '12345'
|
|
street: Stargatan
|
|
returnUrl: https://www.your-company.com/...
|
|
lineItems:
|
|
- quantity: 1
|
|
amountExcludingTax: 331
|
|
taxPercentage: 2100
|
|
description: Shoes
|
|
id: 'Item #1'
|
|
taxAmount: 69
|
|
amountIncludingTax: 400
|
|
productUrl: URL_TO_PURCHASED_ITEM
|
|
imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM
|
|
- quantity: 2
|
|
amountExcludingTax: 248
|
|
taxPercentage: 2100
|
|
description: Socks
|
|
id: 'Item #2'
|
|
taxAmount: 52
|
|
amountIncludingTax: 300
|
|
productUrl: URL_TO_PURCHASED_ITEM
|
|
imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM
|
|
post-payments-oneclick-securedfields:
|
|
summary: Make a one-off payment with a token and CVV
|
|
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-paymentPspReference-amountUpdates-amount-update:
|
|
summary: Update the amount of an authorized payment
|
|
description: Example request to update the amount of a payment
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
amount:
|
|
currency: EUR
|
|
value: 2500
|
|
reference: YOUR_UNIQUE_REFERENCE
|
|
post-payments-paymentPspReference-amountUpdates-amount-update-201:
|
|
summary: Amount update requested
|
|
description: Example response when an amount update was requested
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
paymentPspReference: 993617894903480A
|
|
reference: YOUR_UNIQUE_REFERENCE
|
|
pspReference: 993617894906488A
|
|
status: received
|
|
amount:
|
|
currency: EUR
|
|
value: 2500
|
|
post-payments-paymentPspReference-cancels-cancel-with-psp-reference:
|
|
summary: Cancel payment using a PSP reference
|
|
description: Example cancel request with a PSP reference
|
|
value:
|
|
reference: YOUR_UNIQUE_REFERENCE
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-payments-paymentPspReference-cancels-cancel-with-psp-reference-201:
|
|
summary: Refund requested
|
|
description: Example response when a refund was requested
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
paymentPspReference: 993617894903480A
|
|
reference: YOUR_UNIQUE_REFERENCE
|
|
pspReference: 993617894906488A
|
|
status: received
|
|
post-payments-paymentPspReference-captures-capture:
|
|
summary: Capture an authorized payment
|
|
description: Example capture request
|
|
value:
|
|
reference: YOUR_UNIQUE_REFERENCE
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
amount:
|
|
value: 2000
|
|
currency: EUR
|
|
post-payments-paymentPspReference-captures-capture-201:
|
|
summary: Capture requested
|
|
description: Example response when a capture was requested
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
paymentPspReference: 993617894903480A
|
|
reference: YOUR_UNIQUE_REFERENCE
|
|
pspReference: 993617894906488A
|
|
status: received
|
|
amount:
|
|
value: 2000
|
|
currency: EUR
|
|
post-payments-paymentPspReference-captures-split-balanceplatform:
|
|
summary: Capture and split an authorized payment between balance accounts
|
|
description: Example capture request
|
|
value:
|
|
reference: YOUR_UNIQUE_REFERENCE
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
amount:
|
|
value: 2000
|
|
currency: USD
|
|
platformChargebackLogic:
|
|
behavior: deductFromOneBalanceAccount
|
|
targetAccount: BA00000000000000000000001
|
|
costAllocationAccount: BA00000000000000000000001
|
|
splits:
|
|
- amount:
|
|
value: 1500
|
|
type: BalanceAccount
|
|
account: BA00000000000000000000001
|
|
reference: Your reference for the sale amount
|
|
description: Your description for the sale amount
|
|
- amount:
|
|
value: 500
|
|
type: Commission
|
|
reference: Your reference for the commission
|
|
description: Your description for the commission
|
|
- type: PaymentFee
|
|
account: BA00000000000000000000001
|
|
reference: Your reference for the fees
|
|
description: Your description for the fees
|
|
post-payments-paymentPspReference-captures-split-balanceplatform-201:
|
|
summary: Capture requested and split between balance accounts
|
|
description: Example response when a capture was requested and split between
|
|
balance accounts
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
paymentPspReference: 993617894903480A
|
|
reference: YOUR_UNIQUE_REFERENCE
|
|
pspReference: 993617894906488A
|
|
status: received
|
|
amount:
|
|
value: 2000
|
|
currency: USD
|
|
platformChargebackLogic:
|
|
behavior: deductFromOneBalanceAccount
|
|
costAllocationAccount: BA00000000000000000000001
|
|
targetAccount: BA00000000000000000000001
|
|
splits:
|
|
- amount:
|
|
value: 1500
|
|
type: BalanceAccount
|
|
account: BA00000000000000000000001
|
|
reference: Your reference for the sale amount
|
|
description: Your description for the sale amount
|
|
- amount:
|
|
value: 500
|
|
type: Commission
|
|
reference: Your reference for the commission
|
|
description: Your description for the commission
|
|
- type: PaymentFee
|
|
account: BA00000000000000000000001
|
|
reference: Your reference for the fees
|
|
description: Your description for the fees
|
|
post-payments-paymentPspReference-captures-split-classic:
|
|
summary: Capture and split an authorized payment in the Classic Platforms integration
|
|
description: Example capture request
|
|
value:
|
|
reference: YOUR_UNIQUE_REFERENCE
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
amount:
|
|
value: 2000
|
|
currency: USD
|
|
splits:
|
|
- account: '8816080397613514'
|
|
amount:
|
|
value: 1500
|
|
reference: Your reference for the sale amount.
|
|
type: MarketPlace
|
|
- amount:
|
|
value: 500
|
|
reference: Your reference for the commission.
|
|
type: Commission
|
|
post-payments-paymentPspReference-captures-split-classic-201:
|
|
summary: Capture requested and split in the Classic Platforms integration
|
|
description: Example response when a capture was requested in the Classic Platforms
|
|
integration
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
paymentPspReference: 993617894903480A
|
|
reference: YOUR_UNIQUE_REFERENCE
|
|
pspReference: 993617894906488A
|
|
status: received
|
|
amount:
|
|
value: 2000
|
|
currency: USD
|
|
splits:
|
|
- account: '8816080397613514'
|
|
amount:
|
|
value: 1500
|
|
reference: Your reference for the sale amount.
|
|
type: MarketPlace
|
|
- amount:
|
|
value: 500
|
|
reference: Your reference for the commission.
|
|
type: Commission
|
|
post-payments-paymentPspReference-refunds-refund:
|
|
summary: Refund a payment
|
|
description: Example refund request
|
|
value:
|
|
amount:
|
|
currency: EUR
|
|
value: 2500
|
|
reference: YOUR_UNIQUE_REFERENCE
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-payments-paymentPspReference-refunds-refund-201:
|
|
summary: Refund requested
|
|
description: Example response when a refund was requested
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
paymentPspReference: 993617894903480A
|
|
reference: YOUR_UNIQUE_REFERENCE
|
|
pspReference: 993617894906488A
|
|
status: received
|
|
amount:
|
|
currency: EUR
|
|
value: 2500
|
|
post-payments-paymentPspReference-reversals-reversal:
|
|
summary: Reverse (cancel or refund) a payment
|
|
description: Example request to reverse a payment
|
|
value:
|
|
reference: YOUR_UNIQUE_REFERENCE
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-payments-paymentPspReference-reversals-reversal-201:
|
|
summary: Payment reversal requested
|
|
description: Example response when a payment reversal was requested
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
paymentPspReference: 993617894903480A
|
|
reference: YOUR_UNIQUE_REFERENCE
|
|
pspReference: 993617894906488A
|
|
status: received
|
|
post-payments-recurring:
|
|
summary: Make a subscription card payment with a token
|
|
value:
|
|
amount:
|
|
currency: USD
|
|
value: 1000
|
|
reference: Your order number
|
|
paymentMethod:
|
|
type: scheme
|
|
storedPaymentMethodId: '8316038796685850'
|
|
shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription
|
|
returnUrl: https://your-company.com/...
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
shopperInteraction: ContAuth
|
|
recurringProcessingModel: Subscription
|
|
post-payments-split-balanceplatform:
|
|
summary: Split a payment between balance accounts
|
|
value:
|
|
paymentMethod:
|
|
type: scheme
|
|
encryptedCardNumber: test_4111111111111111
|
|
encryptedExpiryMonth: test_03
|
|
encryptedExpiryYear: test_2030
|
|
encryptedSecurityCode: test_737
|
|
amount:
|
|
value: 40000
|
|
currency: USD
|
|
reference: YOUR_ORDER_NUMBER
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
returnUrl: https://your-company.com/...
|
|
platformChargebackLogic:
|
|
behavior: deductFromOneBalanceAccount
|
|
targetAccount: BA00000000000000000000001
|
|
costAllocationAccount: BA00000000000000000000001
|
|
splits:
|
|
- amount:
|
|
value: 39600
|
|
type: BalanceAccount
|
|
account: BA00000000000000000000001
|
|
reference: Your reference for the sale amount
|
|
description: Your description for the sale amount
|
|
- amount:
|
|
value: 400
|
|
type: Commission
|
|
reference: Your reference for the commission
|
|
description: Your description for the commission
|
|
- type: PaymentFee
|
|
account: BA00000000000000000000001
|
|
reference: Your reference for the fees
|
|
description: Your description for the fees
|
|
post-payments-split-balanceplatform-200:
|
|
summary: Payment split between balance accounts
|
|
value:
|
|
additionalData:
|
|
refusalReasonRaw: AUTHORISED
|
|
eci: N/A
|
|
acquirerAccountCode: YOUR_ACQUIRER_ACCOUNT
|
|
xid: N/A
|
|
threeDAuthenticated: 'false'
|
|
paymentMethodVariant: visa
|
|
issuerBin: '41111111'
|
|
payoutEligible: Y
|
|
fraudManualReview: 'false'
|
|
threeDOffered: 'false'
|
|
threeDOfferedResponse: N/A
|
|
authorisationMid: '50'
|
|
fundsAvailability: I
|
|
authorisedAmountCurrency: USD
|
|
threeDAuthenticatedResponse: N/A
|
|
avsResultRaw: '5'
|
|
retry.attempt1.rawResponse: AUTHORISED
|
|
paymentMethod: visa
|
|
avsResult: 5 No AVS data provided
|
|
cardSummary: '1111'
|
|
retry.attempt1.avsResultRaw: '5'
|
|
networkTxReference: '777718270854480'
|
|
expiryDate: 3/2030
|
|
cavvAlgorithm: N/A
|
|
cardBin: '411111'
|
|
alias: '8915844059375211'
|
|
cvcResultRaw: M
|
|
merchantReference: YOUR_ORDER_NUMBER
|
|
acquirerReference: YOUR_ACQUIRER_REFERENCE
|
|
cardIssuingCountry: NL
|
|
liabilityShift: 'false'
|
|
fraudResultType: GREEN
|
|
authCode: '035450'
|
|
cardHolderName: John Smith
|
|
isCardCommercial: unknown
|
|
PaymentAccountReference: 6006491286999921374...
|
|
retry.attempt1.acquirerAccount: YOUR_ACQUIRER_ACCOUNT
|
|
cardIssuingBank: ISSUING_BANK_CUSTOMER
|
|
retry.attempt1.acquirer: YOUR_ACQUIRER_CODE
|
|
authorisedAmountValue: '40000'
|
|
issuerCountry: NL
|
|
cvcResult: 1 Matches
|
|
retry.attempt1.responseCode: Approved
|
|
aliasType: Default
|
|
retry.attempt1.shopperInteraction: Ecommerce
|
|
cardPaymentMethod: visa
|
|
acquirerCode: YOUR_ACQUIRER_CODE
|
|
pspReference: PPKFQ89R6QRXGN82
|
|
resultCode: Authorised
|
|
amount:
|
|
currency: USD
|
|
value: 40000
|
|
donationToken: 81234567890123456...
|
|
merchantReference: YOUR_ORDER_NUMBER
|
|
post-payments-split-classic:
|
|
summary: Split a payment in a Classic Platforms integration
|
|
value:
|
|
paymentMethod:
|
|
type: scheme
|
|
encryptedCardNumber: test_4111111111111111
|
|
encryptedExpiryMonth: test_03
|
|
encryptedExpiryYear: test_2030
|
|
encryptedSecurityCode: test_737
|
|
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
|
|
encryptedCardNumber: test_4111111111111111
|
|
encryptedExpiryMonth: test_03
|
|
encryptedExpiryYear: test_2030
|
|
encryptedSecurityCode: test_737
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
storePaymentMethod: true
|
|
shopperInteraction: Ecommerce
|
|
recurringProcessingModel: Subscription
|
|
returnUrl: https://your-company.com/...
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
post-payments-subscription-first-transaction-200:
|
|
summary: Card details tokenized for a subscription
|
|
value:
|
|
additionalData:
|
|
cvcResult: 1 Matches
|
|
authCode: 098871
|
|
avsResult: 4 AVS not supported for this card type
|
|
avsResultRaw: '4'
|
|
cvcResultRaw: M
|
|
refusalReasonRaw: AUTHORISED
|
|
acquirerCode: TestPmmAcquirer
|
|
acquirerReference: 8PQMP9VD896
|
|
tokenization.shopperReference: YOUR_SHOPPER_REFERENCE
|
|
tokenization.storedPaymentMethodId: M5N7TQ4TG5PFWR50
|
|
tokenization.store.operationType: created
|
|
pspReference: 993617895199574A
|
|
resultCode: Authorised
|
|
merchantReference: string
|
|
post-paypal-updateOrder-advanced-with-delivery:
|
|
summary: Update a PayPal order with delivery methods in an Advanced flow integration
|
|
value:
|
|
pspReference: DZ4DPSHB4WD2WN82
|
|
paymentData: po7XZ...
|
|
amount:
|
|
currency: EUR
|
|
value: 12000
|
|
deliveryMethods:
|
|
- reference: '1'
|
|
description: Express Shipping
|
|
type: Shipping
|
|
amount:
|
|
currency: EUR
|
|
value: 1000
|
|
selected: true
|
|
- reference: '2'
|
|
description: Standard Ground
|
|
type: Shipping
|
|
amount:
|
|
currency: EUR
|
|
value: 500
|
|
selected: false
|
|
post-paypal-updateOrder-advanced-with-delivery-200:
|
|
summary: Order updated with delivery methods in an Advanced flow integration
|
|
value:
|
|
paymentData: po7XZ...
|
|
status: success
|
|
post-paypal-updateOrder-advanced-without-delivery:
|
|
summary: Update a PayPal order in an Advanced flow integration
|
|
value:
|
|
pspReference: HWL5D5BDLSGLNK82
|
|
paymentData: kly45P...
|
|
amount:
|
|
currency: EUR
|
|
value: 1200
|
|
post-paypal-updateOrder-advanced-without-delivery-200:
|
|
summary: Order updated with delivery methods in an Advanced flow integration
|
|
value:
|
|
paymentData: kly45P...
|
|
status: success
|
|
post-paypal-updateOrder-sessions-with-delivery:
|
|
summary: Update a PayPal order with delivery methods in a Sessions flow integration
|
|
value:
|
|
sessionId: CS12345679
|
|
paymentData: ey4YZ...
|
|
amount:
|
|
currency: EUR
|
|
value: 12000
|
|
deliveryMethods:
|
|
- reference: '1'
|
|
description: Express Shipping
|
|
type: Shipping
|
|
amount:
|
|
currency: EUR
|
|
value: 1000
|
|
selected: true
|
|
- reference: '2'
|
|
description: Standard Ground
|
|
type: Shipping
|
|
amount:
|
|
currency: EUR
|
|
value: 500
|
|
selected: false
|
|
post-paypal-updateOrder-sessions-with-delivery-200:
|
|
summary: Order updated with delivery methods in a Sessions flow integration
|
|
value:
|
|
paymentData: ey4YZ...
|
|
status: success
|
|
post-paypal-updateOrder-sessions-without-delivery:
|
|
summary: Update a PayPal order in a Sessions flow integration
|
|
value:
|
|
sessionId: CS12345679
|
|
paymentData: em9YZ...
|
|
amount:
|
|
currency: EUR
|
|
value: 8700
|
|
post-paypal-updateOrder-sessions-without-delivery-200:
|
|
summary: Order updated in a Sessions flow integration
|
|
value:
|
|
paymentData: em9YZ...
|
|
status: success
|
|
post-sessions-00.success:
|
|
summary: Create a payment session
|
|
description: Example request for creating a payment session
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
amount:
|
|
value: 100
|
|
currency: EUR
|
|
returnUrl: https://your-company.com/checkout?shopperOrder=12xy..
|
|
reference: YOUR_PAYMENT_REFERENCE
|
|
countryCode: NL
|
|
post-sessions-00.success-201:
|
|
summary: Payment session created Success.
|
|
description: Example response for creating a payment session
|
|
value:
|
|
amount:
|
|
currency: EUR
|
|
value: 100
|
|
countryCode: NL
|
|
expiresAt: '2022-01-11T13:53:18+01:00'
|
|
id: CS451F2AB1ED897A94
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
reference: YOUR_PAYMENT_REFERENCE
|
|
returnUrl: https://your-company.com/checkout?shopperOrder=12xy..
|
|
sessionData: Ab02b4c0!BQABAgBfYI29...
|
|
post-sessions-01.klarna:
|
|
summary: Create a payment session including Klarna fields
|
|
description: Example request for creating a payment session when Klarna is one
|
|
of the available payment methods
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
reference: YOUR_ORDER_REFERENCE
|
|
amount:
|
|
currency: SEK
|
|
value: 1000
|
|
shopperLocale: en_US
|
|
countryCode: SE
|
|
telephoneNumber: +46 840 839 298
|
|
shopperEmail: youremail@email.com
|
|
shopperName:
|
|
firstName: Testperson-se
|
|
lastName: Approved
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
billingAddress:
|
|
city: Ankeborg
|
|
country: SE
|
|
houseNumberOrName: '1'
|
|
postalCode: '12345'
|
|
street: Stargatan
|
|
deliveryAddress:
|
|
city: Ankeborg
|
|
country: SE
|
|
houseNumberOrName: '1'
|
|
postalCode: '12345'
|
|
street: Stargatan
|
|
dateOfBirth: '1996-09-04'
|
|
socialSecurityNumber: 0108
|
|
returnUrl: https://example.org
|
|
lineItems:
|
|
- quantity: 1
|
|
amountExcludingTax: 331
|
|
taxPercentage: 2100
|
|
description: Shoes
|
|
id: 'Item #1'
|
|
taxAmount: 69
|
|
amountIncludingTax: 400
|
|
productUrl: URL_TO_PURCHASED_ITEM
|
|
imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM
|
|
- quantity: 2
|
|
amountExcludingTax: 248
|
|
taxPercentage: 2100
|
|
description: Socks
|
|
id: 'Item #2'
|
|
taxAmount: 52
|
|
amountIncludingTax: 300
|
|
productUrl: URL_TO_PURCHASED_ITEM
|
|
imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM
|
|
post-sessions-01.klarna-201:
|
|
summary: Payment session created for a Klarna payment Success.
|
|
description: 'Example '
|
|
value:
|
|
amount:
|
|
currency: SEK
|
|
value: 1000
|
|
billingAddress:
|
|
city: Ankeborg
|
|
country: SE
|
|
houseNumberOrName: '1'
|
|
postalCode: '12345'
|
|
street: Stargatan
|
|
countryCode: SE
|
|
dateOfBirth: '1996-09-04T02:00:00+02:00'
|
|
deliveryAddress:
|
|
city: Ankeborg
|
|
country: SE
|
|
houseNumberOrName: '1'
|
|
postalCode: '12345'
|
|
street: Stargatan
|
|
expiresAt: '2022-01-11T13:57:52+01:00'
|
|
id: CSC52E9932D39ADAF3
|
|
lineItems:
|
|
- amountExcludingTax: 331
|
|
amountIncludingTax: 400
|
|
description: Shoes
|
|
id: 'Item #1'
|
|
imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM
|
|
productUrl: URL_TO_PURCHASED_ITEM
|
|
quantity: 1
|
|
taxAmount: 69
|
|
taxPercentage: 2100
|
|
- amountExcludingTax: 248
|
|
amountIncludingTax: 300
|
|
description: Socks
|
|
id: 'Item #2'
|
|
imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM
|
|
productUrl: URL_TO_PURCHASED_ITEM
|
|
quantity: 2
|
|
taxAmount: 52
|
|
taxPercentage: 2100
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
reference: YOUR_ORDER_REFERENCE
|
|
returnUrl: https://example.org
|
|
shopperEmail: youremail@email.com
|
|
shopperLocale: en_US
|
|
shopperName:
|
|
firstName: Testperson-se
|
|
lastName: Approved
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
socialSecurityNumber: 0108
|
|
telephoneNumber: +46 840 839 298
|
|
sessionData: Ab02b4c0!BQABAgBfYI29...
|
|
post-sessions-enableOneClick:
|
|
summary: Tokenize card details for one-off payments without asking shopper
|
|
description: Example request for tokenizing card details for one-off payments
|
|
without asking shopper
|
|
value:
|
|
merchantAccount: TestMerchantCheckout
|
|
amount:
|
|
value: 100
|
|
currency: EUR
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
returnUrl: https://your-company.com/checkout?shopperOrder=12xy..
|
|
reference: YOUR_PAYMENT_REFERENCE
|
|
countryCode: NL
|
|
storePaymentMethodMode: enabled
|
|
shopperInteraction: Ecommerce
|
|
recurringProcessingModel: CardOnFile
|
|
post-sessions-enableOneClick-201:
|
|
summary: Shopper's payment details tokenized
|
|
description: Example response for tokenizing the shopper's payment details
|
|
value:
|
|
amount:
|
|
currency: EUR
|
|
value: 100
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
countryCode: NL
|
|
expiresAt: '2022-01-11T13:56:05+01:00'
|
|
id: FJM726V375BV9D82
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
recurringProcessingModel: CardOnFile
|
|
reference: YOUR_PAYMENT_REFERENCE
|
|
returnUrl: https://your-company.com/checkout?shopperOrder=12xy..
|
|
shopperInteraction: Ecommerce
|
|
storePaymentMethod: true
|
|
sessionData: Ab02b4c0!BQABAgBfYI29...
|
|
post-sessions-split:
|
|
summary: Split a payment between balance accounts
|
|
value:
|
|
amount:
|
|
value: 40000
|
|
currency: USD
|
|
reference: YOUR_ORDER_NUMBER
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
returnUrl: https://your-company.com/...
|
|
splits:
|
|
- amount:
|
|
value: 39200
|
|
type: BalanceAccount
|
|
account: BA00000000000000000000001
|
|
reference: Your reference for the sale amount
|
|
description: Your description for the sale amount
|
|
- amount:
|
|
value: 400
|
|
type: Commission
|
|
reference: Your reference for the commission
|
|
description: Your description for the commission
|
|
- amount:
|
|
value: 400
|
|
account: BA00000000000000000000001
|
|
reference: Your reference for the fees
|
|
description: Your description for the fees
|
|
type: PaymentFee
|
|
post-sessions-split-201:
|
|
summary: Payment split between balance accounts
|
|
value:
|
|
amount:
|
|
currency: USD
|
|
value: 40000
|
|
expiresAt: '2023-06-26T11:01:55+02:00'
|
|
id: CSFCBC80570618EF2C
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
reference: YOUR_ORDER_NUMBER
|
|
returnUrl: https://your-company.com/...
|
|
shopperLocale: en-US
|
|
splits:
|
|
- account: BA00000000000000000000001
|
|
amount:
|
|
value: 39200
|
|
description: Your description for the sale amount
|
|
reference: Your reference for the sale amount
|
|
type: BalanceAccount
|
|
- amount:
|
|
value: 400
|
|
description: Your description for the commission
|
|
reference: Your reference for the commission
|
|
type: Commission
|
|
- amount:
|
|
value: 400
|
|
account: BA00000000000000000000001
|
|
description: Your description for the fees
|
|
reference: Your reference for the fees
|
|
type: PaymentFee
|
|
mode: embedded
|
|
sessionData: Ab02b4c0!BQABAgCjTErwAztqXSFTiZtxZMjRLYkoGbPkmvCvDX1
|
|
post-storedPaymentMethods-encrypted-card-details:
|
|
summary: Store encrypted card details for subscription payments
|
|
description: Example request for storing encrypted card details for subscription
|
|
payments
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
paymentMethod:
|
|
type: scheme
|
|
encryptedCardNumber: test_4111111111111111
|
|
encryptedExpiryMonth: test_03
|
|
encryptedExpiryYear: test_2030
|
|
encryptedSecurityCode: test_737
|
|
holderName: John Smith
|
|
recurringProcessingModel: Subscription
|
|
shopperEmail: s.hopper@test.com
|
|
shopperIP: 192.0.2.1
|
|
post-storedPaymentMethods-encrypted-card-details-201:
|
|
summary: Card details stored
|
|
description: Example for a successful response to store encrypted card details
|
|
value:
|
|
expiryMonth: '03'
|
|
expiryYear: '2030'
|
|
holderName: John Smith
|
|
id: KHQC5N7G84BLNK43
|
|
lastFour: '1111'
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
type: scheme
|
|
post-storedPaymentMethods-unencrypted-card-details:
|
|
summary: Store unencrypted card details for subscription payments
|
|
description: Example request for storing encrypted card details for subscription
|
|
payments
|
|
value:
|
|
merchantAccount: YOUR_MERCHANT_ACCOUNT
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
paymentMethod:
|
|
type: scheme
|
|
number: '4111111111111111'
|
|
expiryMonth: '03'
|
|
expiryYear: '2030'
|
|
cvc: '737'
|
|
holderName: John Smith
|
|
recurringProcessingModel: Subscription
|
|
shopperEmail: s.hopper@test.com
|
|
shopperIP: 192.0.2.1
|
|
post-storedPaymentMethods-unencrypted-card-details-201:
|
|
summary: Card details stored
|
|
description: Example for a successful response to store unencrypted card details
|
|
value:
|
|
expiryMonth: '03'
|
|
expiryYear: '2030'
|
|
holderName: John Smith
|
|
id: KHQC5N7G84BLNK43
|
|
lastFour: '1111'
|
|
shopperReference: YOUR_SHOPPER_REFERENCE
|
|
type: scheme
|