Initiate USD Transactions

Please take note that Backend API USD transactions require some specification on the currency code.

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

USD transactions require profile info params with "currency_code": "840"

Parameters	Type	Length	Description
user_id	String	N/A	Mandatory Your user's unique identifier
currency_code	Number	3	Mandatory Set USD with "currency_code": "840"

Response Message

Parameter	Type	Length	Description
txn_id	Number	N/A	Unique payment transaction identifier.
txn_timeout	Number	N/A	Transaction Timeout in Minutes.
result_code	Number	N/A	Success Resultcode is Success = 0. Error Code list please refer to [Error Codes]
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, publisher should display the instructions provided on screen to the customer.
profile	Map	N/A	Refer the Profile info below for more details

Profile Info

Parameter	Type	Length	Description
extInfoByte	Number	N/A	This is for Coda internal reference , please ignore this field.
foreign_currency_code	Number	3	Currency is used for the actual payment charged to the user.
exchange_rate	Number	N/A	Coda's USD exchange rate updates daily.
foreign_currency_amt	Number	N/A	The original amount provided in the initiation request
local_currency_code	Number	3	Local currency of the respective regions. To know more about each currency code please refer to Country and Currency Codes
currency_code	Number	3	Initiate order with USD will be returned "currency_code":"840".
local_currency_amt	Number	N/A	The total amount the user has paid for the transaction. This will always be in local currency.

Samples

v2.0 Request

{
    "api_key": "test_e944d44f065eade8157737385a09",
    "order_id": "123456",
    "project_id": "1",//This field is only needed for v2.0 API
    "lang": "en",
    "merchant_name": "Codapay",
    "pay_type": "5",
    "pay_channel": -76,
    "pay_at": "4",
    "type": "1",
    "country": "702",
    "items": [
        {
            "code": "456789",
            "name": "Test Item",
            "price": 100
        }
    ],
    "profile": {
        "user_id": "12345"
    }
}

v1.0 Request

{
    "api_key": "e944d44f065eade8157737385a094a",
    "order_id": "123456",
    "lang": "en",
    "merchant_name": "Amazon",
    "pay_type": "5",
    "pay_channel": -76,
    "pay_at": "4",
    "type": "1",
    "items": [
        {
            "code": "456789",
            "name": "GameCredit",
            "price": 100
        }
    ],
    "profile": {
        "user_id": "12345",
        "currency_code": "840"
    }
}

Successful Response

{
"txn_id": 7395063022892074013,
    "txn_timeout": 19,
    "result_code": 0,
    "result_desc": null,
    "total_price": 135.33,
    "pay_instructions": "",
    "profile": {
        "extInfoByte": "0",
        "foreign_currency_code": "840",
        "exchange_rate": "1.3533",
        "foreign_currency_amt": "100.0",
        "local_currency_code": "702",
        "currency_code": "840",
        "local_currency_amt": "135.33",
        "user_id": "12345",
        "projectId": "1",
        "merchantType": "Codapay",
        "redirect_url": "https://partner-api.stg-myteksi.com/grabid/v1/oauth2/authorize?acr_values=consent_ctx%3AcountryCode%3DSG,currency%3DSGD&client_id=8488e516acc54f88bad99c435cc18fdd&redirect_uri=https%3A%2F%2Fmidas.codapayments.com%2Fepcgw%2Fgrab%2Fredirect&request=eyJhbGciOiAibm9uZSJ9.eyJjbGFpbXMiOnsidHJhbnNhY3Rpb24iOnsidHhJRCI6ImFkNzI5ZjA1NzQ0MzQyMTA4ODQ5ZDQyMzcyZTFlYWZiIn19fQ.&response_type=code&code_challenge=csKQlGqOEs5LVHsLEFRQemfNIu4inReam4wfysr8zZY&code_challenge_method=S256&scope=payment.one_time_charge&state=7395063022892074846&nonce=0r2bt4lD0oRHxh9B",
        "payment_code": ""
    }
}

Failed Response

{
    "txn_id": 0,
    "txn_timeout": 0,
    "result_code": 103,
    "result_desc": "This transaction has been cancelled. No charges were made. (error:103)",
    "total_price": 0.0,
    "pay_instructions": null,
    "profile": null
}