Make an instant card payout
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.
Request Parameters
The amount information for the transaction (in minor units). For BIN or card verification requests, set amount to 0 (zero).
The address where to send the invoice.
The
billingAddressobject 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.
A container for card data.
Either
bankAccountorcardfield must be provided in a payment request.
An integer value that is added to the normal fraud score. The value can be either positive or negative.
The merchant account identifier, with which you want to process the transaction.
The recurring settings for the payment. Use this property when you want to enable recurring payments.
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.
The recurringDetailReference you want to use for this payment. The value LATEST can be used to select the most recently stored recurring detail.
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
shopperEmailfor all browser-based and mobile implementations.
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.
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.
The shopper's telephone 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.