Initialization

Store details and submit a payout

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.

post/storeDetailAndSubmitThirdParty

Request body

additionalDataobject

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

dateOfBirthstring date 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'NaturalPerson' | 'Company' required

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.

merchantAccountstring required

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

nationalitystring required

The shopper's nationality.

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

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

selectedBrandstring

The name of the brand to make a payout to.

For Paysafecard it must be set to paysafecard.

shopperEmailstring required

The shopper's email address.

shopperReferencestring required

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.

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 is payout-submit-received.
In case of an error, an informational message is returned.

Changes

Changed in 8 of the 50 revisions of this API.35616

Sep 26, 2025v304387df056b522See the full diff
- ○
  added the new EXTERNAL enum value to the request property recurring/contract
  request-property-enum-value-added
- ○
  added the new ONECLICK,RECURRING enum value to the request property recurring/contract
  request-property-enum-value-added
Mar 5, 2024v306bd9730338ee2See the full diff
- ●
  the shopperName/firstName request property's maxLength was set to 80
  request-property-max-length-set
- ●
  the shopperName/lastName request property's maxLength was set to 80
  request-property-max-length-set
Oct 30, 2023v30c5e2ec8ac7912See the full diff
- ○
  added the new AMEXTOKENSERVICE enum value to the request property recurring/tokenService
  request-property-enum-value-added
- ○
  added the new TOKEN_SHARING enum value to the request property recurring/tokenService
  request-property-enum-value-added
Apr 19, 2023v302545ac72463d144See the full diff
- ▲
  the request's body type/format changed from / to object/
  request-body-type-changed
- ▲
  the amount request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the bank request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the billingAddress request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the card request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the dateOfBirth request property type/format changed from string/date-time to string/date
  request-property-type-changed
- ▲
  the recurring request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the shopperName request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 200
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 400
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 403
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 422
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 500
  response-body-type-changed
- ○
  the request property card/expiryMonth became optional
  request-property-became-optional
- ○
  the request property card/expiryYear became optional
  request-property-became-optional
- ○
  the request property card/holderName became optional
  request-property-became-optional
- ○
  the request property card/number became optional
  request-property-became-optional
Feb 15, 2022v30be74481ccfa33See the full diff
- ●
  the billingAddress/city request property's maxLength was set to 3000
  request-property-max-length-set
- ●
  the billingAddress/houseNumberOrName request property's maxLength was set to 3000
  request-property-max-length-set
- ●
  the billingAddress/street request property's maxLength was set to 3000
  request-property-max-length-set
Aug 7, 2021v303678fe50cd783See the full diff
- ○
  the endpoint scheme security ApiKeyAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security BasicAuth was added to the API
  api-security-added
- ○
  api tag Initialization added
  api-tag-added
Jul 7, 2021v308c8395a6ff001See the full diff
- ●
  removed the request property shopperName/infix
  request-property-removed
Apr 24, 2021v30d3222f72d182215See the full diff
- ▲
  the request's body type/format changed from object/ to /
  request-body-type-changed
- ▲
  the request property card/expiryMonth became required
  request-property-became-required
- ▲
  the request property card/expiryYear became required
  request-property-became-required
- ▲
  the request property card/holderName became required
  request-property-became-required
- ▲
  the request property card/number became required
  request-property-became-required
- ▲
  removed the enum value AMEXTOKENSERVICE of the request property recurring/tokenService
  request-property-enum-value-removed
- ▲
  removed the enum value EXTERNAL of the request property recurring/contract
  request-property-enum-value-removed
- ▲
  removed the enum value ONECLICK,RECURRING of the request property recurring/contract
  request-property-enum-value-removed
- ▲
  removed the enum value TOKEN_SHARING of the request property recurring/tokenService
  request-property-enum-value-removed
- ▲
  the amount request property type/format changed from object/ to /
  request-property-type-changed
- ▲
  the bank request property type/format changed from object/ to /
  request-property-type-changed
- ▲
  the billingAddress request property type/format changed from object/ to /
  request-property-type-changed
- ▲
  the card request property type/format changed from object/ to /
  request-property-type-changed
- ▲
  the recurring request property type/format changed from object/ to /
  request-property-type-changed
- ▲
  the shopperName request property type/format changed from object/ to /
  request-property-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 200
  response-body-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 400
  response-body-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 403
  response-body-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 422
  response-body-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 500
  response-body-type-changed
- ○
  the endpoint scheme security ApiKeyAuth was removed from the API
  api-security-removed
- ○
  the endpoint scheme security BasicAuth was removed from the API
  api-security-removed
- ○
  api tag Initialization removed
  api-tag-removed
- ○
  added the new optional request property shopperName/infix
  new-optional-request-property
- ○
  the dateOfBirth request property type/format was generalized from string/date to string/date-time
  request-property-type-generalized
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history