For the complete documentation index, see llms.txt. This page is also available as Markdown.

E-Wallet

E-wallet Call Flow

For Wallet payments, partners will receive a redirect link for the customer to complete their transaction. This link may either be a deep link that directly opens the wallet app or a redirection page where the customer provides additional details and authorizes the payment.

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

E-wallet use pay_type = 5

Refer Backend API for more details

pay_channel

Number

3

Mandatory Code for each payment channel.

pay_at

Number

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

Number

15

Optional

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

email

String

128

Optional

Only include this if email is required and not MSISDN.

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

user_id

String

128

Mandatory

Customer's user ID.

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

name

String

256

Optional

Customer's Full Name.

id_no

Number

14

Optional

The Brazilian/Mexican/Argentinian Identification Document is called the CPF.

document_type

String

N/A

Optional

Customer Document.

a. Cédula de ciudadanía (Citizenship ID card).

b. Tarjeta de identidad del menor de edad (Minor's ID card).

C. Cédula de extranjería (Foreigner ID card).

document_number

Number

N/A

Optional

CC - Cédula de ciudadanía.

TI - Tarjeta de identidad del menor de edad.

CE - Cédula de extranjería.

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:

v2.0 Sample Request

v1.0 Sample Request

Response Message

Parameters
Type
Length
Description

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

Map

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

128

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

For example: Thailand Rabbit Line Pay.

merchantType

String

128

Please ignore this field.

qr_code_url

String

128

The payment gateway's QR code URL is returned only if the selected payment channel has a QR code workflow.

For example: Malaysia Touch & Go e-Wallet

Sample Response

Last updated

Was this helpful?