Online Card Payout
In this section you will learn how to process an Online Card Payout.
Overview
A Payout transaction, often known as a "credit transfer" or "reverse payment," is a financial operation where funds are transferred from a merchant's account to a customer's debit or credit card. This type of transaction is distinct from a standard refund as it's typically used for purposes other than reversing a previous purchase. Card Payouts are commonly utilized for rewarding customers, disbursing cashback offers, processing insurance claims, or facilitating winnings from gaming platforms.
This transaction type is particularly valued for its directness and efficiency, as it allows merchants to transfer funds directly to a cardholder’s account, bypassing the need for bank account details or other intermediate steps. For customers, the convenience of receiving payments directly to their cards offers a seamless and satisfying experience.
Implementing Card Payouts can enhance your customer engagement and satisfaction, and can be a unique selling proposition, especially in sectors like insurance or online gaming where quick payouts are a competitive advantage. However, it's important for merchants to be aware of the regulatory environment surrounding these transactions, as they often require adherence to anti-money laundering (AML) and know your customer (KYC) regulations. Additionally, the speed of transaction processing can vary depending on the card networks and issuing banks involved.
In summary, Card Payout transactions are an effective tool for direct monetary transfers to customers, offering benefits in terms of customer satisfaction and operational efficiency, but they also require careful consideration of regulatory compliance and transaction processing times.
Online Card Payout: Key Field Descriptions
Here are the key fields required for an online card payout request and their descriptions:
- transactionMethod: Details the method of the transaction:
- intent: Specifies the purpose of the transaction, here set to Payout .
- entryType: Indicates the transaction's entry mode, which is Ecom for online transactions.
- fundingType: Identifies the funding source, in this case, Card .
- card: Contains the cardholder's information:
- number: The card number, here represented as '4111111111111111'.
- expiryMonth: The expiration date of the card, provided as month ('03').
- expiryYear: The expiration date of the card, provided year ('2025').
- holderName: The name of the cardholder, here 'Mr John Doe'.
{
"merchant": "MERCHANT-1",
"site": "SITE-1",
"merchantOrderId": "This_is_my_merchant_order_reference",
"merchantTransactionId": "This_is_my_merchant_transaction_reference",
"transactionMethod": {
"intent": "Payout",
"entryType": "Ecom",
"fundingType": "Card"
},
"card": {
"number": "4111111111111111",
"expiryMonth": "03",
"expiryYear": "2025",
"holderName": "Mr John Doe"
},
"amounts": {
"transaction": 30.32,
"currency": "EUR"
},
"shopper": {
"id": "Shopper_01",
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1980-03-01",
"email": "[email protected]"
}
}
Understanding your Online Card Payout Transaction Response
After processing an online card payout, you'll receive a response containing several key fields. Each field provides valuable information about the transaction's outcome. Here’s a breakdown of what each field in the response means:
- state: Indicates the current state of the transaction, e.g., 'Authorised' shows the transaction was successfully authorised.
- stateMessage: A descriptive message about the transaction state, providing additional context to the state field.
- approvalCode: A code provided by the card issuer when a transaction is authorised, essential for confirming transaction approval.
- fundingSource: Type of funding source used, such as 'Credit' for credit card transactions.
- issuerCountry: The country code of the card issuer, in this case, 'GBR' for Great Britain.
- providerResponse: A detailed response from the payment provider, which includes:
- code: A specific code from the provider related to the transaction status.
- message: A detailed message from the provider, often mirroring or expanding on the stateMessage.
- merchantId: An identifier for the merchant within the provider's system.
- schemeAccountReference: This is a reference provided by the card scheme (like Visa or Mastercard) relating to the transaction. It serves as an additional piece of data for tracking and associating the transaction with the specific card scheme..
{
"systemTransactionId": "1ed768bb-e88a-4636-91ae-67927ccbb02b",
"merchantOrderId": "This_is_my_merchant_order_id",
"merchantTransactionId": "This_is_my_merchant_transaction_id",
"state": "Authorised",
"stateMessage": "Transaction Authorised",
"approvalCode": "123456",
"fundingSource": "Credit",
"providerResponse": {
"state": "Authorised",
"stateMessage": "Transaction Authorised with Authority Code: 123456",
"merchantId": "77772182",
"cardSchemeReference": "A125221525"
}
}
Webhook
The standard notification mechanism is used for notifying the merchant in the background (asynchronously) about transaction state changes.
Void an Online Card Payout
To void a Payout, use the 'Transaction Modification' API call.
Updated 6 months ago