3. Get payout details by Order ID

GET/payout/withdraw/order/{order_id}

Get the details of the payout (including current status etc) using your own order ID you provided in the initial request.

Path Parameters

order_idstringrequired

The merchant system’s unique order id

Response

Success

order_idstring

Your system unique order id. You will get this in the notification webhook data, if you insert your unique order_id in the request body during the payout creation.

payout_referencestring

Unique payout reference number

type"refund" | "withdraw"

The type of payout:

refund - A partial or complete refund of a prior successful payment.
withdraw - A withdrawal of the merchant’s accumulated USD balance in cryptocurrency.

account_type"local"

Account type the funds are drawn from: local - Funds are drawn from a local currency account

convert_type"local-local" | "local-crypto"

Type of conversion the funds underwent:

local-local - Funds are drawn from a local currency account and paid out as local currency.
local-crypto - Funds are drawn from a local currency account and paid out as cryptocurrency.

payout_destination_type"onchain-wallet" | "binance"

This indicates the type of wallet the payout goes to, either a Binance wallet or other onchain-wallet.

local_currencystring

The local currency equivalent of the payout. This should be a 3-character ISO 4217 currency code. Please ignore if the payout is in cryptocurrency.

local_amountnumber<float>

The local currency amount to be paid out. Please ignore if the payout is in cryptocurrency.

crypto_currencystring

Cryptocurrency that will be paid out. Please ignore if the payout is in local currency.

crypto_amountnumber<float>

Amount of cryptocurrency to be paid out if the payout is in cryptocurrency.

network_fee_crypto_amountnumber<float>

Amount of cryptocurrency representing the network fee. This is denominated in crypto_currency.

network_fee_fiat_amtnumber<float>

The fiat amount representing the network fee. This is denominated in local_currency.

net_crypto_amountnumber<float>

Amount of cryptocurrency after deduction of the network_fee_crypto_amount.

crypto_addressstring

Address that recipient will receive the payout at. This could either be a unique wallet address hash or Binance ID, depending on the field - payout_destination_type.

exchange_ratenumber<float>

The exchange rate that will be used to exchange local currency to cryptocurrency or vice-versa.

status"new" | "confirm" | "done" | "cancel"

The current status of the payout:

new - The payout has just been created, but the recipient has not entered in their receiving crypto address and the exchange rate has not been fixed.
confirm - The recipient has confirmed their receiving crypto address and the exchange rate has been fixed.
done - The crypto payout has been broadcasted to the blockchain and successfully paid out to the recipient.
cancel - The crypto payout has been cancelled.

status_datestring<date-time>

Date and time the status was updated

merchant_namestring

Name of the merchant

remarksstring

Remarks for the payout

notify_urlstring<uri>

The URL to send the webhook notification. The webhook URL given in your account setup will be used if this is not provided. For testing you can use webhook.site

notify_secretstring

The shared secret that will be used to sign the notification. This secret can be at most 64 characters long. If this is not provided in the payment request, the system will create a random secret just for that payment.

Not authorized

messagestring

unauthorized - refers to no access token is used for authentication.
Invalid token: access token is invalid - refers to the invalid or incorrect access token used.

No permission to view details of this payout

messagestring

no_permission - refers to when trying to confirm, cancel or refresh the payout that has been confirmed or cancelled. Or access token has expired.

Payout Details not found

messagestring

not_found - refers to trying to obtain a payout using the incorrect “order_id” or “payout_reference”.

const response = await fetch(`https://api.triple-a.io/api/v2/payout/withdraw/order/${order_id}`, { method: 'GET', headers: { 'Authorization': 'Bearer <token>' } }); const data = await response.json();

import requests response = requests.request( "GET", "https://api.triple-a.io/api/v2/payout/withdraw/order/{order_id}", headers={ "Authorization": "Bearer <token>" }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://api.triple-a.io/api/v2/payout/withdraw/order/<order_id>"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <token>"]); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("GET", "https://api.triple-a.io/api/v2/payout/withdraw/order/<order_id>", nil) req.Header.Set("Authorization", "Bearer <token>") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.triple-a.io/api/v2/payout/withdraw/order/<order_id>")) .header("Authorization", "Bearer <token>") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://api.triple-a.io/api/v2/payout/withdraw/order/<order_id>") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer <token>" response = http.request(request) puts response.body

{ "order_id": "<your_order_id>", "payout_reference": "AGJ-937870-PYT", "type": "withdraw", "account_type": "local", "convert_type": "local-crypto", "payout_destination_type": "onchain-wallet", "local_currency": "SGD", "local_amount": 10, "crypto_currency": "testBTC", "crypto_amount": 0.001067203, "network_fee_crypto_amount": 0.000007203, "network_fee_fiat_amt": 0.123, "net_crypto_amount": 0.00106, "crypto_address": "1NcAyv8YVCnQGCrDb4kiUm1jj6GLyowxER", "exchange_rate": 10277.49, "status": "new", "status_date": "2020-01-26T03:57:22Z", "merchant_name": "A to Z Toys and Games", "remarks": "Refund for a water pistol", "notify_url": "https://webhook.site/1a2d24e8-1594-4569-bc35-079049e4d805", "notify_secret": "Cf9mx4nAvRuy5vwBY2FCtaKr" }