Sample - Adyen Checkout API
POST/forward

Forward stored payment details

Forwards the payment details you stored with Adyen to a third-party that you specify and returns the response from the third-party. Supports forwarding stored card details or network tokens. For more information, see Forward stored payment details.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 9 body fields
Idempotency-Keystringoptional
A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
amountobjectoptional
The amount of the forwarded payment.
baseUrlstringrequired
The base URL of the third party API, where Adyen will send the request to forward the payment details.
merchantAccountstringrequired
Your merchant account.
merchantReferencestringoptional
Merchant defined payment reference.
optionsobjectoptional
The customizations that can be applied when making a forward request.
paymentMethodobjectoptional
The card details.
requestobjectrequired
The [details of the request](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#request-to-adyen-card) that you want to forward to the third-party.
shopperReferencestringrequired
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.
storedPaymentMethodIdstringoptional
The unique identifier of the token that you want to forward to the third party. This is the `storedPaymentMethodId` you received in the webhook after you created the token.

1 status code
200OK - the request has succeeded.
merchantReferencestringoptional
Merchant defined payment reference.
pspReferencestringoptional
Adyen's 16-character reference associated with the transaction/request. This value is globally unique. Use this reference when you communicate with us about this request.
responseobjectrequired
The details of the response Adyen received from the third party.
storedPaymentMethodIdstringoptional
The unique identifier of the token.