Checkout Invoice · PGSwift Docs

Merchants can use this API to create a checkout interface for processing transactions.

POST /api/checkout

Request

Name	Type	Required	Validation	Description
merchant_transaction_id	string	true		Merchant-provided unique transaction identifier.
amount	string	true	Numeric, 1-12 digits	Transaction amount expressed as a numeric value.
currency	string	true	Allowed value: `"IDR"`	Transaction currency (only Indonesian Rupiah is supported).
customer_name	string	true	5-25 characters, Allowed: `a-z A-Z 0-9 - (space)`	Customer name linked to the transaction.
product_name	string	true	5-25 characters, Allowed: `a-z A-Z 0-9 - (space)`	Product name linked to the transaction.
description	string	false		Optional transaction details.
success_redirect_url	string	false		URL to redirect the customer upon successful payment. Also supports mobile deep link URLs.

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

Response

Name	Description
transaction_id	System-generated unique transaction identifier.
client_id	Client identifier of the requesting party
amount	Numeric representation of the transaction amount.
currency	Currency code used in the transaction (IDR is the only supported currency).
description	Transaction description text.
customer_details	Customer information, returned as a JSON-encoded string — parse it before reading the fields below.
customer_details.customer_name	Name of the customer for this transaction. Available only after parsing `customer_details`.
customer_details.product_name	Name of the product for this transaction. Available only after parsing `customer_details`.
customer_obj	The same customer information as `customer_details`, returned as a JSON object. No parsing needed. null if `customer_details` is empty or not valid JSON.
checkout_url	Web URL where users can complete payment through their browser.
success_redirect_url	URL to redirect the customer upon successful payment. Also supports mobile deep link URLs.

Use the HTTP status code to detect failure: any non-2xx response is a failure. The failure body has one of three shapes, shown in the tabs below. Authentication and IP whitelist errors use the shapes described in Error Responses.

{
    "transaction_id": "9e536777-2bfa-4161-9931-35f5c4b23faf",
    "client_id": "9dbf86be-f9e9-4000-8b39-fdd5a841fce1",
    "amount": "100000",
    "currency": "IDR",
    "description": "Order Product",
    "customer_details": "{\"customer_name\":\"John Doe\",\"product_name\":\"Product Test\"}",
    "customer_obj": {
        "customer_name": "John Doe",
        "product_name": "Product Test"
    },
    "checkout_url": "{host}/checkout/9e536777-2bfa-4161-9931-35f5c4b23faf",
    "success_redirect_url": "https://example.com/success"
}

The request body failed validation. errors lists the messages per field.

{
    "success": false,
    "message": "Validation errors occurred.",
    "errors": {
        "amount": ["The amount field is required."]
    }
}

The request was rejected while it was being processed. The HTTP status matches the error. error.code is often 0, so match on the HTTP status instead.

{
    "error": {
        "code": 0,
        "message": "Error description"
    }
}

An unexpected error occurred. Retry after a brief delay.

{
    "status": false,
    "data": null,
    "message": "Error description"
}

Payment Expiry (TTL)

Webhook