Skip to main content

Forward stored payment details

post/forward

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.

Endpoint destination URL
https://checkout-test.adyen.com/v71/forward
Click to copy
Idempotency-Keystring

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

baseUrlstringRequired

The base URL of the third party API, where Adyen will send the request to forward the payment details.

merchantAccountstringRequired

Your merchant account.

optionsobject

The customizations that can be applied when making a forward request.

requestobjectRequired

The details of the request 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.

storedPaymentMethodIdstringRequired

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.

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.