Bank Transfer

Bank Transfer Call Flow

Customers may pay for their order by executing a bank transfer at an ATM, at a bank counter, or using online banking. Partners receive a unique payment code in the profile field, which the customer enters as part of the bank transfer details.

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

Parameters

Length

Description

Mandatory

api_key

256

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

Yes

order_id

Partner-assigned unique transaction identifier.

Yes

lang

2-character language code. Language Table

Yes

merchant_name

128

Merchant name that will be displayed in SMS message, if the partner wants to specify the partner's name, please enter the name in this field.

The default value is empty.

N/A

pay_type

Bank Transfer use pay_type=2.

Yes

pay_channel

Code for each payment channel.

Yes

type

1: digital content.

2: non-digital content.

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

Yes

msisdn

MSISDN (non-formatted; without country code).

Only include this if MSISDN is required and not email.

N/A

items

N/A

ItemInfo array.

See Item Info table below for more details.

Yes

profile

N/A

See Other details in Profile field below for more details.

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

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

Profile Info

Parameters	Length	Description	Mandator
name	128	Customer's Name.	No
user_id	128	Customer's user ID.	Yes
id_no	14	The Brazilian/Mexican/Argentinian Identification Document is called the CPF.	No
client_ip	15	Customer IP Address.	No

Parameters

Length

Description

Mandator

name

128

Customer's Name.

user_id

128

Customer's user ID.

Yes

id_no

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

client_ip

Customer IP Address.

Sample of 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)

{
    "api_key":"<your api key>",
    "order_id":"<your order id>",
    "lang":"en",
    "merchant_name":"test in Coda",
    "pay_type":"2",
    "pay_channel":"1",
    "type":"1", 
    "msisdn":"<phone number>",
    "items":[{
        "code":"456789",
        "name":"GameCredit",
        "price":100000.00
    }],
    "profile":{
          "name":"test in Coda"}

}

{
    "api_key": "YOUR API KEY",
    "order_id": "123456",
    "lang": "tr",
    "merchant_name": "ebooks",
    "pay_type": "2", 
    "pay_channel": "-86",
    "type": "1",
    "email": "test@codapayments.com",

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

{
    "api_key":"YOUR API KEY",
    "order_id":"20220812015939",
    "lang":"en",
    "merchant_name":"eBooks",
    "pay_type":"2",
    "pay_channel":"153",
    "type":"1",
    "pay_at":"5",
    "email":"test@codapayments.com",

    "items":[{
           "code":"1",
           "name":"One Day",
           "price":3.0}],

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

Response Message

Parameters	Length	Description
txn_id	N/A	Unique payment transaction identifier.
txn_timeout	N/A	Transaction Timeout in Minutes.
result_code	N/A	Success or Error code. Success = 0. Common Error Codes
total_price	N/A	Net payment amount. Non-formatted numeric value. For Indonesia, Chile, South Korea, Taiwan, and 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.

Parameters

Length

Description

txn_id

N/A

Unique payment transaction identifier.

txn_timeout

N/A

Transaction Timeout in Minutes.

result_code

N/A

Success or Error code. Success = 0. Common Error Codes

total_price

N/A

Net payment amount.

Non-formatted numeric value.

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

pay_instructions

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

Other Details In Profile Field

Parameters	Length	Description
extInfoByte	N/A	This is for Coda internal reference, please ignore this field.
paymentCode	N/A	A code generated by payment channel.
name	128	Customer's Name.
redirect_url	N/A	Return payment gateway's redirect URL. Please be aware this response is only available if the payment channel has a redirect URL workflow.

Parameters

Length

Description

extInfoByte

N/A

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

paymentCode

N/A

A code generated by payment channel.

name

128

Customer's Name.

redirect_url

N/A

Return payment gateway's redirect URL.

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

Sample of response

{
    "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"
    }
}

{
    "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": ""
    }
}

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

PreviousCard Payments NextVoucher (Cash Card)

Last updated 5 months ago