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.

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
`shopperReference`	String	Yes	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.
`options`	Object	No	The customizations that can be applied when making a forward request.
`options.tokenize`	Boolean	No	Set to true, the payment details are tokenized.
`options.dryRun`	Boolean	No	Set to true to receive a copy of the request Adyen is making to the third party in the response. Any sensitive information will be masked in the response you receive. This functionality is only available in the test environment.
`options.networkToken`	Object	No	The object that contains the details for forwarding a network token.
`options.networkToken.useNetworkToken`	Boolean	No	Set to true to forward the network token for a card.
`options.networkToken.includeCryptogram`	Boolean	No	Set to true to enable forwarding network token cryptograms.
`options.accountUpdate`	Boolean	No	Whether to check for a card account update (true) or not (false)
`request`	Object	Yes	The details of the request that you want to forward to the third-party.
`request.urlSuffix`	String	No	The suffix that Adyen needs to append to the `baseUrl` to construct the destination URL that belongs to the third party. This is usually the endpoint name for the request, for example, /payments.
`request.credentials`	String	No	Your credentials that are needed to authenticate with the third party.
`request.body`	String	Yes	The request body that you want Adyen to forward to the third party on your behalf, in string format. Include key value pairs to specify the payment details, and use placeholders for the values. Adyen replaces the placeholders with the payment details when making the request to the third party. When forwarding a network token, include a condition that checks if the network token exists, and informs Adyen of which fields to send depending on the outcome.
`request.httpMethod`	String	Yes	The HTTP method to use for the request Adyen makes on your behalf to the third party. Valid values: `"post"` `"patch"` `"put"`
`request.headers`	Object	No	The request headers that will be included in the request Adyen makes to the third party on your behalf. Supports the `{{credentials}}` placeholder.
`merchantAccount`	String	Yes	Your merchant account.
`storedPaymentMethodId`	String	Yes	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.
`baseUrl`	String	Yes	The base URL of the third party API, where Adyen will send the request to forward the payment details.

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.