Sign in

v1

latestOpenAPI 3.1.02026-07-20631114.4 KB
Instant payouts

Make an instant card 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.

post/payout

Request body

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.

referencestring required

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.

selectedRecurringDetailReferencestring

The recurringDetailReference you want to use for this payment. The value LATEST can be used to select the most recently stored recurring detail.

shopperEmailstring

The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the telephoneNumber.

shopperInteraction'Ecommerce' | 'ContAuth' | 'Moto' | 'POS'

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

Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.

Your reference must not include personally identifiable information (PII) such as name or email address.

telephoneNumberstring

The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication.

Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the shopperEmail.

Response

OK - the request has succeeded.

additionalDataobject

Contains additional information about the payment. Some data fields are included only if you select them first: Go to Customer Area > Developers > Additional data.

authCodestring

Authorisation code:

  • When the payment is authorised successfully, this field holds the authorisation code for the payment.
  • When the payment is not authorised, this field is empty.
dccSignaturestring

Cryptographic signature used to verify dccQuote.

This value only applies if you have implemented Dynamic Currency Conversion. For more information, contact Support.

issuerUrlstring

The URL to direct the shopper to.

In case of SecurePlus, do not redirect a shopper to this URL.

mdstring

The payment session.

paRequeststring

The 3D request data for the issuer.

If the value is CUPSecurePlus-CollectSMSVerificationCode, collect an SMS code from the shopper and pass it in the /authorise3D request. For more information, see 3D Secure.

pspReferencestring

Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.

refusalReasonstring

If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes resultCode and refusalReason values.

For more information, see Refusal reasons.

resultCode'AuthenticationFinished' | 'AuthenticationNotRequired' | 'Authorised' | 'Cancelled' | 'ChallengeShopper' | 'Error' | 'IdentifyShopper' | 'PartiallyAuthorised' | 'Pending' | 'PresentToShopper' | 'Received' | 'RedirectShopper' | 'Refused' | 'Success'

The result of the payment. For more information, see Result codes.

Possible values:

  • AuthenticationFinished – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.
  • AuthenticationNotRequired – The transaction does not require 3D Secure authentication. Returned for standalone authentication-only integrations.
  • Authorised – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.
  • Cancelled – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.
  • ChallengeShopper – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.
  • Error – There was an error when the payment was being processed. The reason is given in the refusalReason field. This is a final state.
  • IdentifyShopper – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.
  • PartiallyAuthorised – The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.
  • Pending – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.
  • PresentToShopper – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.
  • Received – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.
  • RedirectShopper – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.
  • Refused – Indicates the payment was refused. The reason is given in the refusalReason field. This is a final state.