Payouts to cards

Aside from paying out to bank accounts, you also have the option to send payouts to eligible Mastercard and Visa debit cards. This feature is available in Fund API version 5 and later.

When paying out to cards, the funds arrive to the cardholder within 30 minutes and there is no dependency on bank cutoffs.

Before you begin

Contact our Support Team to enable card payouts for your platform.

Step 1: Check if the card is eligible for payouts and save the card details

1. Submit a POST /payments request with your account holder's card details and the following parameters:

   • merchantAccount: Your merchant account.
   • shopperReference: Your unique account holder reference (minimum length three characters).
   • enablePayOut: Indicates if the card details should be stored for payouts. Set this to true.
   • paymentMethod: Object containing your account holder's card details.

   You can only pass raw card data if you are fully PCI compliant. Otherwise, use our Card Component to securely collect and encrypt your account holder's card details.

   If you are using the classic integration, include recurring.contract PAYOUT in your request.

2. Check the payoutEligible parameter in the response. The value should be either:

   • Y: Eligible for payout. For Mastercard, this means that the card is eligible for both domestic and cross-border payouts.
   • D: Applies only to Mastercard. Card is eligible only for domestic payouts.

   If you receive an N or U, the card cannot be used for payouts.

3. If the card is eligible for payouts, get the recurring.recurringDetailReference from the response. This is your account holder's tokenized card details. You will need this value when adding the new payout method and for submitting future payout requests.

Step 2: Add card as a payout method

1. Submit a POST /updateAccountHolder request with the following parameters:

   • shopperReference: Your unique account holder reference. The minimum length is three characters.
   • recurringDetailReference: This is the recurring.recurringDetailReference returned in the response in Step 1.

You receive a response that might contain any of the following status codes:

• HTTP 200: You can use the information returned in API response, such as the payoutMethodCode, but wait for the ACCOUNT_HOLDER_UPDATED notification before performing any business logic. The notification confirms when the new payout method has been added in our central database.
• HTTP 202: The request has been acknowledged and added to the queue. Use the response to check and confirm the changes you made. Wait for the ACCOUNT_HOLDER_UPDATED notification to confirm if the new payout method has been successfully added. Get the corresponding payoutMethodCode from the notification.

Step 3: Submit a card payout

1. Submit a POST /payoutAccountHolder using the payoutMethodCode returned in the response or notification in Step 2.

2. Wait for the ACCOUNT_HOLDER_PAYOUT notification to confirm the status of the payout.
   For more information, see Payout notifications.

See also