Voucher (Cash Card)

Voucher Call Flow

The voucher payment method enables customers to redeem their voucher codes through Codapay on the Partner's website. Codapay processes payments in real-time and immediately notifies partners upon completion. Voucher details can be found in the Profile Info of the request table for further reference.

For voucher transactions, the voucher's value is confirmed only after redemption. Partners must validate the net amount returned in Coda's API response and be prepared to handle redemptions across all available denominations.

Request Message

Parameters	Type	Length	Description
api_key	String	256	Mandatory API key provided by Coda. Refer to Getting started to find out how to get it.
project_id	String	10	*This field is only needed for v2.0 API Mandatory Project ID provided by Coda, unique for each title product. Refer to Getting started to find out how to get it.
order_id	String	64	Mandatory Your unique identifier for the transaction
country	Number	N/A	Mandatory ISO 3166 based country code. Can refer to Country and Currency Codes
lang	String	2	Mandatory 2-character language code. See Language Tablefor options.
type	Number	1	1: Digital content, 2: Non-digital content
pay_type	Number	1	Mandatory Cash Card Channel use pay_type=4 Refer Backend API for more details
pay_channel	Number	3	Mandatory Code for each payment channel.
merchant_name	String	128	Optional If the partner wants to specify the partner's name, please enter the name in this field. The default value is empty.
type	Number	1	Mandatory 1: digital content 2: non-digital content
items	ItemInfo	N/A	Mandatory List of items being purchased by the users
items[].code	String	128	Mandatory Code associated with the item on your side
items[].name	String	128	Mandatory Name of the item being purchased. Only supports latin characters.
items[].price	Number	N/A	Mandatory Price of the item inclusive of any taxes in the currency specified in the request.
profile	Map	N/A	Mandatory Refer Profile Info below for more details

Profile Info

Parameters	Type	Length	Description
voucher_code	String	20	Mandatory Voucher Code.
voucher_pin	String	20	Mandatory Voucher PIN.
card_type	String	N/A	Optional Default use "card_type":"0".
email	String		Optional The email address where the successful transaction receipt will be sent. Upon a successful payment, Coda will automatically deliver a digital receipt to this address. This feature is not enabled by default. To activate automated receipt delivery for your titles, please contact the payment enablement team at [e-mail]. Receipt example:

Sample Request

v2.0 Request

{
  "project_id": "1", //This field is only needed for v2.0 API
  "country": "410",
  "api_key": "test_e944d44f065eade8157737385a09",
  "order_id": "<Your OrderID>",
  "lang": "ko",
  "merchant_name": "Codapay",
  "type": "1",
  "pay_type": "4",
  "pay_channel": "-148",
  "items": [
    {
      "code": "7",
      "name": "Test Item",
      "price": 500.0
    }
  ],
  "profile": {
    "voucher_code": "-",
    "voucher_pin": "-"
  }
}

v1.0 Request

{
    "api_key":"<YOUR API KEY>",
    "order_id":"<Your OrderID>",
    "lang":"en",
    "merchant_name":"Codapay",
    "pay_type":"4",
    "pay_channel":"340",
    "type":"1",
    "profile":{
        "voucher_code":"12345678901231",
        "voucher_pin":"",
        "card_type":"0",
        "user_id":"12345"
    }
}

Response Message

Parameters	Type	Length	Description
txn_id	Number	N/A	Unique payment transaction identifier.
txn_timeout	Number	N/A	Transaction Timeout in Minutes.
result_code	Number	N/A	Success or Error code. Success = 0. Error Code list please refer to Error Codes
result_desc	String	512	If the resultCode is an error, this value describes the error. Error Codes
total_price	Number	N/A	The total amount the user has paid for the transaction. This will always be in local currency.
pay_instructions	String	15	If this value is populated, the partner should display the instructions provided on screen to the customer.
profile	Object	N/A	Refer the Profile info below for more details

Profile Info

Parameters	Type	Length	Description
extInfoByte	Number	N/A	This is for Coda internal reference, please ignore this field.
redirect_url	String	N/A	The payment gateway's redirect URL is returned only if the selected payment channel follows a redirect URL workflow.

Sample Response

Response

{
   "txn_id": <Coda Transaction ID>,
   "txn_timeout": 0,
   "result_code": 0,
   "total_price": 150,
   "profile":{
   "user_id": "12345"
   }
}

Reference of USD Transactions

Please check out this guide to learn more about USD transactions.