Test Hosted Payment Page API

After you set up accepting payments in Coda Portal, you can quickly test a payment flow for a payment method.

This tutorial only shows how to test for a specific payment method. If you are interested in our Payment Selection Page, you can follow this guide.

What you'll learn

Initiating a payment request.
What your customer will experience upon payment request.
What your customer will experience upon a successful payment notification.

This tutorial assumes you have a developer set up and tools to make API calls (Postman, ...). If that is not the case, you can also test the flow through our Coda Portal "Sandbox Testing" section.

Step 1: Initiate the payment request

Initiate the payment request by calling the /init endpoint to collect your payment transaction ID. Use the curl below and populate it with:

Parameter

Placeholder text

Description

country

[SELECTED_COUNTRY]

The country that you want to test. See the full list here.

currency

[SELECTED_CURRENCY]

The currency code that you want to use. See the full list here.

payType

[SELECTED_PAYMENT_CHANNEL_ID]

The payment method that you want to use. See the full list here.

apiKey

[API_KEY]

Get your APIKey from Coda Portal.

projectId

[PROJECT_ID]

*This field is only needed for v2.0 API

Get the projectId for each title from Coda Portal.

Make sure that the price is within transaction limits for the payment channel you’ve selected by checking transaction limits here.

Other parameters have been populated with dummy data for testing purposes below. They can be changed and populated properly as part of your integration. More details on the parameters of the /init endpoint can be found here. Codapay offers two API versions - v1.0 and v2.0, with v2.0 being an upgraded version. If you are a new merchant, please use v2.0. More details can be found here.

curl --location 'https://sandbox.codapayments.com/airtime/api/restful/v2.0/Payment/init.json' \
--header 'Content-Type: application/json' \
--data '{
    "initRequest": {
        "country": [SELECTED_COUNTRY],
        "payType": [SELECTED_PAYMENT_CHANNEL_ID],
        "apiKey": [API_KEY],
        "projectId": [PROJECT_ID] //This field is only needed for v2.0 API
        "orderId": "12321312321314",
        "currency": [SELECTED_CURRENCY],
        "items": [
            {
                "code": "1",
                "price": 50.00,
                "name": "Test Item"
            }
        ],
        "profile": {
            "entry": [
                {
                    "key": "user_id",
                    "value": "105"
                }
            ]
        }
    }
}

curl --location 'https://sandbox.codapayments.com/airtime/api/restful/v1.0/Payment/init.json' \
--header 'Content-Type: application/json' \
--data '{
    "initRequest": {
        "country": [SELECTED_COUNTRY],
        "payType": [SELECTED_PAYMENT_CHANNEL_ID],
        "apiKey": [COUNTRY_API_KEY],
        "orderId": "12321312321314",
        "currency": [SELECTED_CURRENCY],
        "items": [
            {
                "code": "1",
                "price": 50.00,
                "name": "Test Item"
            }
        ],
        "profile": {
            "entry": [
                {
                    "key": "user_id",
                    "value": "105"
                }
            ]
        }
    }
}

Below is an example using a dummy sandbox API Key for Singapore, with Singapore Dollar (SGD) as a currency and Card Payments as a payment method.

curl --location 'https://sandbox.codapayments.com/airtime/api/restful/v2.0/Payment/init.json' \
--header 'Content-Type: application/json' \
--data '{
    "initRequest": {
        "country": 702,
        "payType": 427,
        "apiKey": "test_32774abe1cd7d8bae650ea48265e",
        "projectId": 21 //This field is only needed for v2.0 API
        "orderId": "12321312321314",
        "currency": 702,
        "items": [
            {
                "code": "1",
                "price": 50.00,
                "name": "Test Item"
            }
        ],
        "profile": {
            "entry": [
                {
                    "key": "user_id",
                    "value": "105"
                }
            ]
        }
    }
}'

curl --location 'https://sandbox.codapayments.com/airtime/api/restful/v1.0/Payment/init.json' \
--header 'Content-Type: application/json' \
--data '{
    "initRequest": {
        "country": 702,
        "payType": 427,
        "apiKey": "32774abe1cd7d8bae650ea48265e",
        "orderId": "12321312321314",
        "currency": 702,
        "items": [
            {
                "code": "1",
                "price": 50.00,
                "name": "Test Item"
            }
        ],
        "profile": {
            "entry": [
                {
                    "key": "user_id",
                    "value": "105"
                }
            ]
        }
    }
}'

{
   "initResult": {
       "resultCode": 0,
       "txnId": 7122167282516076304
   }
}

Step 2: Redirect your user to the payment page to complete payment

Use the received txnId from Step 1 to redirect your user to the following URL:

Click here to see all the available parameters to pass in the URL.

https://sandbox.codapayments.com/airtime/begin?type=3&txn_id=[txnId]

https://sandbox.codapayments.com/airtime/begin?type=3&txn_id=[txnId]&browser_type=mobile-web

Below is an example of what it would look like for the transaction initiated above for Card Payments in Singapore:

In the sandbox environment, you can follow the testing instructions provided here to complete the payment.

Complete a test transaction with Card Payments in Singapore and use the following test card below.

Card number

Expiry date

CVC

4242 4242 4242 4242

01/35

Note: On the sandbox environment, the payment might take a few minutes to complete.

Step 3: Receive the successful payment notification

You will receive a notification on the Complete Notification URL, including the following fields as query parameters:

Parameters

Description

TxnId

Coda transaction ID

OrderId

OrderId passed by you in the init request

ResultCode

Payment status (e.g. success = 0)

TotalPrice

Total price paid by the user for the transaction

PaymentType

Payment Channel ID chosen by the user

Checksum

A checksum to verify that messages have not been altered

Respond to this notification with a success message ResultCode=0 or a failure message (including an appropriate error code).

If you want to try receiving an error response, simply replace the error code digit with any of the available error codes, which you can access here.

Step 4: Check the status of a successful payment using the InquiryPaymentResult API call

Use the InquiryPaymentResult API call below to inquire about the payment status of your transaction.

Click here to see all the available parameters.

curl --location 'https://sandbox.codapayments.com/airtime/api/restful/v2.0/Payment/inquiryPaymentResult.json' \
--header 'Content-Type: application/json' \
--data '{
    "inquiryPaymentRequest":
    {
        "apiKey" : "test_32774abe1cd7d8bae650ea48265e",
        "country": 702 //This field is only needed for v2.0 API
        "projectId" : 21 //This field is only needed for v2.0 API
        "txnId" : "7144594637002072212",
        "needStatusFinal": "true"
    }
}'

curl --location 'https://sandbox.codapayments.com/airtime/api/restful/v1.0/Payment/inquiryPaymentResult.json' \
--header 'Content-Type: application/json' \
--data '{
    "inquiryPaymentRequest":
    {
        "apiKey" : "32774abe1cd7d8bae650ea48265e",
        "txnId" : "7144594637002072212",
        "needStatusFinal": "true"
    }
}'

{
    "paymentResult": {
        "orderId": 12321312321314,
        "profile": {
            "entry": [
                {
                    "key": "PaymentType",
                    "value": 427
                },
                {
                    "key": "isStatusFinal",
                    "value": true
                },
                {
                    "key": "status",
                    "value": "success"
                }
            ]
        },
        "resultCode": 0,
        "resultDesc": "",
        "totalPrice": 50,
        "txnId": 7144594637002072212
    }
}

Next steps

Dive deeper into Payment Page API to understand more about the Hosted Payment Page and Payment Channel Selection Page offering.
Dive deeper into our Backend API offering.

PreviousSet up payments

NextIntegration Guides

Last updated 7 months ago

Was this helpful?