List Transfer Limits

List all limits that apply to the given transaction type.

GET /transfer/limits/utilizations

Try it

List Transfer Limits

cURL

curl --request GET \
  --url https://api.paxos.com/v2/transfer/limits/utilizations \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "<string>",
      "rule_id": "<string>",
      "transfer_types": [
        "INTERNAL_TRANSFER_DEBIT"
      ],
      "period_seconds": "<string>",
      "limit": "<string>",
      "remaining": "<string>",
      "limit_asset": "<string>"
    }
  ],
  "next_page_cursor": "<string>"
}

OAuth Scope

transfer:read_transfer_limit

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Query Parameters

transfer_type · enum<string> · required

Type of transfer to fetch limits for.

Available options: INTERNAL_TRANSFER_DEBIT, INTERNAL_TRANSFER_CREDIT, CRYPTO_DEPOSIT, CRYPTO_WITHDRAWAL, WIRE_DEPOSIT, WIRE_WITHDRAWAL, SEN_DEPOSIT, SEN_WITHDRAWAL, BANK_DEPOSIT, BANK_WITHDRAWAL, PAXOS_TRANSFER_DEBIT, PAXOS_TRANSFER_CREDIT, SIGNET_DEPOSIT, SIGNET_WITHDRAWAL, CBIT_WITHDRAWAL, CBIT_DEPOSIT, CUBIX_DEPOSIT, CUBIX_WITHDRAWAL

Response

200 - application/json

A successful response.

items · object[]

Show child attributes

items. id · string

The ID of the limit. Single-transaction limits will not have an id, but only a rule id.

items. rule_id · string

The limit rule this limit applies to.

items. transfer_types · enum<string>[]

One or more transfer types that the limit applies to, ordered alphabetically.

Type of transfer.

Available options: INTERNAL_TRANSFER_DEBIT, INTERNAL_TRANSFER_CREDIT, CRYPTO_DEPOSIT, CRYPTO_WITHDRAWAL, WIRE_DEPOSIT, WIRE_WITHDRAWAL, SEN_DEPOSIT, SEN_WITHDRAWAL, BANK_DEPOSIT, BANK_WITHDRAWAL, PAXOS_TRANSFER_DEBIT, PAXOS_TRANSFER_CREDIT, SIGNET_DEPOSIT, SIGNET_WITHDRAWAL, CBIT_WITHDRAWAL, CBIT_DEPOSIT, CUBIX_DEPOSIT, CUBIX_WITHDRAWAL

items. period_seconds · string

The number of seconds that the limit is measured over. Single-transaction limits have period 0.

items. limit · string

The limit.

items. remaining · string

The limit, minus any transactions that have been done in the period. Single-transaction limits always have remaining set to the limit.

items. limit_asset · string

The asset that limit and remaining are given in, e.g. "USD", "BTC", "ETH".

next_page_cursor · string