Get All Payout - API Documentation

Request

Query Params

status

string

optional

List transactions by Payout Status (IN_PROGRESS, COMPLETED, FAILED)

Example:

IN_PROGRESS

limit

string

required

Example:

10

page

string

required

Example:

1

Header Params

X-token

string

required

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.paycombat.com/api/v1/payout-method/all-payout?status=IN_PROGRESS&limit=10&page=1' \
--header 'X-token;'

Responses

🟢200Success

application/json

Body

status

boolean

required

message

string

required

data

array [object {26}]

required

id

string

optional

merchant_id

string

optional

reply_code_id_pg

string

optional

status

string

optional

wire_id

string

optional

order_id

null

optional

due_date

string

optional

last_action

null

optional

wire_amount

integer

optional

fee_taken

number

optional

fee_expected

integer

optional

payee_name

string

optional

currency

string

optional

beneficiary

string

optional

beneficiary_bank

string

optional

beneficiary_account_number

null

optional

beneficiary_account_iban

null

optional

wire_origin

null

optional

conversion

null

optional

approval

string

optional

created_at

string

optional

updated_at

string

optional

approved_at

null

optional

denied_at

null

optional

pending_at

null

optional

process

string

optional

total

integer

required

page

integer

required

limit

integer

required

totalPages

integer

required

Example

{
  "status": true,
  "message": "OK",
  "data": [
    {
      "id": "d3fd5183-4e1a-447d-b627-c4d4b79d8ae2",
      "merchant_id": "2a776a4a-ad24-4ccb-80ce-fd58bd0e5880",
      "reply_code_id_pg": "payout_0284130f970b4c65905f1318afbe804d",
      "status": "PENDING",
      "wire_id": "w_txn_0f41cc9d90014b9ca17a2d4b0aa7a7ef",
      "order_id": null,
      "due_date": "2025-02-20T00:00:00.000Z",
      "last_action": null,
      "wire_amount": 98,
      "fee_taken": 1.96,
      "fee_expected": 2,
      "payee_name": "Fajar",
      "currency": "AUD",
      "beneficiary": "Fajar",
      "beneficiary_bank": "au_bank_acct",
      "beneficiary_account_number": null,
      "beneficiary_account_iban": null,
      "wire_origin": null,
      "conversion": null,
      "approval": "APPROVED",
      "created_at": "2025-02-19T08:04:50.000Z",
      "updated_at": "2025-02-19T08:04:51.000Z",
      "approved_at": null,
      "denied_at": null,
      "pending_at": null
    }
  ],
  "total": 7,
  "page": 5,
  "limit": 1,
  "totalPages": 7
}

🟠400Bad Request