Store details and submit a payout

post /storeDetailAndSubmitThirdParty

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
Click to copy

Request parameters

additionalData [string] object

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

amount Required

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

bank

A container for bank account data.

This field is mandatory if card is not provided.

billingAddress

The billing address.

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

card

A container for card data.

This field is mandatory if bank is not provided.

dateOfBirth string Required

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.

entityType string Required

The type of the entity the payout is processed for.

fraudOffset integer

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

merchantAccount string Required

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

nationality string Required
Max length: 2

The shopper's nationality.

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

recurring Required

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

The recurring.contract must be set to PAYOUT

reference string Required

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.

selectedBrand string

The name of the brand to make a payout to.

For Paysafecard it must be set to paysafecard.

shopperEmail string Required

The shopper's email address.

shopperName

The shopper's name.

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

shopperReference string Required

The shopper's reference for the payment transaction.

shopperStatement string

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

socialSecurityNumber string

The shopper's social security number.

telephoneNumber string

The shopper's phone number.

Response parameters

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.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy