Charge

This represents charging the shopper with a token. The charge ID is a unique identifier generated by Coda to identify individual charge transactions.

Charge Object

Parameter name	Type	Description
id	String	Charge ID generated by Coda
created_at	String	ID the partner will use to identify their customer and link the token ID
status_code	String	The status code of the charge
token_id	String	The token ID associated
partner_reference	String	Partner reference Id Length must be between 4 and 64 and must follow the pattern ^[a-zA-Z0-9-_]+$
item_code	String	The code of item charged
item_name	String	The name of item charged
amount_value	String	The charged numerical value of the item
amount_currency	String	The currency of the value charged
subscription_id	String	The subscription id if opted-in subscription
shopper_action	String	Shopper action for charge flow
shopper_action.id	String	Charge shopper action ID
shopper_action.type	String	Charge shopper action type e.g redirection
shopper_action.redirection	String	Charge shopper redirection entity
shopper_action.redirection.id	String	Charge Shopper redirection ID
shopper_action.redirection.method	String	Charge Shopper redirect url method type e.g GET/POST
shopper_action.redirection.url	String	Charge Shopper redirect url

Base URL

Version	Base URL
Sandbox	https://api-tc.codapayments-staging.com
Production	https://api-tc.codapayments.com

Endpoints

Unset

POST  {Base URL}/v1/charges
GET  {Base URL}/v1/charges/{charge.id}

Create new Charge with Shopper Action

POST /charges

Unset

curl --location '{baseUrl}/v1/charges' \
--header 'X-Partner-Id: par_sg1882402279a0000' \
--header 'X-Api-Key: sdirugnvsiguhsirghsekjhgh' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXJ0bmVyX2lkIjoicGFyX3NnMTg4MjQwMjI3OWEwMDAwIiwiaWF0IjoxNzAxMjMzNTM0fQ.o_tcEJUEwEms49J0MXwvRuCGbsBx3rHugfgKsXVgj9I' \
--data '{
  "token_id": "tkn_sg18bffd6a3ae0003",
  "item_code": "item-code-28",
  "item_name": "item-name-28",
  "amount_value": "28",
  "amount_currency": "SAR",
 "partner_reference": "partner-reference-123",
 "token" : {
    "payment_method": {
      "card": {
        "security_code": "xxx"      
      }
    }
  }
}'

Response Charge Object with Shopper Action

Unset

{
    "id": "chg_sg18bffdcebd30018",
    "created_at": "2023-11-24T05:45:50.291546075Z",
    "status_code": "waiting_for_shopper_action",
    "token_id": "tkn_sg18bffd6a3ae0003",
    "partner_reference":"partner-reference-123",
    "item_code": "item-code-28",
    "item_name": "item-name-28",
    "amount_value": "28",
    "amount_currency": "SAR",
    "subscription_id": null,
    "shopper_action": {
        "id": "csa_sg18bffdcf7700007",
        "type": "redirection",
        "redirection": {
            "id": "car_sg18bffdcf82d0007",
            "method": "GET",
            "url": "https://cdn1.codapayments.com/W/pub/tc/mada/authenticate-payer.html?action=https%3A%2F%2Fap.gateway.mastercard.com%2Facs%2Fmastercard%2Fv2%2Fprompt&creq=eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6IjZjMzViOTNjLTYwN2QtNGQ1MC1iZWRmLWFlOWJjZDg1M2I3YiJ9"
        }
    }
}

Create Charge without Shopper Shopper Action

POST /charges

Unset

curl --location '{baseUrl}/v1/charges' \
--header 'X-Partner-Id: par_sg1882402279a0000' \
--header 'X-Api-Key: sdirugnvsiguhsirghsekjhgh' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXJ0bmVyX2lkIjoicGFyX3NnMTg4MjQwMjI3OWEwMDAwIiwiaWF0IjoxNzAxMjMzNTM0fQ.o_tcEJUEwEms49J0MXwvRuCGbsBx3rHugfgKsXVgj9I' \
--data '{
  "token_id": "tkn_sg18c23a062a90007",
  "item_code": "item-code-585",
  "item_name": "item-name-585",
  "amount_value": "585",
  "amount_currency": "IDR",
  "partner_reference": 123456789
}'

Response Charge Object

Unset

{
    "id": "chg_sg18c23a11fff0008",
    "created_at": "2023-12-01T04:26:51.263110116Z",
    "status_code": "succeeded",
    "token_id": "tkn_sg18c23a062a90007",
    "partner_reference": "123456789",
    "item_code": "item-code-585",
    "item_name": "item-name-585",
    "amount_value": "585",
    "amount_currency": "IDR",
    "subscription_id": null,
    "shopper_action": null
}

Retrieve Charge

GET /charges/{id}

Request

Unset

curl --location '{baseUrl}/v1/charges/chg_sg18bffe4bd460001' \
--header 'X-Partner-Id: par_sg1882402279a0000' \
--header 'X-Api-Key: sdirugnvsiguhsirghsekjhgh' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXJ0bmVyX2lkIjoicGFyX3NnMTg4MjQwMjI3OWEwMDAwIiwiaWF0IjoxNzAxMjMzNTM0fQ.o_tcEJUEwEms49J0MXwvRuCGbsBx3rHugfgKsXVgj9I' \
--data ''

Response Charge Object

Unset

{
    "id": "chg_sg18bffe4bd460001",
    "created_at": "2023-11-24T05:54:22.662466Z",
    "status_code": "succeeded",
    "token_id": "tkn_sg18bffd6a3ae0003",
    "partner_reference": null,
    "item_code": "item-code-160",
    "item_name": "item-name-160",
    "amount_value": "120",
    "amount_currency": "SAR",
    "subscription_id": null,
    "shopper_action": null
}

Request Parameters

Parameter name	Type	Required?	Description	Validation
token_id	String	Yes	Token ID generated by Coda	Token ID length must be between 20 and 32 And must follow the pattern "[A-Za-z]+_[A-Za-z0-9]+"
item_code	String	Yes	The code of item charged	Must not be blank
item_name	String	Yes	The name of item charged	Must not be blank
amount_value	String	Yes	The charged numerical value of the item	Must not be blank Must match "^\d+(.\d{1,2})?$"
amount_currency	String	Yes	The currency of the value charged	Must not be blank Size must be 3
partner_reference	String	Yes	Partner Reference ID	Partner reference must not be blank and length must be between 4 and 64 and must follow the pattern ^[a-zA-Z0-9-_]+$
token.payment_method.card.security_code	String	No	The Card Security Code (CSC/CVV) is a required field for card payment methods to successfully create charge. Optional for other payment method such as GoPay	Security Code length must be 3.