POST /submitThirdParty

This endpoint is deprecated and no longer supports new integrations. Do one of the following:

If you are building a new integration, use the POST /transfers endpoint instead.
If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.

With the Transfers API, you can:

Handle multiple payout use cases with a single API.
Use new payout functionalities, such as instant payouts to bank accounts.
Receive webhooks with more details and defined transfer states.

For more information about the payout features of the Transfers API, see our Payouts documentation.

Submits a payout using the previously stored payment details. To store payment details, use the /storeDetail API call.

The submitted payout must be confirmed or declined either by a reviewer or via /confirmThirdParty or /declineThirdParty calls.

Servers

https://pal-test.adyen.com/pal/servlet/Payout/v68

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`shopperReference`	String	Yes	The shopper's reference for the payout transaction.
`shopperName`	Object	No	The shopper's name. In case the `entityType` is `Company`, the `shopperName.lastName` must contain the company name. This field is required to update the existing `shopperName` associated with a recurring contract.
`shopperName.lastName`	String	Yes	The last name.
`shopperName.firstName`	String	Yes	The first name.
`entityType`	String	No	The type of the entity the payout is processed for. Allowed values: NaturalPerson Company This field is required to update the existing `entityType` that is associated with this recurring contract. Possible values: `"Company"` `"NaturalPerson"`
`recurring`	Object	Yes	A container for the type of recurring contract to be retrieved. The `recurring.contract` must be set to "PAYOUT".
`recurring.contract`	String	No	The type of recurring contract to be used. Possible values: `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the card security code (CVC/CVV). `RECURRING` – Payment details can be used without the card security code to initiate card-not-present transactions. `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not. `PAYOUT` – Payment details can be used to make a payout. Possible values: `"ONECLICK"` `"PAYOUT"` `"RECURRING"`
`recurring.recurringExpiry`	String	No	Date after which no further authorisations shall be performed. Only for 3D Secure 2.
`recurring.recurringFrequency`	String	No	Minimum number of days between authorisations. Only for 3D Secure 2.
`recurring.tokenService`	String	No	The name of the token service. Possible values: `"MCTOKENSERVICE"` `"AMEXTOKENSERVICE"` `"VISATOKENSERVICE"` `"TOKEN_SHARING"`
`recurring.recurringDetailName`	String	No	A descriptive name for this detail.
`shopperStatement`	String	No	The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).
`merchantAccount`	String	Yes	The merchant account identifier you want to process the transaction request with.
`additionalData`	Object	No	This field contains additional data, which may be required for a particular request.
`selectedRecurringDetailReference`	String	Yes	This is the `recurringDetailReference` you want to use for this payout. You can use the value LATEST to select the most recently used recurring detail.
`shopperEmail`	String	Yes	The shopper's email address.
`amount`	Object	Yes	A container object for the payable amount information of the transaction.
`amount.value`	Integer	Yes	The amount of the transaction, in minor units.
`amount.currency`	String	Yes	The three-character ISO currency code.
`nationality`	String	No	The shopper's nationality. A valid value is an ISO 2-character country code (e.g. 'NL'). This field is required to update the existing nationality that is associated with this recurring contract.
`fraudOffset`	Integer	No	An integer value that is added to the normal fraud score. The value can be either positive or negative.
`reference`	String	Yes	The merchant reference for this payout. This reference will be used in all communication to the merchant about the status of the payout. Although it is a good idea to make sure it is unique, this is not a requirement.
`socialSecurityNumber`	String	No	The shopper's social security number.
`dateOfBirth`	String	No	The date of birth. Format: ISO-8601; example: YYYY-MM-DD For Paysafecard it must be the same as used when registering the Paysafecard account. This field is mandatory for natural persons. This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.

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.