Simulate Payout - API Documentation

This API is used to simulate the completion of a Payout that has been created.

The Payout must be in a PENDING status to complete it. Upon successful execution, the Payout status updates to COMPLETED, FAILED orRETURNED. If the Payout is not in a PENDING status, 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_eyJpdiI6IlNQclVGNlUxOUxkaEdsVmdTTUtYZUE9PSIsInZhbHVlIjoiOWJUSFdRWGpOUXcxeTJjQ1FEQ1dUNXRGTFg0SC9JRjhiYk9xMGt0dmsyRFdhaVdSZXQ1RGNnQ3l2Ujl1S0tqdiIsIm1hYyI6IjNmZWZjMTI5MzY3NTNjMGVkNWNlZGYwMWE1YzJhZTgzMGMwYzU4NTE2YzczY2FmOTVhMzAwYmMwYjRjMWExY2YiLCJ0YWciOiIifQ==

signature

string

required

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

Body Params application/json

payout_id

string

required

status

string

required

beneficiary_amount

integer

optional

beneficiary_currency

string

optional

Example

{
    "payout_id": "24cc76a6-4433-443c-9c0f-3607c294c32e",
    "status": "COMPLETED",
    "beneficiary_amount": 13.7,
    "beneficiary_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

wire_id

string

required

order_id

null

required

due_date

string

required

last_action

null

required

wire_amount

integer

required

fee_taken

number

required

fee_expected

integer

required

payee_name

string

required

currency

string

required

beneficiary

string

required

beneficiary_bank

string

required

beneficiary_account_number

null

required

beneficiary_account_iban

null

required

wire_origin

null

required

conversion

null

required

approval

string

required

created_at

string

required

updated_at

string

required

approved_at

null

required

denied_at

null

required

pending_at

null

required

Example

{
  "status": true,
  "message": "OK",
  "data": {
    "id": "edc1f92c-12c2-4b80-bf32-c24dcc0dfa1e",
    "merchant_id": "2a776a4a-ad24-4ccb-80ce-fd58bd0e5880",
    "reply_code_id_pg": "payout_9d84899053d44777b0d53345353ffa98",
    "status": "COMPLETED",
    "wire_id": "w_txn_95d18bef65d74d179e78a2902c8d6723",
    "order_id": null,
    "due_date": "2025-02-25T00:00:00.000Z",
    "last_action": null,
    "wire_amount": 97,
    "fee_taken": 1.94,
    "fee_expected": 3,
    "payee_name": "Fajar test",
    "currency": "AUD",
    "beneficiary": "Fajar test",
    "beneficiary_bank": "au_bank_acct",
    "beneficiary_account_number": null,
    "beneficiary_account_iban": null,
    "wire_origin": null,
    "conversion": null,
    "approval": "APPROVED",
    "created_at": "2025-02-24T01:56:32.000Z",
    "updated_at": "2025-02-24T02:00:29.000Z",
    "approved_at": null,
    "denied_at": null,
    "pending_at": null
  }
}

🟠404Record Not Found

🟠400Bad Request