> For the complete documentation index, see [llms.txt](https://docs.coda.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.coda.co/codapay/direct-api-integration/direct-api-integration-for-alternative-payment-methods/backend-call-flow/voucher-cash-card.md).

# 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.

<figure><img src="/files/h1J69Fc7McKrFVintCIV" alt=""><figcaption></figcaption></figure>

## Request Message

<table><thead><tr><th width="148">Parameters</th><th width="95">Type</th><th width="116">Length</th><th>Description</th></tr></thead><tbody><tr><td>api_key</td><td>String</td><td>256</td><td><strong>Mandatory</strong><br>API key provided by Coda. Refer to <a data-mention href="/pages/SJ2KtFdcmUYgMDiplZT1">/pages/SJ2KtFdcmUYgMDiplZT1</a> to find out how to get it.</td></tr><tr><td>project_id</td><td>String</td><td>10</td><td><p>*<strong>This field is only needed for v2.0 API</strong></p><p><strong>Mandatory</strong> </p><p>Project ID provided by Coda, unique for each title product. Refer to <a data-mention href="/pages/SJ2KtFdcmUYgMDiplZT1">/pages/SJ2KtFdcmUYgMDiplZT1</a> to find out how to get it.</p></td></tr><tr><td>order_id</td><td>String</td><td>64</td><td><p><strong>Mandatory</strong> </p><p>Your unique identifier for the transaction</p></td></tr><tr><td>country</td><td>Number</td><td>N/A</td><td><strong>Mandatory</strong><br>ISO 3166 based country code. Can refer to <a data-mention href="/pages/7B3qZnefeSwkSs84sKuB">/pages/7B3qZnefeSwkSs84sKuB</a></td></tr><tr><td>lang</td><td>String</td><td>2</td><td><p><strong>Mandatory</strong></p><p>2-character language code. See <a data-mention href="/pages/lumiE4ZV7er3NqdusLTc">/pages/lumiE4ZV7er3NqdusLTc</a>for options.</p></td></tr><tr><td>type</td><td>Number</td><td>1</td><td>1: Digital content,<br>2: Non-digital content</td></tr><tr><td>pay_type</td><td>Number</td><td>1</td><td><p><strong>Mandatory</strong></p><p>Cash Card Channel use pay_type=4</p><p></p><p>Refer <a data-mention href="/pages/H5smNhrW5H8UuJgvQJ6Y">/pages/H5smNhrW5H8UuJgvQJ6Y</a> for more details</p></td></tr><tr><td>pay_channel</td><td>Number</td><td>3</td><td><strong>Mandatory</strong><br>Code for each payment channel.</td></tr><tr><td>merchant_name</td><td>String</td><td>128</td><td><p><strong>Optional</strong></p><p>If the partner wants to specify the partner's name, please enter the name in this field.<br></p><p>The default value is empty.</p></td></tr><tr><td>type</td><td>Number</td><td>1</td><td><p>Mandatory<br>1: digital content</p><p>2: non-digital content</p></td></tr><tr><td>items</td><td>ItemInfo</td><td>N/A</td><td><p><strong>Mandatory</strong></p><p>List of items being purchased by the users</p></td></tr><tr><td>items[].code</td><td>String</td><td>128</td><td><p><strong>Mandatory</strong></p><p>Code associated with the item on your side</p></td></tr><tr><td>items[].name</td><td>String</td><td>128</td><td><strong>Mandatory</strong> Name of the item being purchased. Only supports latin characters.</td></tr><tr><td>items[].price</td><td>Number</td><td>N/A</td><td><strong>Mandatory</strong><br>Price of the item inclusive of any taxes in the currency specified in the request.</td></tr><tr><td>profile</td><td>Map</td><td>N/A</td><td><strong>Mandatory</strong><br>Refer Profile Info below for more details</td></tr></tbody></table>

## Profile Info

<table data-full-width="false"><thead><tr><th width="188">Parameters</th><th width="135">Type</th><th width="109">Length</th><th>Description</th></tr></thead><tbody><tr><td>voucher_code</td><td>String</td><td>20</td><td><strong>Mandatory</strong><br>Voucher Code.</td></tr><tr><td>voucher_pin</td><td>String</td><td>20</td><td><p><strong>Mandatory</strong></p><p>Voucher PIN.</p></td></tr><tr><td>card_type</td><td>String</td><td>N/A</td><td><p><strong>Optional</strong></p><p>Default use "card_type":"0".</p></td></tr><tr><td>email</td><td>String</td><td></td><td><p><strong>Optional</strong></p><p>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. <em>This feature is not enabled by default. To activate automated receipt delivery for your titles, please contact the payment enablement team at</em> <a href="mailto:codapay_integration@coda.co"><em>codapay_integration@coda.co</em></a><em>.</em><br></p><p><em>Receipt example:</em> <img src="/files/VpemzyLCFf0d472Nomf0" alt=""></p></td></tr></tbody></table>

### Sample Request

{% tabs %}
{% tab title="v2.0 Request" %}

```json
{
  "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": "-"
  }
}
```

{% endtab %}

{% tab title="v1.0 Request" %}

```json
{
    "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"
    }
}
```

{% endtab %}
{% endtabs %}

## Response Message

<table data-full-width="false"><thead><tr><th width="182">Parameters</th><th width="127">Type</th><th width="90.33333333333331">Length</th><th>Description</th></tr></thead><tbody><tr><td>txn_id</td><td>Number</td><td>N/A</td><td>Unique payment transaction identifier.</td></tr><tr><td>txn_timeout</td><td>Number</td><td>N/A</td><td>Transaction Timeout in Minutes.</td></tr><tr><td>result_code</td><td>Number</td><td>N/A</td><td><p>Success or Error code. Success = 0.</p><p></p><p>Error Code list please refer to <a data-mention href="/pages/Ijfanb3Eb2mtXRsbF81n">/pages/Ijfanb3Eb2mtXRsbF81n</a></p></td></tr><tr><td>result_desc</td><td>String</td><td>512</td><td>If the resultCode is an error, this value describes the error.<br><a data-mention href="/pages/Ijfanb3Eb2mtXRsbF81n">/pages/Ijfanb3Eb2mtXRsbF81n</a></td></tr><tr><td>total_price</td><td>Number</td><td>N/A</td><td>The total amount the user has paid for the transaction. This will always be in local currency.</td></tr><tr><td>pay_instructions</td><td>String</td><td>15</td><td>If this value is populated, the partner should display the instructions provided on screen to the customer.</td></tr><tr><td>profile</td><td>Object</td><td>N/A</td><td>Refer the Profile info below for more details</td></tr></tbody></table>

## Profile Info

<table data-full-width="false"><thead><tr><th width="154">Parameters</th><th width="96">Type</th><th width="76.33333333333331">Length</th><th>Description</th></tr></thead><tbody><tr><td>extInfoByte</td><td>Number</td><td>N/A</td><td>This is for Coda internal reference, please ignore this field.</td></tr><tr><td>redirect_url</td><td>String</td><td>N/A</td><td>The payment gateway's redirect URL is returned only if the selected payment channel follows a redirect URL workflow.</td></tr></tbody></table>

### Sample Response

{% tabs %}
{% tab title="Response" %}

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

{% endtab %}
{% endtabs %}

{% hint style="warning" %} <mark style="color:orange;">**Reference of USD Transactions**</mark>

Please check out this [guide ](/codapay/direct-api-integration/direct-api-integration-for-alternative-payment-methods/initiate-usd-transactions.md)to learn more about USD transactions.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.coda.co/codapay/direct-api-integration/direct-api-integration-for-alternative-payment-methods/backend-call-flow/voucher-cash-card.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.