List all account bank withdrawals

curl --request GET \
  --url https://api-sandbox.circle.com/v1/accounts/withdrawals \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.circle.com/v1/accounts/withdrawals', 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-sandbox.circle.com/v1/accounts/withdrawals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-sandbox.circle.com/v1/accounts/withdrawals"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.circle.com/v1/accounts/withdrawals")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "sourceAccountId": "<string>",
      "source": {
        "type": "account",
        "id": "1000662322",
        "description": "Operating account"
      },
      "destination": {
        "type": "wire",
        "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
        "name": "COMMERZBANK AG ****3000"
      },
      "transferType": "wire",
      "amount": {
        "amount": "3.14",
        "currency": "USD"
      },
      "toAmount": {
        "currency": "USD",
        "amount": "3.14"
      },
      "fees": {
        "amount": "3.14",
        "currency": "USD"
      },
      "status": "pending",
      "trackingRef": "<string>",
      "errorCode": "insufficient_funds",
      "externalRef": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "riskEvaluation": {
        "decision": "denied",
        "reason": "3000"
      },
      "adjustments": {
        "fxCredit": {
          "amount": "3.14",
          "currency": "USD"
        },
        "fxDebit": {
          "amount": "3.14",
          "currency": "USD"
        }
      },
      "return": {
        "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
        "payoutId": "abdb500d-4a59-457c-801f-2d418c8703ac",
        "amount": {
          "amount": "3.14",
          "currency": "USD"
        },
        "fees": {
          "amount": "3.14",
          "currency": "USD"
        },
        "reason": "payout_returned",
        "status": "pending",
        "createDate": "2020-04-10T02:13:30.000Z",
        "updateDate": "2020-04-10T02:13:30.000Z"
      },
      "description": "<string>",
      "customerExternalRef": "<string>",
      "burnAll": true,
      "subAccountSweeps": [
        {
          "subAccountId": "<string>",
          "amount": {
            "amount": "3.14",
            "currency": "USD"
          },
          "status": "pending"
        }
      ],
      "createDate": "2020-04-10T02:13:30.000Z",
      "updateDate": "2020-04-10T02:13:30.000Z"
    }
  ]
}

{
  "code": 2,
  "message": "API parameter invalid."
}

{
  "code": 4,
  "message": "Unauthorized."
}

{
  "code": -1,
  "message": "Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"
}

GET

accounts

withdrawals

List all account bank withdrawals

curl --request GET \
  --url https://api-sandbox.circle.com/v1/accounts/withdrawals \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.circle.com/v1/accounts/withdrawals', 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-sandbox.circle.com/v1/accounts/withdrawals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-sandbox.circle.com/v1/accounts/withdrawals"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.circle.com/v1/accounts/withdrawals")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "sourceAccountId": "<string>",
      "source": {
        "type": "account",
        "id": "1000662322",
        "description": "Operating account"
      },
      "destination": {
        "type": "wire",
        "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
        "name": "COMMERZBANK AG ****3000"
      },
      "transferType": "wire",
      "amount": {
        "amount": "3.14",
        "currency": "USD"
      },
      "toAmount": {
        "currency": "USD",
        "amount": "3.14"
      },
      "fees": {
        "amount": "3.14",
        "currency": "USD"
      },
      "status": "pending",
      "trackingRef": "<string>",
      "errorCode": "insufficient_funds",
      "externalRef": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "riskEvaluation": {
        "decision": "denied",
        "reason": "3000"
      },
      "adjustments": {
        "fxCredit": {
          "amount": "3.14",
          "currency": "USD"
        },
        "fxDebit": {
          "amount": "3.14",
          "currency": "USD"
        }
      },
      "return": {
        "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
        "payoutId": "abdb500d-4a59-457c-801f-2d418c8703ac",
        "amount": {
          "amount": "3.14",
          "currency": "USD"
        },
        "fees": {
          "amount": "3.14",
          "currency": "USD"
        },
        "reason": "payout_returned",
        "status": "pending",
        "createDate": "2020-04-10T02:13:30.000Z",
        "updateDate": "2020-04-10T02:13:30.000Z"
      },
      "description": "<string>",
      "customerExternalRef": "<string>",
      "burnAll": true,
      "subAccountSweeps": [
        {
          "subAccountId": "<string>",
          "amount": {
            "amount": "3.14",
            "currency": "USD"
          },
          "status": "pending"
        }
      ],
      "createDate": "2020-04-10T02:13:30.000Z",
      "updateDate": "2020-04-10T02:13:30.000Z"
    }
  ]
}

{
  "code": 2,
  "message": "API parameter invalid."
}

{
  "code": 4,
  "message": "Unauthorized."
}

{
  "code": -1,
  "message": "Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

accountId

string

Identifier of the account. Filters results to fetch only resources associated with the specified account.

Example:

"1000565227"

status

enum<string>[]

Queries items with the specified status. Matches any status if unspecified.

Status of the payout. Status pending indicates that the payout is in process; complete indicates it finished successfully; failed indicates it failed.

Available options:

pending,

complete,

failed

from

string

Queries items created since the specified date-time (inclusive) in ISO 8601 format. ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

string

Queries items created before the specified date-time (inclusive) in ISO 8601 format. ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

pageBefore

string

A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

Example:

"def9520a-5280-4089-9b02-3c9ef8fc8514"

pageAfter

string

A collection ID value used for pagination. It marks the exclusive beginning of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

Example:

"bce1e961-bdb8-4983-a9c2-0b3fbc2614cf"

pageSize

integer

default:50

Limits the number of items to be returned. Must be between 1 and 200. A value above 200 returns a 400 error; it is not clamped. If omitted, defaults to 50.

Required range: 1 <= x <= 200

Example:

5

Response

Successfully retrieved a list of withdrawals.

data

object[]

Show child attributes

Accounts

First-party bank operations

First-party crypto operations

Third-party crypto operations

Cross-currency API

Notifications

Security

List all account bank withdrawals

Authorizations

Query Parameters

Response