# 3. Get payout details by Order ID

**GET** `/payout/withdraw/order/{order_id}`

Base URL: `https://api.triple-a.io/api/v2`

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

## Authorization

- bearer_auth (http, bearer)

## Path parameters

- `order_id` (string, required)
  The merchant system's unique order id

## Responses

### 200

Success

- `order_id` (string)
  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_reference` (string)
  Unique payout reference number
- `type` ("refund" | "withdraw")
  The type of payout:

  1. `refund` - A partial or complete refund of a prior successful payment.

  2. `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:

  1. `local-local` - Funds are drawn from a local currency account and paid out as local currency.

  2. `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_currency` (string)
  The local currency equivalent of the payout. This should be a
  [3-character ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)
  currency code. Please ignore if the payout is in cryptocurrency.
- `local_amount` (number<float>)
  The local currency amount to be paid out. Please ignore if the
  payout is in cryptocurrency.
- `crypto_currency` (string)
  Cryptocurrency that will be paid out. Please ignore if the payout
  is in local currency.
- `crypto_amount` (number<float>)
  Amount of cryptocurrency to be paid out if the payout is in
  cryptocurrency.
- `network_fee_crypto_amount` (number<float>)
  Amount of cryptocurrency representing the network fee. This is denominated in `crypto_currency`.
- `network_fee_fiat_amt` (number<float>)
  The fiat amount representing the network fee. This is denominated in `local_currency`.
- `net_crypto_amount` (number<float>)
  Amount of cryptocurrency after deduction of the `network_fee_crypto_amount`.
- `crypto_address` (string)
  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_rate` (number<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:

  1. `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.

  2. `confirm` - The recipient has confirmed their receiving crypto address and the exchange rate has been fixed.

  3. `done` - The crypto payout has been broadcasted to the blockchain and successfully paid out to the recipient.

  4. `cancel` - The crypto payout has been cancelled.
- `status_date` (string<date-time>)
  Date and time the status was updated
- `merchant_name` (string)
  Name of the merchant
- `remarks` (string)
  Remarks for the payout
- `notify_url` (string<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](https://webhook.site)
- `notify_secret` (string)
  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.

Example:

```json
{
  "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"
}
```

### 401

Not authorized

- `message` (string)
  1. `unauthorized` - refers to no access token is used for authentication.
  2. `Invalid token: access token is invalid` - refers to the invalid or incorrect access token used.

Example:

```json
{
  "message": "unauthorized"
}
```

### 403

No permission to view details of this payout

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

Example:

```json
{
  "message": "no_permission"
}
```

### 404

Payout Details not found

- `message` (string)
  `not_found` - refers to trying to obtain a payout using the incorrect "order_id" or "payout_reference".

Example:

```json
{
  "message": "not_found"
}
```