Convenience Store (OTC)

Using the Convenience Store payment type allows customers to complete their payments at a convenience store or another designated payment counter. Partners receive a unique payment code in the profile field, which the customer presents at the counter when making a payment.

See Convenience Store details in the Profile field in the response table for more details.

Request Message

ParametersLengthDescription

api_key

256

Secret key assigned by Coda (Unique to each country).

order_id

64

Merchant-assigned unique transaction identifier.

lang

2

2-character language code. Language Table

merchant_name

128

Merchant name that will be displayed in SMS message, if a partner wants to specify the partner name, please enter the name in this field.

The default value is empty.

pay_type

1

Convenience Store use pay_type = 3

pay_channel

1

Code for each payment channel.

type

1

1: digital content.

2: non-digital content

pay_at

2

This field refers to where the customer should complete their purchase.

1 = Bank Counter

2 = Internet Banking

3 = Online Bill Payment

4 = E-wallet

5 = ATM

14 = Convenience Store

msisdn

15

MSISDN (non-formatted; without country code).

Only include this if MSISDN is required and not email.

items

N/A

itemInfo array.

See Item Info table below for more details.

profile

N/A

Other details.

See Other details in Profile field below for more details.

Item Info

Item represents a SKU

Code and Name should be unique and univocally represent the item. The name needs to be user-friendly, as it shows to end-users in the payment window.

ParametersLengthDescriptionMandatory

code

128

Partner-managed item code.

Yes

name

128

The name of the purchased item or topup, e.g. “50 diamonds”.

If purchases can be made for multiple games or services, include also the name of that, e.g. “Hero's Glory - 200 gold”.

Yes

price

N/A

Non-formatted numeric value.

For Indonesia, Chile, South Korea, Taiwan, and Vietnam currency, decimals are not supported.

Yes

Profile Info

ParametersLengthDescriptionMandatory

name

128

Customer's Name.

No

user_id

128

Customer's user ID.

Yes

client_ip

15

Customer IP Address.

No

Sample of Request

{
    "api_key":"YOUR API KEY",
    "order_id":"123456",
    "lang":"en",
    "merchant_name":"Koko eBooks"
    "pay_type":"3",
    "pay_channel":"100",
    "pay_at":"14",
    "email":"user@email.com",
    "items":[
        {
            "code": "1",
            "name": "One Day",
            "price": 3
        }
    ],
    "profile":{
        "user_id":"12345",
        "name": "user full name",
        "id_no": "27634752215"
    }
}

Response Message

ParametersLengthDescription

txn_id

N/A

Unique payment transaction identifier.

txn_timeout

N/A

Transaction Timeout in Minutes.

result_code

N/A

Success or Error code. Success = 0. Common Error Codes

result_desc

512

If the resultCode is an error, this value describes the error. Common Error Codes

total_price

N/A

Net payment amount.

Non-formatted numeric value.

For Indonesia currency, decimals are not supported.

pay_instructions

15

If this value is populated, the partner should display the instructions provided on screen to the customer.

Other Details In Profile Field

ParametersLengthDescription

extInfoByte

N/A

This is for Coda internal reference, please ignore this field.

payment_code

N/A

A code generated by payment channel.

user_id

N/A

Customer's user ID.

id_no

N/A

Customer's ID number.

name

N/A

Customer's Name.

redirect_url

128

Return payment gateway's redirect URL.

Please be aware this response is aboutonly available if the payment channel has a redirect URL workflow.

Sample of Response

{
    "txn_id": 1234567890,
    "txn_timeout": 14399,
    "result_code": 431,
    "total_price": 3.0,
    "pay_instructions": "",
    "profile": {
        "extInfoByte": "0",
        "redirect_url": 
           "https://sample_URL.com",
        "payment_code": "",
        "extInfoByte": "0",
        "user_id": "12345",
        "id_no": "27634752215",
        "name": "user full name"
    }
}

Reference of USD Transactions

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

Last updated