API Documentation
  1. Checkout
API Documentation
  • API Reference Guide
    • Checkout Page
    • Payin - KRW (Server to Server)
    • Purpose Code
    • Payout Payload Example
    • List of Payin Methods
  • API Documentation
    • Master Data
      • Get All Country & Currency Code
    • Payout Method
      • Get Required Fields by Payout method
      • Get All Payout Method
    • Payin Method
      • Get All Payin Method
      • Get Required Fields by Payin method
    • Payout Beneficiary
      • Create Payout Beneficiary
      • Update Payout Beneficiary
      • Get All Payout Beneficiary
      • Get Payout Beneficiary by Id
      • Validation by Id
      • Validation by Body
    • Payin
      • Create Payin
      • Retrieve Payin
      • Retrieve Payin Memo (PDF)
      • Create Virtual Account
    • Payout
      • Create Payout
      • Simulate Payout
      • Retrieve Payout Memo (PDF)
      • Retrieve Payout
      • Get All Payout
    • Checkout
      • Create Payment Request
        POST
      • Get All Checkout
        GET
      • Cancel Checkout
        PATCH
      • Get Detail Checkout
        GET
      • Create Virtual Account [KRW]
        PATCH
      • Get VA Bank Information [KRW]
        GET
      • Create New Checkout
        PATCH
    • Transaction
      • Find Transaction by Id
      • Get All Transaction
    • Wallet
      • Create Wallet
      • Get All Wallet
      • Get by Wallet Id
    • Customer
      • Create Customer
      • Update Customer
      • Get All Customer
      • Get Detail Customer by Id
      • Check Is Customer Wallet Ready
      • Enable Customer
      • Disable Customer
      • Delete Customer
    • Webhook
      • Webhook PAYIN SUCCESS
      • Webhook PAYOUT SUCCESS
      • Webhook PAYOUT FAILED
      • VA Register Callback
    • Get List Payment Method by Currency
      GET
  • Features Documentation
    • Dashboard
    • Transaction
      • Payin
      • Payout
      • Rolling Reserve
      • Refund Request
    • Finance
      • Settlement Report APM
      • Settlement Report CARD
      • History Balance APM
      • History Balance CARD
    • Account
      • Profile Account
      • Manage Users
    • Setting
      • Integration Details
  1. Checkout

Create Payment Request

POST
/api/v1/checkout/payment-request
First Step to Create a Checkout. You have to create payment request first to generate Checkout Url.
1
Currency & Country Code
Fill in the currency field so the checkout page can display payment methods according to the currency. And for all european countries please fill in country_code with “EU”.
2
Amount
Fill in the amount of the transaction to calculate the amount to be paid by the customer. The amount field must match the amount in the order_items and order_fees.
3
Advanced Redirection Url
You can set the redirect url in the Create Payment API request message in the Advanced_redirect_url based on each payment status cancelled_url, completed_url, expired_url, failed_url. If it's not used, the value can be Null.
4
Additional Info
You can insert new object in additional_info such as Customer Information, and Transaction Date.
5
Order_items & Order_fees
The order_items consists of product_name, quantity, dan unit_price. And the order_fees consists of fee_name and fee_amount. You can choose whether to fill or not order_items or order_fees.
6
Send Request
After fill in the required fields, you can send a request to the API and will get the checkout page in the checkout_url field.
Each POST/PATCH Request requires a Signature in the header, you can follow the following code to create the Signature:
const crypto = require('crypto');
const signature = crypto.createHmac('sha256', signatureKey) .update(JSON.stringify(data)).digest('hex');

Request

Header Params
X-token
string 
required
Example:
snd_eyJpdiI6Ik9VQTFBOWF6Y0xIZWg3WFJJSDN3d3c9PSIsInZhbHVlIjoiQk02cUkwRUQzQVA1SndVTDFtYkFVa2hnS1Z6clA4Z1VnWkJvVzZzY1FEY1JwSEVhR3dheHg4RDNjckFLb3ZSMCIsIm1hYyI6ImQ2MTEyY2U5NDY3MzNkMDE5ODg5MWQzYWEwODA1Zjk4MzcwNjE5MWNkOGE4NTE1ZTYzZTM3MjRjNzEyZWVjYjciLCJ0YWciOiIifQ==
signature
string 
required
Hash your string payload request using SHA256, and use your SignatureKey as key
Body Params application/json
amount
integer 
required
Transaction amount. From order_items+order_fees
currency
string 
required
Transaction currency
country_code
string 
required
Merchant country code. ISO 3166-1, 2-char alphabetic code. For all european countries please fill in with “EU”
country_name
string 
required
Merchant country name.
description
string 
optional
customer_id
string 
optional
Mandatory if using EUR Currency
advanced_redirect_url
object 
required
Optional Advanced Redirection URLs. If it is not used, the value can be Null
cancelled_url
string 
required
Mandatory if advanced_redirect_url is used
completed_url
string 
required
Mandatory if advanced_redirect_url is used
expired_url
string 
required
Mandatory if advanced_redirect_url is used
failed_url
string 
required
Mandatory if advanced_redirect_url is used
additional_info
object 
required
payid_reference
string 
required
Pay Id Reference. Use this format (Invoice_DDMMYY_Counter). Counter is the id in the order of checkout in a day
transaction
string 
required
transaction_date
string 
required
Transaction Date
order_reference
string 
required
customer_full_name
string 
required
Customer Full Name
customer_email
string 
required
Customer Email
customer_phone
string 
required
Customer Phone
brand
string 
required
credit_type
string 
required
payer_id
string 
required
Payer Id
recon_id
string 
required
Reconciliation Id
order_reference_1
string 
required
order_reference_2
string 
required
platform_identifier
string 
optional
trx_type
string 
required
Value = "Checkout"
charge_back
integer 
required
retrieval
integer 
required
billing_address_country
string 
required
additional_info
object 
optional
Optional Mandatory, if using KRW Currency it must be filled
order_items
array [object {3}] 
required
Optional Order Items
product_name
string 
optional
quantity
integer 
optional
unit_price
integer 
optional
order_fees
array [object {2}] 
required
Order Fees
fee_name
string 
optional
fee_amount
integer 
optional
Example
{
  "amount": 241,
  "currency": "NZD",
  "country_code": "NZ",
  "country_name": "New Zealand",
  "description": "invoice_18062025_00002",
  "advanced_redirect_url": {
    "cancelled_url": "https://paycombat.com/cancelled",
    "completed_url": "https://paycombat.com/completed",
    "expired_url": "https://paycombat.com/expired",
    "failed_url": "https://paycombat.com/failed"
  },
  "additional_info": {
    "payid_reference": "invoice_18062025_00002",
    "transaction": "invoice_18062025_00002",
    "transaction_date": "2025-06-18T02:59:39.611Z",
    "order_reference": "invoice_18062025_00002",
    "customer_full_name": "JOHN Aji Lembur",
    "customer_email": "johndoe34@yopmail.com",
    "customer_phone": "+6285156781122",
    "brand": "JOHNDOEBRAND",
    "credit_type": "CHECKOUT",
    "payer_id": "2f872ec8-721d-40bd-a103-9e6a8db40dbb",
    "recon_id": "johndoe_recond_id",
    "order_reference_1": "invoice_18062025_00002",
    "order_reference_2": "invoice_18062025_00002",
    "platform_identifier": "PAYCOMBAT",
    "trx_type": "CHECKOUT",
    "charge_back": 0,
    "retrieval": 0,
    "billing_address_country": "SG",
    "additional_info": {
      "account_number": "11223344"
    }
  },
  "order_items": [
    {
      "product_name": "Mouse Logitech",
      "quantity": 9,
      "unit_price": 10
    }
  ],
  "order_fees": [
    {
      "fee_name": "ADMIN FEES",
      "fee_amount": 10
    }
  ]
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.paycombat.com/api/v1/checkout/payment-request' \
--header 'X-token: snd_eyJpdiI6Ik9VQTFBOWF6Y0xIZWg3WFJJSDN3d3c9PSIsInZhbHVlIjoiQk02cUkwRUQzQVA1SndVTDFtYkFVa2hnS1Z6clA4Z1VnWkJvVzZzY1FEY1JwSEVhR3dheHg4RDNjckFLb3ZSMCIsIm1hYyI6ImQ2MTEyY2U5NDY3MzNkMDE5ODg5MWQzYWEwODA1Zjk4MzcwNjE5MWNkOGE4NTE1ZTYzZTM3MjRjNzEyZWVjYjciLCJ0YWciOiIifQ==' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "amount": 241,
  "currency": "NZD",
  "country_code": "NZ",
  "country_name": "New Zealand",
  "description": "invoice_18062025_00002",
  "advanced_redirect_url": {
    "cancelled_url": "https://paycombat.com/cancelled",
    "completed_url": "https://paycombat.com/completed",
    "expired_url": "https://paycombat.com/expired",
    "failed_url": "https://paycombat.com/failed"
  },
  "additional_info": {
    "payid_reference": "invoice_18062025_00002",
    "transaction": "invoice_18062025_00002",
    "transaction_date": "2025-06-18T02:59:39.611Z",
    "order_reference": "invoice_18062025_00002",
    "customer_full_name": "JOHN Aji Lembur",
    "customer_email": "johndoe34@yopmail.com",
    "customer_phone": "+6285156781122",
    "brand": "JOHNDOEBRAND",
    "credit_type": "CHECKOUT",
    "payer_id": "2f872ec8-721d-40bd-a103-9e6a8db40dbb",
    "recon_id": "johndoe_recond_id",
    "order_reference_1": "invoice_18062025_00002",
    "order_reference_2": "invoice_18062025_00002",
    "platform_identifier": "PAYCOMBAT",
    "trx_type": "CHECKOUT",
    "charge_back": 0,
    "retrieval": 0,
    "billing_address_country": "SG",
    "additional_info": {
      "account_number": "11223344"
    }
  },
  "order_items": [
    {
      "product_name": "Mouse Logitech",
      "quantity": 9,
      "unit_price": 10
    }
  ],
  "order_fees": [
    {
      "fee_name": "ADMIN FEES",
      "fee_amount": 10
    }
  ]
}'

Responses

🟢200Success
application/json
Body
status
boolean 
required
Checkout status
message
string 
required
Message status
data
object 
required
id
string 
required
Transaction Id
checkout_token
string 
required
Checkout Token
amount
number 
required
Transaction Amount
currency
string 
required
Transaction Currency
country_code
string 
required
Merchant country code. ISO 3166-1, 2-char alphabetic code
payin_method_name
null 
required
Payin method name
payin_type
null 
required
Payin type
customer_id
string 
required
Customer ID
checkout_url
string 
required
Checkout Url
advanced_redirect_url
object 
required
Redirection Url
expire_at
string 
required
Checkout Expire Time
additional_info
object 
required
created_at
string 
required
updated_at
string 
required
deleted_at
null 
required
country_name
string 
required
Merchant Country Name
Example
{
    "status": true,
    "message": "OK",
    "data": {
        "id": "2a38bad1-5d20-4f19-8012-f5e7f4974296",
        "checkout_token": "59799c7baf089b6ddabc7c57fd7340ba9ed25c9d814e8328ab795b83e45d920d",
        "amount": 100,
        "currency": "KRW",
        "country_code": "KR",
        "payin_method_name": null,
        "payin_type": null,
        "customer_id": "customer_350635a488994af081ee67d57fc07322",
        "checkout_url": "https://staging-checkout.paycombat.dev/?token=59799c7baf089b6ddabc7c57fd7340ba9ed25c9d814e8328ab795b83e45d920d&identifier=snd_eyJpdiI6Im5MV29WS1NjZ1p4T0xVcHFINjlJR3c9PSIsInZhbHVlIjoiWXphYVpSN1YyazdGYllLdEY5ZFY5cTQ1N0tSRkkvZnRyak1UN1dyb0d3NjYrQ3duT08wT2RpNERRWnFpcUVhdCIsIm1hYyI6IjMzNzE5YWYzZjYzMzFjMDdhYTZiZjdmMDEwZDJiOTVjNmRlMzkzZmZkOWUyM2FmNTY1MzEyMWM4NDY0MTYzNWYiLCJ0YWciOiIifQ==",
        "advanced_redirect_url": {
            "cancelled_url": "https://paycombat.com/cancelled",
            "completed_url": "https://paycombat.com/completed",
            "expired_url": "https://paycombat.com/expired",
            "failed_url": "https://paycombat.com/failed"
        },
        "expire_at": "2025-04-01T15:48:37.000Z",
        "additional_info": {
            "payid_reference": "invoice_30032025_011",
            "transaction_date": "2025-03-30T02:59:39.611Z",
            "customer_full_name": "JOHN DOE",
            "customer_email": "johndoe@email.com",
            "customer_phone": "+6285156781122",
            "brand": "JOHNDOEBRAND",
            "payer_id": "johndoe_payer_id",
            "recon_id": "johndoe_recond_id",
            "trx_type": "CHECKOUT",
            "charge_back": 0,
            "retrieval": 0
        },
        "created_at": "2025-03-30T15:48:37.000Z",
        "updated_at": "2025-03-30T15:48:37.000Z",
        "deleted_at": null
    }
}
🟠400Bad Request
Modified at 2025-06-18 08:17:13
Previous
Get All Payout
Next
Get All Checkout