Payout
Introduction
With our Payout service, you can directly transfer funds to your customers via their credit/debit card.
Payouts enable you to reimburse/pay out your customers for any transaction you have not processed via our platform. Payouts are highly useful
- If you do not want to collect additional PCI-relevant data (i.e. bank account numbers) from your customers.
- If you do not want collect any PCI-relevant data at all by using tokens.
- For transactions you have processed via a different payment service provider than Worldline.
- Make sure to contact us before using this feature, as we will have to preconfigure your account.
- Do not confuse Payouts with a classical RefundPayment request on an existing transaction. Payouts are not linked to any previously processed transaction on our platform.
Process Payouts
Legal regulations require you to process a Payout only for specific reasons. Hence, you may process a Payout for one of the following:
- Gambling payout: Payout of online gambling winnings (i.e. casinos, racing wagers, lottery, digital/social gaming).
Available for Visa. - Loyalty payout: Payback of rebates, incentives or kickbacks from loyalty programs.
Available for Visa/MasterCard. - Pure refund: A reimbursement of funds you have received from your customers at one point in the past. This refers to transactions that you have not processed via our platform. The reimbursement might be related to a business dispute or the necessity to nullify a purchase.
Available for Visa/MasterCard.
To process a Payout, send a request to our dedicated Payouts endpoint:
{
"amountOfMoney": {
"amount": 1000,
"currencyCode": "EUR"
},
"cardPayoutMethodSpecificInput": {
"card": {
"cardholderName": "John Doe",
"cardNumber": "4012000033330026",
"expiryDate": "1236",
"cvv": "123"
},
"paymentProductId": 1,
"payoutReason": "Gambling"
}
}
Property |
Remarks |
---|---|
amountOfMoney |
amount: The gross amount you want to reimburse/payout. currencyCode: The ISO 4217 currency code for this amount. |
cardPayoutMethodSpecificInput |
card: The credentials of the card used for the reimbursement/payout. card.cvv is optional. Make sure to fulfill the necessary PCI DSS requirements for sending sensitive data. Alternatively, you can replace card with an existing cardPayoutMethodSpecificInput.token. paymentProductId: The numeric identifier of the payment method on our platform. Find this id in the "Überblick" chapter in the respective payment method documentation. payoutReason: The reason for the payout. Possible values:
|
Find detailed information about this object and its properties in our PayoutsAPI.
Our platform returns statusOutput.statusCode=81 for successful requests. As this is a pending status, make sure to follow up on it via GetPaymentDetails or webhooks.