v1

latestOpenAPI 3.1.02026-07-20631114.4 KB

Initialization

Store payout details

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

If you are building a new integration, use the Transfers API 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.

Stores payment details under the PAYOUT recurring contract. These payment details can be used later to submit a payout via the /submitThirdParty call.

post/storeDetail

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

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.

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.

recurringDetailReferencestring required

The token which you can use later on for submitting the payout.

resultCodestring required

The result code of the transaction. Success indicates that the details were stored successfully.