Process sub-entity card payouts
Last updated: July 26, 2023
Checkout.com's Integrated Platforms solution helps you facilitate sub-entity payouts to a bank account or debit card.
With on-demand payouts, sub-entity funds are paid out immediately, based on the payout instruction you make.
Note
This functionality is only available for on-demand card payouts. Scheduled card payouts are not supported currently.
Your sub-entity will not be able to receive payouts until it has passed the required onboarding checks (CSS, KYBPEP, KYC, and PEP).
Before funds can be sent to a debit card, the card must first have passed eligibility checks. This means it must be enabled to receive funds for either Visa Direct or Mastercard MoneySend. Learn more about card eligibility.
You can process payouts to cards that have been issued within regions supported by Checkout.com. For more information, see Supported countries and Requirements for compliance due diligence.
Use Frames to add the recipient's card details and convert them into a token. This will keep you PCI-compliant.
In order to create a payment instrument for use within on-demand payout requests, use the following endpoint:
get
https://api.checkout.com/accounts/entities/{entityId}/payment-instruments/
When you make an on-demand payout request, use the following endpoint to retrieve the instrument_id value:
get
https://api.checkout.com/accounts/entities/{entityId}/payment-instruments/{id}
To get a detailed view of all required and optional fields, see our API reference.
Set the destination.id field to the instrument_id value you received in the Get payment instrument details response, as follows:
If you've enabled webhook notifications, you'll receive a webhook notifying you of the payout status after you send the request.
If the card payout was successful, you'll receive a payment_approved webhook, with "response_code": "10000" and "response_summary": "Approved" fields.
If the card payout was unsuccessful, you'll receive a payment_declined webhook. The response_code you receive depends on the reason for the unsuccessful payout, as described in the response_summary field.