On This Page
FILTER BY TAG

Mastercard Payment of Winnings Processing

This section describes how to process a
credit
 for Mastercard Payment of Winnings.
WARNING
Payment of Winnings (POW) is prohibited in some countries and restricted to specific card types in the countries where it is allowed.
Cybersource
 does not perform BIN checks on these transactions to verify that the customer is permitted to receive payouts in their region for their card type.
Cybersource
 recommends that merchants perform their own BIN checks or verify with
Barclays
.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/credits/
Test:
POST
https://apitest.cybersource.com
/pts/v2/credits/

Related Information

Required Fields for Processing a Mastercard Payment of Winnings

Use these required fields to process a Mastercard Payment of Winnings.
IMPORTANT
When relaxed requirements for address data and the expiration date are being used, not all fields in this list are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required. For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.

Optional Fields for Processing a Mastercard Payment of Winnings

Include these optional fields to process a Mastercard Payment of Winnings if you need to provide a merchant surname, override the default settings for the merchant first name or location, or override the default settings for the customer first and last names.
By default, this field is set to the value in the
orderInformation.billTo.firstName
 field. Include this field in the request message if you want to override the default setting.
By default, this field is set to the value in the
orderInformation.billTo.lastName
 field. Include this field in the request message if you want to override the default setting.
Include this field if you need to provide a payment card account number or bank account number for your merchant account.
Possible values for processing a Mastercard Payment of Winnings:
  • 00
    : Other
  • 01
    : RTN + bank account
  • 02
    : International bank account number (IBAN)
  • 03
    : Card account
  • 04
    : Email
  • 05
    : Phone number
  • 06
    : Bank account number (BAN) + bank identification code (BIC)
  • 07
    : Wallet ID
  • 08
    : Social network ID
Merchant street address. By default, this field is set to the corresponding value in your configuration on the
Cybersource
 platform.
Merchant country code. By default, this field is set to the corresponding value in your configuration on the
Cybersource
 platform.
Merchant first name. By default, this field is set to the corresponding value in your configuration on the
Cybersource
 platform.
Include this field if you need to provide a last name for your merchant account.
Merchant city. By default, this field is set to the corresponding value in your configuration on the
Cybersource
 platform.

REST Example: Processing a Mastercard Payment of Winnings

Request
{
  "clientReferenceInformation": {
    "code": "12345678"
  },
  "processingInformation": {
    "refundOptions": { 
      "reason": "pow"
    }
  },
  "recipientInformation": {
    "lastName": "Joseph",
    "firstName": "Bloggs"
  },
  "senderInformation": {
    "firstName": "The",
    "lastName": "Company",
    "address1": "1 High Street",
    "locality": "Belfast",
    "countryCode": "GBR",
    "account": {
      "number": "12345678901xxxx",
      "fundsSource": "01"
    }
  },
  "paymentInformation": {
    "card": {
      "number": "555555555555xxxx",
      "expirationMonth": "01",
      "expirationYear": "2025",
      "type": "002"
    }
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "200",
      "currency": "GBP"
    },
    "billTo": {
      "firstName": "Joe",
      "lastName": "Bloggs",
      "address1": "1 The Street",
      "locality": "City",
      "administrativeArea": "County",
      "postalCode": "AB12CD",
      "country": "GB",
      "email": "jb@example.com",
      "phoneNumber": "07000000000"
    }
  }
}
Response to a Successful Request
{{
  "_links" : {
    "void" : {
      "method" : "POST",
      "href" : "/pts/v2/credits/6922294815876855103092/voids"
    },
    "self" : {
      "method" : "GET",
      "href" : "/pts/v2/credits/6922294815876855103092"
    }
  },
  "clientReferenceInformation" : {
    "code" : "12345678"
  },
  "creditAmountDetails" : {
    "currency" : "GBP",
    "creditAmount" : "200.00"
  },
  "id" : "6922294815876855103092",
  "orderInformation" : {
    "amountDetails" : {
      "currency" : "GBP"
    }
  },
  "paymentAccountInformation" : {
    "card" : {
      "type" : "002"
    }
  },
  "paymentInformation" : {
    "tokenizedCard" : {
      "type" : "002"
    },
    "card" : {
      "type" : "002"
    }
  },
  "reconciliationId" : "5003323433",
  "status" : "PENDING",
  "submitTimeUtc" : "2023-08-16T23:44:41Z"
}
RELATED TO THIS PAGE