ADadyen
Initialization

Submit a payout

Changed on

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.

post/submitThirdParty

Request

  • Base URL
    https://pal-test.adyen.com/pal/servlet/Payout/v67
  • URL
    https://pal-test.adyen.com/pal/servlet/Payout/v67/submitThirdParty
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Request body

additionalDataobject

This field contains additional data, which may be required for a particular request.

dateOfBirthstring date

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.

entityType'NaturalPerson' | 'Company'

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.

fraudOffsetinteger

An integer value that is added to the normal fraud score. The value can be either positive or negative.

merchantAccountstring required

The merchant account identifier you want to process the transaction request with.

nationalitystring

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.

referencestring required

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.

selectedRecurringDetailReferencestring required

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.

shopperEmailstring required

The shopper's email address.

shopperReferencestring required

The shopper's reference for the payout transaction.

shopperStatementstring

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).

socialSecurityNumberstring

The shopper's social security number.

Response

OK - the request has succeeded.

additionalDataobject

This field contains additional data, which may be returned in a particular response.

pspReferencestring required

A new reference to uniquely identify this request.

refusalReasonstring

In case of refusal, an informational message for the reason.

resultCodestring required

The response:

  • In case of success, it is payout-submit-received.
  • In case of an error, an informational message is returned.

Changes

  • v67da3901e55f2dRevision changes
    • info

      added the new EXTERNAL enum value to the request property /

    • info

      added the new ONECLICK,RECURRING enum value to the request property /

  • v6774aaccd85b1cRevision changes
    • warning

      the / request property's maxLength was set to 80

    • warning

      the / request property's maxLength was set to 80