POST /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.

With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.

Servers

https://pal-test.adyen.com/pal/servlet/Payout/v68

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`shopperReference`	String	No	Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. Your reference must not include personally identifiable information (PII), for example name or email address.
`shopperName`	Object	No	The shopper's full name.
`shopperName.lastName`	String	Yes	The last name.
`shopperName.firstName`	String	Yes	The first name.
`recurring`	Object	No	The recurring settings for the payment. Use this property when you want to enable recurring payments.
`recurring.contract`	String	No	The type of recurring contract to be used. Possible values: `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the card security code (CVC/CVV). `RECURRING` – Payment details can be used without the card security code to initiate card-not-present transactions. `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not. `PAYOUT` – Payment details can be used to make a payout. Possible values: `"ONECLICK"` `"PAYOUT"` `"RECURRING"`
`recurring.recurringExpiry`	String	No	Date after which no further authorisations shall be performed. Only for 3D Secure 2.
`recurring.recurringFrequency`	String	No	Minimum number of days between authorisations. Only for 3D Secure 2.
`recurring.tokenService`	String	No	The name of the token service. Possible values: `"MCTOKENSERVICE"` `"AMEXTOKENSERVICE"` `"VISATOKENSERVICE"` `"TOKEN_SHARING"`
`recurring.recurringDetailName`	String	No	A descriptive name for this detail.
`card`	Object	No	A container for card data. Either `bankAccount` or `card` field must be provided in a payment request.
`card.issueNumber`	String	No	The issue number of the card (for some UK debit cards only).
`card.startYear`	String	No	The year component of the start date (for some UK debit cards only).
`card.cvc`	String	No	The card verification code (1-20 characters). Depending on the card brand, it is known also as: CVV2/CVC2 – length: 3 digits CID – length: 4 digits If you are using Client-Side Encryption, the CVC code is present in the encrypted data. You must never post the card details to the server. This field must be always present in a one-click payment request. When this value is returned in a response, it is always empty because it is not stored.
`card.number`	String	No	The card number (4-19 characters). Do not use any separators. When this value is returned in a response, only the last 4 digits of the card number are returned.
`card.expiryMonth`	String	No	The card expiry month. Format: 2 digits, zero-padded for single digits. For example: 03 = March 11 = November
`card.startMonth`	String	No	The month component of the start date (for some UK debit cards only).
`card.holderName`	String	No	The name of the cardholder, as printed on the card.
`card.expiryYear`	String	No	The card expiry year. Format: 4 digits. For example: 2020
`merchantAccount`	String	Yes	The merchant account identifier, with which you want to process the transaction.
`billingAddress`	Object	No	The address where to send the invoice. The `billingAddress` object is required in the following scenarios. Include all of the fields within this object. For 3D Secure 2 transactions in all browser-based and mobile implementations. For cross-border payouts to and from Canada.
`billingAddress.postalCode`	String	Yes	A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
`billingAddress.stateOrProvince`	String	No	The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada. Required for the US and Canada.
`billingAddress.country`	String	Yes	The two-character ISO-3166-1 alpha-2 country code. For example, US. If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
`billingAddress.houseNumberOrName`	String	Yes	The number or name of the house. Maximum length: 3000 characters.
`billingAddress.street`	String	Yes	The name of the street. Maximum length: 3000 characters. The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
`billingAddress.city`	String	Yes	The name of the city. Maximum length: 3000 characters.
`selectedRecurringDetailReference`	String	No	The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.
`telephoneNumber`	String	No	The shopper's telephone number.
`shopperInteraction`	String	No	Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. Possible values: `"ContAuth"` `"Ecommerce"` `"POS"` `"Moto"`
`shopperEmail`	String	No	The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.
`amount`	Object	Yes	The amount information for the transaction (in minor units). For BIN or card verification requests, set amount to 0 (zero).
`amount.value`	Integer	Yes	The amount of the transaction, in minor units.
`amount.currency`	String	Yes	The three-character ISO currency code.
`fraudOffset`	Integer	No	An integer value that is added to the normal fraud score. The value can be either positive or negative.
`fundSource`	Object	No	The person or entity funding the money.
`fundSource.shopperEmail`	String	No	Email address of the person.
`fundSource.shopperName`	Object	No	Name of the person.
`fundSource.shopperName.lastName`	String	Yes	The last name.
`fundSource.shopperName.firstName`	String	Yes	The first name.
`fundSource.card`	Object	No	Credit card data. Optional if `shopperReference` and `selectedRecurringDetailReference` are provided.
`fundSource.card.issueNumber`	String	No	The issue number of the card (for some UK debit cards only).
`fundSource.card.startYear`	String	No	The year component of the start date (for some UK debit cards only).
`fundSource.card.cvc`	String	No	The card verification code (1-20 characters). Depending on the card brand, it is known also as: CVV2/CVC2 – length: 3 digits CID – length: 4 digits If you are using Client-Side Encryption, the CVC code is present in the encrypted data. You must never post the card details to the server. This field must be always present in a one-click payment request. When this value is returned in a response, it is always empty because it is not stored.
`fundSource.card.number`	String	No	The card number (4-19 characters). Do not use any separators. When this value is returned in a response, only the last 4 digits of the card number are returned.
`fundSource.card.expiryMonth`	String	No	The card expiry month. Format: 2 digits, zero-padded for single digits. For example: 03 = March 11 = November
`fundSource.card.startMonth`	String	No	The month component of the start date (for some UK debit cards only).
`fundSource.card.holderName`	String	No	The name of the cardholder, as printed on the card.
`fundSource.card.expiryYear`	String	No	The card expiry year. Format: 4 digits. For example: 2020
`fundSource.additionalData`	Object	No	A map of name-value pairs for passing additional or industry-specific data.
`fundSource.billingAddress`	Object	No	The address where to send the invoice.
`fundSource.billingAddress.postalCode`	String	Yes	A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
`fundSource.billingAddress.stateOrProvince`	String	No	The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada. Required for the US and Canada.
`fundSource.billingAddress.country`	String	Yes	The two-character ISO-3166-1 alpha-2 country code. For example, US. If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
`fundSource.billingAddress.houseNumberOrName`	String	Yes	The number or name of the house. Maximum length: 3000 characters.
`fundSource.billingAddress.street`	String	Yes	The name of the street. Maximum length: 3000 characters. The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
`fundSource.billingAddress.city`	String	Yes	The name of the city. Maximum length: 3000 characters.
`fundSource.telephoneNumber`	String	No	Phone number of the person
`reference`	String	Yes	The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens ("-"). Maximum length: 80 characters.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.