Skip to main content
POST
/
api
/
v1
/
payout
/
inquiry
Payout inquiry
curl --request POST \
  --url https://api.example.com/api/v1/payout/inquiry \
  --header 'Content-Type: application/json' \
  --data '
{
  "payoutRequestId": "<string>",
  "payoutOrderId": "<string>"
}
'
import requests

url = "https://api.example.com/api/v1/payout/inquiry"

payload = {
"payoutRequestId": "<string>",
"payoutOrderId": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({payoutRequestId: '<string>', payoutOrderId: '<string>'})
};

fetch('https://api.example.com/api/v1/payout/inquiry', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/payout/inquiry",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'payoutRequestId' => '<string>',
'payoutOrderId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/v1/payout/inquiry"

payload := strings.NewReader("{\n \"payoutRequestId\": \"<string>\",\n \"payoutOrderId\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/payout/inquiry")
.header("Content-Type", "application/json")
.body("{\n \"payoutRequestId\": \"<string>\",\n \"payoutOrderId\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/payout/inquiry")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"payoutRequestId\": \"<string>\",\n \"payoutOrderId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "code": 0,
  "msg": "success",
  "data": {
    "mid": "<string>",
    "subMid": "<string>",
    "payoutRequestId": "<string>",
    "payoutOrderId": "<string>",
    "prefundCurrency": "<string>",
    "prefundAmount": 123,
    "payoutCurrency": "<string>",
    "payoutAmount": "<string>",
    "payeeCurrency": "<string>",
    "payeeAmount": "<string>",
    "country": "<string>",
    "description": "<string>",
    "merchantInfo": {
      "merchantId": 1000000201,
      "subMerchantId": "<string>"
    },
    "payeeInfo": {
      "payeeId": "<string>",
      "payeeType": "<string>",
      "payeeFirstName": "<string>",
      "payeeMiddleName": "<string>",
      "payeeLastName": "<string>",
      "nationality": "<string>",
      "payeeEmail": "<string>",
      "payeePhone": "<string>",
      "payeeBirthDay": "<string>",
      "payeeIDType": "<string>",
      "payeeIDNumber": "<string>",
      "payeeIDIssueDate": "<string>",
      "payeeIDExpiryDate": "<string>",
      "payeeFullName": "<string>"
    },
    "payoutInfo": {
      "productName": "<string>",
      "payoutMethodType": "<string>",
      "payoutMethodUserAccountNo": "<string>",
      "payoutMethodName": "<string>",
      "payoutMethodProperty": "<string>"
    },
    "addressInfo": {
      "address": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postcode": "<string>",
      "addressCountryCode": "<string>"
    },
    "feeCurrency": "<string>",
    "feeAmount": "<string>",
    "feeStatus": "<string>",
    "status": "<string>",
    "subStatus": "<string>",
    "failureCode": "<string>",
    "failureReason": "<string>",
    "notifyUrl": "<string>",
    "extendInfo": "<string>",
    "payoutRequestedAt": "<string>",
    "payoutArrivalTime": "<string>",
    "payoutUpdatedAt": "<string>"
  }
}

Body

application/json
payoutRequestId
string

Payout request id sent from Merchant. It will also be used for idempotent check. You can choose one of the two.

payoutOrderId
string

Waffo's payout Order ID. Choose one of the two,You can choose one of the two. If both are passed, payoutOrderId is used first

Response

200 - */*

OK

response data

code
string
Example:

0

msg
string
Example:

"success"

data
object