API Documentation
  1. Payin
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
        POST
      • Retrieve Payin
        GET
      • Retrieve Payin Memo (PDF)
        GET
      • Create Virtual Account
        POST
    • Payout
      • Create Payout
      • Simulate Payout
      • Retrieve Payout Memo (PDF)
      • Retrieve Payout
      • Get All Payout
    • Checkout
      • Create Payment Request
      • Get All Checkout
      • Cancel Checkout
      • Get Detail Checkout
      • Create Virtual Account [KRW]
      • Get VA Bank Information [KRW]
      • Create New Checkout
    • 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. Payin

Create Payin

POST
/api/v1/payin/create
This API is used to Create Payin. Payin is the primary Method for collecting funds from customers and depositing them into either the customer wallet or the Merchant's Payin wallet.
To successfully perform a Payin, the following APIs are required:
1.
Get All Payin Method
2.
Get Required Fields by Payin method
3.
Create Payin
4.
Simulate Payin
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
Merchant Personal Access Token
Example:
snd_eyJpdiI6InNRQzV0TERHV3JKeEpiMnkxMUpPK3c9PSIsInZhbHVlIjoiZ1JaRVBaZFJSd1MzVFpWMFVpcTB4TCtUK1FRMmxhd2NtRFdqVEVHUHh1MDIrdnErbzRBYlVkWjZBWWxHNlhPdyIsIm1hYyI6ImVjZDZlOTc5ZjdjMTRiMTc2YWQ4YTk2YjE3YWNhNzI5NGZlNzlhZDZkZmU3ODNjNDI0NWNlZmY1MGE2OGNiMTgiLCJ0YWciOiIifQ==
signature
string 
required
Hash your string payload request using SHA256, and use your SignatureKey as key
Body Params application/json
amount
integer 
required
currency
string 
required
payin_method_name
string 
required
payin_method_param
object 
required
payid_reference
string 
required
payment_method
string 
required
transaction
string 
required
transaction_date
string 
required
order_reference
string 
required
Unique
customer_full_name
string 
required
reply_code
string 
required
brand
string 
required
credit_type
string 
required
payer_id
string 
required
recon_id
string 
required
order_reference_1
string 
required
order_reference_2
string 
required
platform_identifier
string 
required
customer_id
string 
required
billing_address_country
string 
required
trx_type
string 
required
customer_email
string 
required
customer_phone
string 
required
charge_back
integer 
required
retrieval
integer 
required
is_black_list
integer 
required
fee_taken
integer 
required
fee_expected
integer 
required
rolling_serve
integer 
required
customer_personal_number
string 
optional
ip_address
string 
optional
billing_address_city
string 
optional
billing_address_zip_code
string 
optional
billing_address
string 
optional
bin
string 
optional
is_3ds
string 
optional
payment_date
string 
optional
redirect_url
string 
optional
advanced_redirect_url
object 
optional
cancelled_url
string 
required
completed_url
string 
required
expired_url
string 
required
failed_url
string 
required
fees_wallet_id
string 
optional
credit_wallet_id
string 
optional
receipt_email
string 
optional
checkout_id
string 
optional
description
string 
optional
organization_reference_id
string 
optional
metadata
object 
optional
expire_at
integer 
optional
Example
{
    "amount": 123,
    "currency": "NZD",
    "payin_method_name": "nz_bank_poli_nzd",
    "payin_method_param": {
        "payid_reference": "invoice_03062025_00001"
    },
    "payment_method": "nz_bank_poli_nzd",
    "transaction": "invoice_03062025_00001",
    "transaction_date": "2025-06-03T13:18:09.478Z",
    "order_reference": "invoice_03062025_00001",
    "customer_full_name": "Fajar Rabu",
    "reply_code": "1234",
    "brand": "Blackpink",
    "credit_type": "PAYIN",
    "payer_id": "582875b1-15c4-4826-a9e2-9afa1993569b",
    "recon_id": "invoice_03062025_00001",
    "order_reference_1": "invoice_03062025_00001",
    "order_reference_2": "invoice_03062025_00001",
    "platform_identifier": "invoice_26052025_000055",
    "billing_address_country": "NZ",
    "trx_type": "DIRECT_PAYIN",
    "customer_email": "fajar32@yopmail.com",
    "customer_phone": "+6285156781122",
    "charge_back": 0,
    "retrieval": 0,
    "is_black_list": 0
}

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/payin/create' \
--header 'X-token: snd_eyJpdiI6InNRQzV0TERHV3JKeEpiMnkxMUpPK3c9PSIsInZhbHVlIjoiZ1JaRVBaZFJSd1MzVFpWMFVpcTB4TCtUK1FRMmxhd2NtRFdqVEVHUHh1MDIrdnErbzRBYlVkWjZBWWxHNlhPdyIsIm1hYyI6ImVjZDZlOTc5ZjdjMTRiMTc2YWQ4YTk2YjE3YWNhNzI5NGZlNzlhZDZkZmU3ODNjNDI0NWNlZmY1MGE2OGNiMTgiLCJ0YWciOiIifQ==' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 123,
    "currency": "NZD",
    "payin_method_name": "nz_bank_poli_nzd",
    "payin_method_param": {
        "payid_reference": "invoice_03062025_00001"
    },
    "payment_method": "nz_bank_poli_nzd",
    "transaction": "invoice_03062025_00001",
    "transaction_date": "2025-06-03T13:18:09.478Z",
    "order_reference": "invoice_03062025_00001",
    "customer_full_name": "Fajar Rabu",
    "reply_code": "1234",
    "brand": "Blackpink",
    "credit_type": "PAYIN",
    "payer_id": "582875b1-15c4-4826-a9e2-9afa1993569b",
    "recon_id": "invoice_03062025_00001",
    "order_reference_1": "invoice_03062025_00001",
    "order_reference_2": "invoice_03062025_00001",
    "platform_identifier": "invoice_26052025_000055",
    "billing_address_country": "NZ",
    "trx_type": "DIRECT_PAYIN",
    "customer_email": "fajar32@yopmail.com",
    "customer_phone": "+6285156781122",
    "charge_back": 0,
    "retrieval": 0,
    "is_black_list": 0
}'

Responses

🟢200Success
application/json
Body
status
boolean 
required
message
string 
required
data
object 
required
id
string 
required
merchant_id
string 
required
reply_code_id_pg
string 
required
status
string 
required
amount
string 
required
original_amount
string 
required
amount_type
string 
required
transaction
string 
required
transaction_date
string 
required
payment_method
string 
required
order_reference
string 
required
customer_full_name
string 
required
reply_code
string 
required
brand
string 
required
currency
string 
required
credit_type
string 
required
payer_id
string 
required
recon_id
string 
required
order_reference_1
string 
required
order_reference_2
string 
required
platform_identifier
string 
required
trx_type
string 
required
customer_email
string 
required
customer_phone
string 
required
customer_personal_number
string 
required
fee_taken
string 
required
fee_expected
string 
required
charge_back
string 
required
rolling_serve
string 
required
retrieval
string 
required
is_black_list
integer 
required
ip_address
string 
required
billing_address_country
string 
required
billing_address_city
string 
required
billing_address_zip_code
string 
required
billing_address
string 
required
bin
string 
required
is_3ds
string 
required
created_at
string 
required
updated_at
string 
required
deleted_at
null 
required
payment_date
null 
required
Example
{
  "status": true,
  "message": "OK",
  "data": {
    "id": "c2fe7846-494f-4852-8ca2-a72499d0002e",
    "merchant_id": "5dc46f8a-4924-4392-967b-81652396a175",
    "reply_code_id_pg": "payin_b9b9b3dd72da4c9fa64c197129dbbacd",
    "status": "PENDING",
    "amount": "97",
    "original_amount": "100",
    "amount_type": "AUD",
    "transaction": "invoice_06032025_002",
    "transaction_date": "2024-03-06T13:18:09.000Z",
    "payment_method": "au_bank_npp",
    "order_reference": "invoice_06032025_002",
    "customer_full_name": "Lalisa Manobal",
    "reply_code": "invoice_06032025_002@paycombat.com",
    "brand": "Blackpink",
    "currency": "FIAT",
    "credit_type": "PAYIN",
    "payer_id": "invoice_06032025_002",
    "recon_id": "invoice_06032025_002",
    "order_reference_1": "invoice_06032025_002",
    "order_reference_2": "invoice_06032025_002",
    "platform_identifier": "invoice_06032025_002",
    "trx_type": "DIRECT_PAYIN",
    "customer_email": "lalisamanobal@gmail.com",
    "customer_phone": "+6285156781122",
    "customer_personal_number": "",
    "fee_taken": "3",
    "fee_expected": "3",
    "charge_back": "0",
    "rolling_serve": "0",
    "retrieval": "0",
    "is_black_list": 0,
    "ip_address": "",
    "billing_address_country": "AU",
    "billing_address_city": "",
    "billing_address_zip_code": "",
    "billing_address": "",
    "bin": "",
    "is_3ds": "",
    "created_at": "2025-03-06T05:45:22.000Z",
    "updated_at": "2025-03-06T05:45:22.000Z",
    "deleted_at": null,
    "payment_date": null
  }
}
🟠400Bad Request
Modified at 2025-06-03 08:37:38
Previous
Validation by Body
Next
Retrieve Payin