E-Wallet

E-wallet Call Flow

With the Wallet payment type, partners will receive a redirect link for the customer to complete their payment. Usually, it’s either the deep link (directly opening the wallet app) or the redirection page where the customer needs to fill in some additional information and authorize the payment.

Request Message

Parameters	Length	Description	Mandatory
api_key	256	Secret key assigned by Coda (unique to each country).	Yes
order_id	64	Merchant-assigned unique transaction identifier.	Yes
lang	2	2-character language code. See Language table for options.	Yes
pay_type	1	E-wallet use pay_type = 5	Yes
pay_channel	3	Code for each payment channel.	Yes
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	No
msisdn	15	MSISDN (non-formatted; without country code). Only include this if MSISDN is required and not email.
email	128	Only include this if email is required and not MSISDN.
merchant_name	128	If the partner wants to specify the partner's name, please enter the name in this field. The default value is empty.
type	1	1: digital content 2: non-digital content	Yes
items	N/A	ItemInfo array. See Item Info table below for more details.	Yes
profile	N/A	See Profile field.	Yes

Parameters

Length

Description

Mandatory

api_key

256

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

Yes

order_id

Merchant-assigned unique transaction identifier.

Yes

lang

2-character language code. See Language table for options.

Yes

pay_type

E-wallet use pay_type = 5

Yes

pay_channel

Code for each payment channel.

Yes

pay_at

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

MSISDN (non-formatted; without country code).

Only include this if MSISDN is required and not email.

128

Only include this if email is required and not MSISDN.

merchant_name

128

If the partner wants to specify the partner's name, please enter the name in this field.

The default value is empty.

type

1: digital content

2: non-digital content

Yes

items

N/A

ItemInfo array.

See Item Info table below for more details.

Yes

profile

N/A

See Profile field.

Yes

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.

Parameters	Length	Description	Mandatory
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
Type	N/A	Default=1.	Yes

Parameters

Length

Description

Mandatory

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

Type

N/A

Default=1.

Yes

Other Details In Profile Field

Parameters	Length	Description
user_id	128	Customer's user ID.
client_ip	15	Customer IP Address.
user_agent	512	Customer's user agent data (details of browser and operating system).
name	256	Customer's Full Name.
id_no	14	The Brazilian/Mexican/Argentinian Identification Document is called the CPF.
document_type	N/A	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	N/A	CC - Cédula de ciudadanía. TI - Tarjeta de identidad del menor de edad. CE - Cédula de extranjería.

Parameters

Length

Description

user_id

128

Customer's user ID.

client_ip

Customer IP Address.

user_agent

512

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

name

256

Customer's Full Name.

id_no

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

document_type

N/A

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

N/A

CC - Cédula de ciudadanía.

TI - Tarjeta de identidad del menor de edad.

CE - Cédula de extranjería.

Sample of Request

{
    "api_key":"<YOUR API KEY>",
    "order_id":"<Your Order ID>",
    "lang":"en",
    "merchant_name":"Koko eBooks",
    "pay_type":"5",
    "pay_channel":"20",
    "type":"1",
    "msisdn":"<phone number>",
    "email":"<email address>" ,
    "items":[{
        "code":"456789",
        "name":"One Day",
        "price":1000.00
    }],
    "profile":{"user_id":"12345"}
}

{
    "api_key": "<YOUR API KEY>",
    "order_id": "<Your Order ID>",
    "lang": "en",
    "merchant_name": "Koko eBooks",
    "type": "1",
    "pay_type": "5",
    "pay_channel": "98",
    "email": "test@codapayments.com",
    "msisdn": "123432",
    "items": [
        {
            "code": "1",
            "name": "One Day",
            "price": 3
        }
    ],
    "profile":{"name":"CodaUser","user_id":"12345","id_no":"88899988811"}
}

{
    "api_key":"<YOUR API KEY>",
    "order_id":"<Your Order ID>",
    "lang":"en",
    "merchant_name":"Koko eBooks",
    "pay_type":"5",
    "pay_channel":"39",
    "type":"1",
    "items":[{
        "code":"456789",
        "name":"One Day",
        "price":1000.00
    }],
    "profile":{"user_id":"12345"}
}

{
  "api_key": "<YOUR API KEY>",
  "order_id": "<Your Order ID>",
  "lang": "en",
  "pay_type": "5",
  "pay_channel": "255",
  "email": "test@codapayments.com",
  "type": "1",
  "merchant_name": "Koko eBooks",
  "items": [
    {
      "code": "1",
      "name": "ebook",
      "price": "1000.0",
      "type": "0",
    }
  ],
  "profile": {
    "document_number": "1134568011",
    "user_id": "12345",
    "document_type": "CC"
  }
}

Response Message

Parameters	Length	Description
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
txn_id	N/A	Unique payment transaction identifier.
txn_timeout	N/A	Transaction Timeout in Minutes.
total_price	N/A	Net payment amount. Non-formatted numeric value. For Indonesia, Chile, South Korea, Taiwan, Vietnam currency, decimals are not supported.
pay_instructions	15	If this value is populated, partner should display the instructions provided on screen to the customer.
profile	N/A	Other details. See Other details in Profile field below for more details.

Parameters

Length

Description

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

txn_id

N/A

Unique payment transaction identifier.

txn_timeout

N/A

Transaction Timeout in Minutes.

total_price

N/A

Net payment amount.

Non-formatted numeric value.

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

pay_instructions

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

profile

N/A

Other details.

See Other details in Profile field below for more details.

Other Details In Profile Field

Parameters	Length	Description
extInfoByte	N/A	This is for Coda internal reference , please ignore this field.
redirect_url	128	Return the payment gateway's redirect URL. Please be aware this response is only available if the payment channel has a redirect URL workflow. For Example: Thailand Rabbit Line Pay
merchantType	128	Please ignore this field.
qr_code_url	128	Return payment gateway's QR code URL. Please be aware this response is only available if the payment channel has QR code workflow. For Example: Malaysia Touch & Go e-Wallet

Parameters

Length

Description

extInfoByte

N/A

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

redirect_url

128

Return the payment gateway's redirect URL.

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

For Example: Thailand Rabbit Line Pay

merchantType

128

Please ignore this field.

qr_code_url

128

Return payment gateway's QR code URL.

Please be aware this response is only available if the payment channel has QR code workflow.

For Example: Malaysia Touch & Go e-Wallet

Sample Of Response

{
   "txn_id": <coda transaction ID>,
   "txn_timeout": 20,
   "result_code": 431,
   "result_desc": "Please wait a few minutes for your transaction to be completed. Need Help? Visit our <a href=“http://bit.ly/idCODAhelp” target=“_blank”>Help Center</a>.",
   "total_price": 1000.0,
   "pay_instructions": "",
   "profile": {
        "extInfoByte": "11",
        "user_id": "12345",
        "merchantType": "Codapay",
        "payment_code": ""
    }
}

{
    "txn_id": <coda transaction ID>,
    "txn_timeout": 1445,
    "result_code": 431,
    "result_desc": null,
    "total_price": 3.03,
    "pay_instructions": "",
    "profile": {
        "extInfoByte": "0",
        "id_no": "88899988811",
        "user_id":"12345",
        "redirect_url": "https://sample_URL.com",
        "payment_code": ""
    }
}

{
    "txn_id": <coda transaction ID>,
    "txn_timeout": 11,
    "result_code": 0,
    "result_desc": null,
    "total_price": 1000.0,
    "pay_instructions": "",
    "profile": {
        "redirect_url": "https://sample_URL.com",
        "extInfoByte": "0",
        "payment_code": ""
    }
}

{
    "txn_id": <coda transaction ID>,
    "txn_timeout": 17,
    "result_code": 431,
    "total_price": 1000.0,
    "pay_instructions": "",
    "profile": {
        "extInfoByte": "0",
        "document_number": "1134568011",
        "user_id": "12345",
        "merchantType": "Codapay",
        "redirect_url": "https://sample_URL.com",
        "document_type": "CC",
        "payment_code": ""
    }
}

Reference of USD Transactions

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

PreviousCarrier Billing (DCB)NextConvenience Store (OTC)

Last updated 5 months ago