Create Payout - API Documentation

Request

Header Params

X-token

string

required

Example:

snd_eyJpdiI6InpjMUp2UHdRcVRFd0ZuL3BEdHVjK1E9PSIsInZhbHVlIjoibnlzOHFaS2JjdHoyQUhvUGZ0bjJtR1NsOEJPaEVSWGV3dUROU1JHNkpYTzRkbDkxVDNqRVo0Q2s4R2JiNHZjbSIsIm1hYyI6IjViOGE2ZmQ1ODgzMGQ3NzQ2MDZiMjg2ZDNhNzk0OWUwOGU2YWVjYjVmZGI1YzM3M2RiYjIxNmU5Yzc1YzQ1ZjIiLCJ0YWciOiIifQ==

signature

string

required

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

Body Params application/json

payout_beneficiary_param

object

required

individual

object

required

account_number

string

required

base_param

object

required

bsb

string

optional

sender_amount

integer

required

sender_currency

string

required

beneficiary_currency

string

required

beneficiary_country

string

required

payout_method_name

string

required

order_id

string

optional

purpose_code

string

required

sender_country

string

required

For all european countries please fill in with “EU”

Example

{
    "payout_beneficiary_param": {
        "individual": {
            "first_name": "Fajar SGD"
        },
        "base_param": {
            "bank_name": "BKASH",
            "bank_code": 2001
        },
        "account_number": "123456789098909",
        "bsb": "123456"
    },
    "sender_amount": 2,
    "sender_currency": "SGD",
    "sender_country": "SG",
    "beneficiary_currency": "SGD",
    "payout_method_name": "sg_bank_mepspayment_sgd",
    "order_id": "payout_123456",
    "purpose_code": "SELF"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.paycombat.com/api/v1/payout/create-payout' \
--header 'X-token: snd_eyJpdiI6InpjMUp2UHdRcVRFd0ZuL3BEdHVjK1E9PSIsInZhbHVlIjoibnlzOHFaS2JjdHoyQUhvUGZ0bjJtR1NsOEJPaEVSWGV3dUROU1JHNkpYTzRkbDkxVDNqRVo0Q2s4R2JiNHZjbSIsIm1hYyI6IjViOGE2ZmQ1ODgzMGQ3NzQ2MDZiMjg2ZDNhNzk0OWUwOGU2YWVjYjVmZGI1YzM3M2RiYjIxNmU5Yzc1YzQ1ZjIiLCJ0YWciOiIifQ==' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payout_beneficiary_param": {
        "individual": {
            "first_name": "Fajar SGD"
        },
        "base_param": {
            "bank_name": "BKASH",
            "bank_code": 2001
        },
        "account_number": "123456789098909",
        "bsb": "123456"
    },
    "sender_amount": 2,
    "sender_currency": "SGD",
    "sender_country": "SG",
    "beneficiary_currency": "SGD",
    "payout_method_name": "sg_bank_mepspayment_sgd",
    "order_id": "payout_123456",
    "purpose_code": "SELF"
}'

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

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

process

string

required

Examples

SuccessException

{
  "status": true,
  "message": "Created",
  "data": {
    "id": "edc1f92c-12c2-4b80-bf32-c24dcc0dfa1e",
    "merchant_id": "2a776a4a-ad24-4ccb-80ce-fd58bd0e5880",
    "reply_code_id_pg": "payout_9d84899053d44777b0d53345353ffa98",
    "status": "PENDING",
    "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-24T01:56:33.000Z",
    "approved_at": null,
    "denied_at": null,
    "pending_at": null
  }
}

🟠404Record Not Found

🟠400Bad Request