Simulate Payin - API Documentation

This API is used to simulate the completion or cancellation of a Payin that has been created.

The Payin must be in a PENDING status to complete or cancel it. Upon successful execution, the Payin status updates to COMPLETED or CANCELLED. If the Payin is not in a PENDING status or if you attempt to complete an already completed or cancelled Payin, an error will be returned.

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_eyJpdiI6Imp0dFhxUWY2cEVvQ1U2KzVsK0VZclE9PSIsInZhbHVlIjoieGo0MU9IdktINW5nRXExZVRBRjlZOTN6ZFFYNEJ5WUZDWW9obUlPcm4xN0tjQURWWCtFSEVKNzJsYnhSNXZXdyIsIm1hYyI6ImRmYmMyN2QzOTk5ZDI0NWZiYWZkOGRjYzBmYjg1ODZiZTliNjk1OTg0MWM4ZGRhYmZlNzI0MzFmZGFmN2YzNjUiLCJ0YWciOiIifQ==

signature

string

required

Hash your string payload request using SHA256, and use your SignatureKey as key

Body Params application/json

payin_id

string

required

status

string

required

amount

integer

optional

currency

string

optional

Example

{
    "payin_id": "be8d59fd-fda5-4350-83b4-a0eb893aa402",
    "status": "CANCELLED",
    "amount": 128,
    "currency": "NZD"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

status

boolean

required

message

string

required

data

object

required

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

Examples

SuccessSuccess

{
  "status": true,
  "message": "OK",
  "data": {
    "id": "b442ba6c-74cb-4a5b-a921-33dabb77c25e",
    "merchant_id": "2c23d9af-d8b5-42fd-ae4b-cf9b111f4e55",
    "reply_code_id_pg": "payin_dd2962af112545d492a98486d875e81e",
    "status": "SUCCESS",
    "amount": "9.9",
    "original_amount": "10",
    "amount_type": "AUD",
    "transaction": "invoice_20022025_222",
    "transaction_date": "2025-02-28T13:18:09.000Z",
    "payment_method": "au_bank_npp",
    "order_reference": "invoice_28022025_222",
    "customer_full_name": "Leonardo 2 Jumat",
    "reply_code": "invoice_28022025_222@paycombat.com",
    "brand": "Blackpink",
    "currency": "FIAT",
    "credit_type": "PAYIN",
    "payer_id": "invoice_29122024_098",
    "recon_id": "string",
    "order_reference_1": "invoice_28022025_222",
    "order_reference_2": "invoice_28022025_222",
    "platform_identifier": "invoice_28022025_222",
    "trx_type": "DIRECT_PAYIN",
    "customer_email": "leonardo22@yopmail.com",
    "customer_phone": "+6285156781122",
    "customer_personal_number": "",
    "fee_taken": "0.1",
    "fee_expected": "0.1",
    "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-02-28T04:36:40.000Z",
    "updated_at": "2025-02-28T08:54:27.000Z",
    "deleted_at": null,
    "payment_date": null
  }
}

🟠400Bad Request