Carrier Billing (DCB)

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

Carrier Billing use pay_type = 1 For Carrier billings, if customers enter MSISDN of different carrier billings than the carrier billings in request message, the transaction will be failed with error 240.

Refer Backend API for more details

mno_code

Number

N/A

Mandatory

Mobile Network Code. If empty, Coda selects available MNO.

msisdn

Number

15

Optional

MSISDN (non-formatted; without country code). Only include this if MSISDN is required and not email.

merchant_name

String

128

Optional

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

The default value is empty.

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.

items[].type

Number

N/A

Mandatory Default=1

profile

Map

N/A

Mandatory Refer Profile Info below for more details

user_id

String

128

Mandatory

Your user's unique identifier

client_ip

String

15

Optional Customer IP Address (only support IPv4)

user_agent

String

512

Optional Customer's user agent data (details of browser and operating system)

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 codapay_integration@coda.co.

Receipt example:

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

txn_id

Number

N/A

Unique payment transaction identifier.

txn_timeout

Number

N/A

Transaction Timeout in Minutes.

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, partner should display the instructions provided on screen to the customer.

profile

Object

N/A

Refer the Profile info below for more details

extInfoByte

N/A

N/A

Please ignore this field.

redirect_url

String

128

The payment gateway's redirect URL is returned only if the selected payment channel follows a redirect URL workflow.

merchantType

String

128

Please ignore this field.

Bangladesh

Robi

N/A

47002

Indonesia

Indosat

MT-MO

51001 or 51021

Indonesia

Telkomsel

MT-MO

51010 or 51020

Indonesia

TRI

MT-MO

51089

Indonesia

XL

MO

51008 or 51011

Cambodia

Smart Axiata

MT-MO

45605

Laos

Unitel

MT-MO

45703

Myanmar

ATOM

MT-MO

41406

Myanmar

Ooredoo

MT-MO

41405

Malaysia

Celcom

MT-MO

50213, 50219

Malaysia

Maxis

MO

50212 or 50217

Philippines

Smart/Sun

MT-MO

51503

Pakistan

Telenor Pakistan

MT-MO

52586

Singapore

M1

MT-MO

52503

Taiwan

Asia Pacific Telecom

N/A

46605

Taiwan

Chunghwa Telecom

N/A

46692, 46611

Taiwan

FarEasTone

N/A

46602, 46607, 46601, 46606, 46603