POST /storedPaymentMethods

Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments.

Servers

https://checkout-test.adyen.com/v71

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Idempotency-Key`	String	No	A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request body fields

Name	Type	Required	Description
`paymentMethod`	Object	Yes	Contains the information required to store a payment method.
`paymentMethod.encryptedSecurityCode`	String	No	The encrypted card verification code.
`paymentMethod.cvc`	String	No	The card verification code. Only collect raw card data if you are fully PCI compliant.
`paymentMethod.brand`	String	No	Secondary brand of the card. For example: plastix, hmclub.
`paymentMethod.number`	String	No	The card number. Only collect raw card data if you are fully PCI compliant.
`paymentMethod.expiryMonth`	String	No	The card expiry month. Only collect raw card data if you are fully PCI compliant.
`paymentMethod.holderName`	String	No	The name of the card holder.
`paymentMethod.type`	String	No	Set to scheme.
`paymentMethod.encryptedExpiryYear`	String	No	The encrypted card expiry year.
`paymentMethod.encryptedCardNumber`	String	No	The encrypted card number.
`paymentMethod.encryptedExpiryMonth`	String	No	The encrypted card expiry month.
`paymentMethod.expiryYear`	String	No	The card expiry year. Only collect raw card data if you are fully PCI compliant.
`shopperReference`	String	Yes	A unique identifier for the shopper (for example, user ID or account ID).
`shopperEmail`	String	No	The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.
`shopperIP`	String	No	The IP address of a shopper.
`merchantAccount`	String	Yes	The merchant account identifier, with which you want to process the transaction.
`recurringProcessingModel`	String	Yes	Defines a recurring payment type. Required when creating a token to store payment details. Allowed values: `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. `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. `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. Possible values: `"CardOnFile"` `"Subscription"` `"UnscheduledCardOnFile"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.