Sign in

166864b1ec6d

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Subaccounts

Fetches a set of Withdrawals Requests for a subaccount

Permissions required: Subaccount or Read Subaccount

Retrieves a filtered set of Withdrawal Requests within a Subaccount (FIAT only for now).

get/subaccounts/{subaccountId}/fiat/withdrawals

Path parameters

subaccountIdstring required

Unique Identifier for the subaccount

Query parameters

withdrawalStatusesstring[]

One or more withdrawal statuses to filter results. If no value is passed, it filter by all statuses.

startDatestring date

The start date (inclusive) in YYYY-MM-DD format. The earliest valid start date is '2017-01-01`. Dates are always in UTC RFC 3339 'full-date'.

endDatestring date

The end date (inclusive) in YYYY-MM-DD format. The latest valid end date is the current date. Dates are always in UTC RFC 3339 'full-date'.

afterIdstring

When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body)

limitinteger

Maximum number of results to return per query

Response

List the Withdrawal Requests

Example response

{
  "data": [
    {
      "asset": {
        "amount": "1000.0",
        "assetType": "USD"
      },
      "createdAt": "2019-01-02T12:34:56.000Z",
      "customerDetails": {
        "beneficiary": {
          "address": {
            "address": "123 Main Street",
            "city": "Windsor",
            "state": "Iowa",
            "zipcode": "12312"
          }
        },
        "financialInstitution": {
          "address": {
            "address": "123 Main Street",
            "city": "Windsor",
            "state": "Iowa",
            "zipcode": "12312"
          }
        },
        "intermediateFinancialInstitution": {
          "address": {
            "address": "123 Main Street",
            "city": "Windsor",
            "state": "Iowa",
            "zipcode": "12312"
          }
        }
      },
      "endedAt": "2019-01-03T12:34:56.000Z",
      "transactionId": "c4c4652f-0c07-472c-a7f8-955fbe07775d",
      "updatedAt": "2019-01-03T12:34:56.000Z"
    }
  ],
  "page": {
    "next": "<next page url>"
  }
}