Bank Transfer

Bank Transfer Call Flow

Customers can complete their payment via bank transfer using an ATM, a bank counter, or online banking. Partners receive a unique payment code in the profile field, which the customer must enter when providing the bank transfer details.

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 Bank Transfer use pay_type=2. 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
name	String	128	Optional Customer's Name.
user_id	String	128	Mandatory Customer's user ID.
client_ip	String	15	Optional Customer IP Address. (only support IPv4)
id_no	Number	14	Optional The Brazilian/Mexican/Argentinian Identification Document is called the CPF.
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 [e-mail]. Receipt example:

Sample Request

There are a few requests below, for example:

i. With MSISDN - Indonesia (BCA ATM) ii. With EMail - Bank Transfer Turkey iii. With Pay_AT - Bank (Brazil - PIX)

v2.0 Request

General with MSISDN

{
  "project_id": "1", //This field is only needed for v2.0 API
  "country": "360",
  "api_key": "test_e944d44f065eade8157737385a09",
  "order_id": "12345",
  "lang": "en",
  "merchant_name": "Codapay",
  "type": "1",
  "pay_type": "2",
  "pay_channel": "9",
  "pay_at": "5",
  "msisdn": "<Your Number>",
  "items": [
    {
      "code": "1",
      "name": "Test Item",
      "price": 11000.0
    }
  ],
  "profile": {
    "name": "Test Name",
    "user_id": "12345"

  }
}

With e-mail

{
  "project_id": "1", //This field is only needed for v2.0 API
  "country": "360",
  "api_key": "test_e944d44f065eade8157737385a09",
  "order_id": "12345",
  "lang": "en",
  "merchant_name": "Codapay",
  "type": "1",
  "pay_type": "2",
  "pay_channel": "9",
  "email": "[e-mail]",
  "items": [
    {
      "code": "1",
      "name": "Test Item",
      "price": 11000.0
    }
  ],
  "profile": {
    "name": "Test Name",
    "user_id": "12345"

  }
}

With pay_at

{
  "project_id": "1", //This field is only needed for v2.0 API
  "country": "360",
  "api_key": "test_e944d44f065eade8157737385a09",
  "order_id": "12345",
  "lang": "en",
  "merchant_name": "Codapay",
  "type": "1",
  "pay_type": "2",
  "pay_channel": "9",
  "email": "[e-mail]",
  "items": [
    {
      "code": "1",
      "name": "Test Item",
      "price": 11000.0
    }
  ],
  "profile": {
    "name": "Test Name",
    "user_id": "12345"

  }
}

v1.0 Request

General with MSISDN

{
    "api_key":"<YOUR API KEY>",
    "order_id":"<Your OrderID>",
    "lang":"en",
    "merchant_name":"Codapay",
    "pay_type":"2",
    "pay_channel":"1",
    "type":"1", 
    "msisdn":"<Your Number>",
    "items":[{
        "code":"456789",
        "name":"Test Item",
        "price":100000.00
    }],
    "profile":{
          "name":"12345"}

}

With e-mail

{
    "api_key": "<YOUR API KEY>",
    "order_id": "<Your OrderID>",
    "lang": "tr",
    "merchant_name": "Codapay",
    "pay_type": "2", 
    "pay_channel": "-86",
    "type": "1",
    "email": "[e-mail]",

    "items": [
        {
            "code": "1",
            "name": "Test Item",
            "price": 3
        }
    ],
    "profile":{
            "user_id":"12345"}
}

With pay_at

{
    "api_key":"<YOUR API KEY>",
    "order_id":"<Your OrderID>",
    "lang":"en",
    "merchant_name":"Codapay",
    "pay_type":"2",
    "pay_channel":"153",
    "type":"1",
    "pay_at":"5",
    "email":"[e-mail]",

    "items":[{
           "code":"1",
           "name":"Test Item",
           "price":3.0}],

    "profile":{
           "name":"Test Name",
           "id_no":"12345",
           "dateofbirth":"",
           "user_id":"12345",
           }
}

Response Message

Parameters	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 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
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, the partner should display the instructions provided on screen to the customer.
profile	Object	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.
paymentCode	Number	N/A	A code generated by payment channel.
name	String	128	Customer's Name.
redirect_url	String	N/A	The payment gateway's redirect URL is returned only if the selected payment channel follows a redirect URL workflow.

Sample Response

General with MSISDN

{
    "txn_id": <transaction id>,
    "txn_timeout": 1509,
    "result_code": 0,
    "total_price": 100000.0,
    "pay_instructions": "To complete the purchase by following the provided instruction, Enter the payment code 1900800000828075. Leave the transaction reference blank. Enter the payment amount if needed, your total purchase amount is Rp. 100.000. For more detailed instruction on how to pay, please refer to the payment link.",
   
    "profile": {
        "extInfoByte": "0",
        "paymentCode": "1900800000828075",
        "name": "test in Coda",
        "redirect_url": "https://sample_URL.com",
        "payment_code": "1900800000828075"
    }
}

With e-mail

{
    "txn_id": 1234567890,
    "txn_timeout": 35,
    "result_code": 0,
    "result_desc": null,
    "total_price": 3,
    "pay_instructions": "",

    "profile": {
        "extInfoByte": "0",
        "user_id":"12345",
        "redirect_url": "https:/sample_url.com",
        "payment_code": ""
    }
}

With pay_at

{
  "txn_id":"1234567890",
  "txn_timeout":7209,
  "result_code":431,
  "result_desc":"generic sub header",
  "total_price":3,
  "pay_instructions":"",

  "profile":{
        "zip":"12302",
        "extInfoByte":"1",
        "dateofbirth":"",
        "device_id":"5646e134-3300-4073-8f51-16431857eee0",
        "tax":"10","tax_rate":"10",
        "house_number_or_name":"10",
        "billing_street":"Main Street",
        "billing_city":"New York",
        "id_no":"88899988811",
        "user_id":"Testuser327",
        "name":"Yosep Joestar",
        "billing_address_line_2":"", 
        "state":"NY",
        "redirect_url":"https://sample_url.com",
        "payment_code":""}
}

Reference of USD Transactions

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