Charge

这代表向Shopper收取Token费用。Charge ID是Coda生成的唯一标识符，用于识别各个费用交易。

Charge 对象

参数名称	类型	描述
id	String	Coda生成的token ID
created_at	String	合作伙伴将用于识别其客户并链接token ID 的 ID
status_code	String	Token的状态码
token_id	String	连结的token ID
partner_reference	String	合作伙伴参考 ID 长度必须介于 4 到 64 之间，并且必须遵循模式 ^[a-zA-Z0-9-_]+$
item_code	String	被扣款商品的代码
item_name	String	被扣款商品的名称
amount_value	String	商品的扣款金额
amount_currency	String	收取金额的货币
subscription_id	String	订阅 ID（如果选择加入订阅）
shopper_action	String	Shopper 扣款流程操作
shopper_action.id	String	Shopper 扣款操作 ID
shopper_action.type	String	Shopper 扣款操作类型（例如：重定向）
shopper_action.redirection	String	Shopper 扣款重定向实体
shopper_action.redirection.id	String	Shopper 扣款重定向 ID
shopper_action.redirection.method	String	Shopper 扣款重定向 URL 方法类型（例如：GET/POST）
shopper_action.redirection.url	String	Shopper 扣款重定向 URL

接口

接口

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

创建带有 Shopper 操作的扣款

POST /charges

Charges

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

带有 Shopper 操作的扣款响应对象

Charge

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

创建无需 Shopper 操作的扣款

POST /charges

Charge

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
}'

响应Charge对象

Charge

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

取消Charge

GET /charges/{id}

Request

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

响应收费对象

Charge

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

请求参数

参数名称	类型	必填？	描述	验证
token_id	String	是	Coda生成的token ID	Token ID 长度必须介于 20 到 32 之间 并且必须遵循模式“[A-Za-z]+_[A-Za-z0-9]+”
item_code	String	是	收费项目代码	不能为空
item_name	String	是	收费项目名称	不能为空
amount_value	String	是	商品的收费数值	不不能为空 必须匹配“^\d+(.\d{1,2})?$”
amount_currency	String	是	收取金额的货币	不能为空 大小必须为 3
partner_reference	String	是	合作伙伴参考 ID	合作伙伴参考号不能为空，长度必须介于 4 到 64 之间，并且必须遵循模式 ^[a-zA-Z0-9-_]+$
token.payment_method.card.security_code	String	否	卡安全代码 (CSC/CVV) 是卡付款方式成功创建费用的必填字段。其他付款方式（例如 GoPay）可选填	安全码长度必须为 3