跳转到内容
PGSwift Docs
文档/结账虚拟账户发票

结账虚拟账户发票

您可使用此接口创建用于虚拟账户交易的结账页面

POST /api/checkout/va

请求

名称类型必填输入校验描述
merchant_transaction_idstringtrue商户提供的唯一交易标识符
amountstringtrue数字型, 1-12 数字交易金额的数值表示。
currencystringtrue

允许的取值:

"IDR"

交易使用的货币(仅支持印尼卢比)。
customer_namestringtrue长度为 5 至 25 个字符,允许的取值: a-z A-Z 0-9 - (space)与该交易关联的客户姓名
product_namestringtrue长度为 5 至 25 个字符,允许的取值:a-z A-Z 0-9 - (space)与该交易关联的产品名称
descriptionstringfalse可选的交易补充信息
success_redirect_urlstringfalse付款成功后重定向客户的 URL。也支持移动端深度链接 (Deep Link) URL。
company_namestringfalse贵公司名称,在客户通过虚拟账户付款时显示为虚拟账户名称。仅部分银行支持;其他银行显示默认名称。允许字符:字母 A-Z、空格和 .,其他字符(包括数字)会被移除。超过 30 个字符的值会被截断,剩余字母少于 3 个时该值将被忽略(例如 A+B 变为 AB,因此被忽略)。
{
  "merchant_transaction_id": "ICZ10000001",
  "amount": "100000",
  "currency": "IDR",
  "description": "Lorem Ipsum",
  "customer_name": "John Doe",
  "product_name": "Product Test",
  "success_redirect_url": "https://example.com/success",
  "company_name": "PT Maju Jaya"
}

响应

名称 描述
transaction_id 系统生成的唯一交易标识符
client_id 请求方的客户端标识符
amount 交易金额的数值表示
currency 交易使用的货币代码,仅支持印尼卢比(IDR)
description 交易描述文本
customer_details JSON 编码的字符串,包含 customer_name、product_name 以及 company_name(如有发送)。请解析该字符串,或直接使用 customer_obj。
customer_details.customer_name 该交易的客户姓名。需先解析 customer_details 后才可读取。
customer_details.product_name 该交易的产品名称。需先解析 customer_details 后才可读取。
customer_obj 以对象形式返回的相同数据。仅在发送了 company_name 时包含该字段。详情为空或无效时为 null。
checkout_url 用户可通过浏览器完成支付的网页 URL
success_redirect_url 付款成功后重定向客户的 URL。也支持移动端深度链接 (Deep Link) URL。
{
    "transaction_id": "08a30e1b-2ef2-435b-b1fb-9885eb70545e",
    "client_id": "da2ca5d8-dbc2-4cf3-b101-e804af8ea644",
    "amount": "100000",
    "currency": "IDR",
    "description": "Order Product",
    "customer_details": "{\"customer_name\":\"John Doe\",\"product_name\":\"Product Test\",\"company_name\":\"PT Maju Jaya\"}",
    "customer_obj": {
        "customer_name": "John Doe",
        "product_name": "Product Test",
        "company_name": "PT Maju Jaya"
    },
    "checkout_url": "{host}/checkout/va/08a30e1b-2ef2-435b-b1fb-9885eb70545e",
    "success_redirect_url": "https://example.com/success"
}

支付过期时间(TTL)


Webhook