Store details and submit a payout

post/storeDetailAndSubmitThirdParty

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 and stores its details for subsequent payouts.

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

Endpoint destination URL
https://pal-test.adyen.com/pal/servlet/Payout/v68/storeDetailAndSubmitThirdParty
additionalDataobject

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

amountobjectRequired

A container object for the payable amount information of the transaction.

bankobject

A container for bank account data.

This field is mandatory if card is not provided.

billingAddressobject

The billing address.

The billingAddress object is required for cross-border payouts to and from Canada. Include all of the fields within this object.

cardobject

A container for card data.

This field is mandatory if bank is not provided.

dateOfBirthstringRequired

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.

entityTypestringRequired

The type of the entity the payout is processed for.

fraudOffsetinteger

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

merchantAccountstringRequired

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

nationalitystringRequired
Max length: 2

The shopper's nationality.

A valid value is an ISO 2-character country code (e.g. 'NL').

recurringobjectRequired

A container for the type of recurring contract to be retrieved.

The recurring.contract must be set to PAYOUT

referencestringRequired

The merchant reference for this payment. 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.

selectedBrandstring

The name of the brand to make a payout to.

For Paysafecard it must be set to paysafecard.

shopperEmailstringRequired

The shopper's email address.

shopperNameobject

The shopper's name.

When the entityType is Company, the shopperName.lastName must contain the company name.

shopperReferencestringRequired

The shopper's reference for the payment 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.

telephoneNumberstring

The shopper's phone number.

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.

  • 400 - Bad Request

    A problem reading or understanding the request.

  • 401 - Unauthorized

    Authentication required.

  • 403 - Forbidden

    Insufficient permissions to process the request.

  • 422 - Unprocessable Entity

    A request validation error.

  • 500 - Internal Server Error

    The server could not process the request.