Adyen Api Types

AdyenSavedPaymentMethodsResponse

The adyen saved payment methods response, contains data about saved cards

Property Type Description

Property	Type	Description
`id`	`string`	A unique identifier of this stored payment method.
`brand`	`string`	The brand of the card.
`lastFour`	`string`	The last four digits of the PAN.
`name`	`string`	The display name of the stored payment method.
`type`	`string`	The type of payment method.
`[key: string]`	`unknown`	Any additional information in the response.

id

string

A unique identifier of this stored payment method.

brand

string

The brand of the card.

lastFour

string

The last four digits of the PAN.

name

string

The display name of the stored payment method.

type

string

The type of payment method.

[key: string]

unknown

Any additional information in the response.

CreatePaymentSessionRequest

The request to create a Payment Session.

Property Type Description

Property	Type	Description
`amount`	`{ / * The monetary amount. / amount: number / The currency. */ currency: string }`	The amount of the payment.
`reference`	`string`	The reference to uniquely identify a payment. For example, the payment owner ID (Cart ID etc).
`returnUrl`	`string`	The URL to return to when a redirect payment is completed.
`recurringProcessingModel?`	`string`	Defines a recurring payment type. Required when creating a token to store payment details. Allowed values: <ul> <li>Subscription – A transaction for a fixed or variable amount, which follows a fixed schedule.</li> <li>CardOnFile – 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.</li> <li>UnscheduledCardOnFile – 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.</li> </ul>
`storePaymentMethodMode?`	`string`	Indicates if the details of the payment method will be stored for the shopper. Possible values: <ul> <li>disabled – No details will be stored (default).</li> <li>askForConsent – If the shopperReference is provided, the UI lets the shopper choose if they want their payment details to be stored.</li> <li>enabled – If the shopperReference is provided, the details will be stored without asking the shopper for consent.</li> </ul>
`metadata?`	`Record<string, unknown>`	Metadata consists of entries, each of which includes a key and a value. Limits: <ul> <li>Maximum 20 key-value pairs per request.</li> <li>Maximum 20 characters per key.</li> <li>Maximum 80 characters per value.</li> </ul>
`[key: string]`	`unknown`	Any additional information for the request.

amount

{ / * The monetary amount. */ amount: number / * The currency. */ currency: string }

The amount of the payment.

reference

string

The reference to uniquely identify a payment. For example, the payment owner ID (Cart ID etc).

returnUrl

string

The URL to return to when a redirect payment is completed.

recurringProcessingModel?

string

Defines a recurring payment type. Required when creating a token to store payment details. Allowed values:

<ul>
  <li>Subscription – A transaction for a fixed or variable amount, which follows a fixed schedule.</li>
  <li>CardOnFile – 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.</li>
  <li>UnscheduledCardOnFile – 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.</li>
</ul>

storePaymentMethodMode?

string

Indicates if the details of the payment method will be stored for the shopper. Possible values: <ul> <li>disabled – No details will be stored (default).</li> <li>askForConsent – If the shopperReference is provided, the UI lets the shopper choose if they want their payment details to be stored.</li> <li>enabled – If the shopperReference is provided, the details will be stored without asking the shopper for consent.</li> </ul>

metadata?

Record<string, unknown>

Metadata consists of entries, each of which includes a key and a value. Limits:

<ul>
  <li>Maximum 20 key-value pairs per request.</li>
  <li>Maximum 20 characters per key.</li>
  <li>Maximum 80 characters per value.</li>
</ul>

[key: string]

unknown

Any additional information for the request.

CreatePaymentSessionResponse

The session response contains encrypted payment session data

Property Type Description

Property	Type	Description
`id`	`string`	A unique identifier of the session.
`sessionData`	`string`	The payment session data you need to pass to your front end.
`[key: string]`	`unknown`	Any additional information in the response.

id

string

A unique identifier of the session.

sessionData

string

The payment session data you need to pass to your front end.

[key: string]

unknown

Any additional information in the response.

GetPaymentMethodsRequest

Property Type Description

Property	Type	Description
`amount?`	`MonetaryAmount`	The amount information for the transaction.
`countryCode?`	`string`	The shopper’s country code.
`shopperLocale?`	`string`	The combination of a language code and a country code to specify the language to be used in the payment.
`shopperReference?`	`string`	Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.
`order?`	`{ / The encrypted order data. / orderData: string / The pspReference that belongs to the order. / pspReference: string }`	The order information required for partial payments.
`[key: string]`	`unknown`	Any additional information for the request.

amount?

MonetaryAmount

The amount information for the transaction.

countryCode?

string

The shopper’s country code.

shopperLocale?

string

The combination of a language code and a country code to specify the language to be used in the payment.

shopperReference?

string

Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.

order?

{ / The encrypted order data. */ orderData: string / The pspReference that belongs to the order. */ pspReference: string }

The order information required for partial payments.

[key: string]

unknown

Any additional information for the request.

PaymentMethod

Property Type Description

Property	Type	Description
`type`	`string`	The unique payment method code.
`name`	`string`	The displayable name of this payment method.
`details?`	`object`	All input details to be provided to complete the payment with this payment method.
`configuration?`	`object`	Configuration props as set by the merchant in the CA and received in the PM object in the /paymentMethods response
`brand?`	`string`	Brand for the selected gift card. For example: plastix, hmclub.
`brands?`	`string[]`	List of possible brands. For example: visa, mc.
`fundingSource?`	`string`	The funding source of the payment method.
`group?`	`PaymentMethodGroup`	The group where this payment method belongs to.

type

string

The unique payment method code.

name

string

The displayable name of this payment method.

details?

object

All input details to be provided to complete the payment with this payment method.

configuration?

object

Configuration props as set by the merchant in the CA and received in the PM object in the /paymentMethods response

brand?

string

Brand for the selected gift card. For example: plastix, hmclub.

brands?

string[]

List of possible brands. For example: visa, mc.

fundingSource?

string

The funding source of the payment method.

group?

PaymentMethodGroup

The group where this payment method belongs to.

PaymentMethodGroup

The group where this payment method belongs to.

Property Type Description

Property	Type	Description
`name`	`string`	The name of the group.
`paymentMethodData`	`string`	Echo data to be used if the payment method is displayed as part of this group.
`type`	`string`	The unique code of the group.

name

string

The name of the group.

paymentMethodData

string

Echo data to be used if the payment method is displayed as part of this group.

type

string

The unique code of the group.

PaymentMethodsResponse

Property Type Description

Property	Type	Description
`paymentMethods?`	`PaymentMethod[]`	/** Detailed list of payment methods required to generate payment forms.
`storedPaymentMethods?`	`StoredPaymentMethod[]`	List of all stored payment methods.

paymentMethods?

PaymentMethod[]

/** Detailed list of payment methods required to generate payment forms.

storedPaymentMethods?

StoredPaymentMethod[]

List of all stored payment methods.

StoredPaymentMethod

extends PaymentMethod

Property Type Description

Property	Type	Description
`supportedShopperInteractions`	`string[]`	The supported shopper interactions for this stored payment method.
`storedPaymentMethodId?`	`string`	A unique identifier of this stored payment method. Mapped from 'storedPaymentMethod.id'

supportedShopperInteractions

string[]

The supported shopper interactions for this stored payment method.

storedPaymentMethodId?

string

A unique identifier of this stored payment method. Mapped from 'storedPaymentMethod.id'