Skip to content

List the key's Pairs

GET
/pairs
curl --request GET \
--url https://api.voltpay.space/v1/pairs \
--header 'Authorization: Bearer <token>'

Each of the API Key’s Pairs, with whether a Receive Address exists for it.

Every Pair of this key.

Media typeapplication/json
object
data
required
Array
object
network
required

One blockchain. Test mode uses the test Network codes.

string
Allowed values: tron bsc ethereum arbitrum solana base polygon optimism avalanche tron_nile bsc_testnet ethereum_sepolia arbitrum_sepolia solana_devnet
coin
required

The coin, identified on-chain by its contract and never by this symbol.

string
Allowed values: usdt usdc
has_address
required

Whether an active Receive Address exists for this Pair.

boolean

Example

{
"data": [
{
"network": "tron",
"coin": "usdt"
}
]
}

INVALID_API_KEY: the key is missing, wrong or revoked.

Media typeapplication/json
object
error
required
object
code
required

The stable identifier a client branches on.

string
Allowed values: INVALID_API_KEY BALANCE_EXHAUSTED PAIR_NOT_ALLOWED MERCHANT_SUSPENDED CHECKOUT_LIMIT_EXCEEDED CHECKOUT_NOT_FOUND PAYMENT_NOT_FOUND REFERENCE_ALREADY_USED IDEMPOTENCY_KEY_REUSED REQUEST_IN_PROGRESS CHECKOUT_NOT_OPEN NO_ADDRESS_FOR_PAIR VALIDATION_ERROR RATE_LIMITED INTERNAL PAIR_AT_CAPACITY PAIR_PAUSED TRY_AGAIN
message
required

For people. May be reworded, so never branch on it.

string
request_id
required
string
details

More about the failure. For VALIDATION_ERROR, a map of field name to reason.

object
key
additional properties
any
max_checkout_micro

Only with CHECKOUT_LIMIT_EXCEEDED. The largest Checkout the Merchant may create now, in micro-USD.

integer format: int64

Examples

Exampledefault
{
"error": {
"code": "INVALID_API_KEY",
"message": "The API key is missing, wrong or revoked.",
"request_id": "req_01J9…"
}
}

MERCHANT_SUSPENDED: Staff have suspended the Merchant.

Media typeapplication/json
object
error
required
object
code
required

The stable identifier a client branches on.

string
Allowed values: INVALID_API_KEY BALANCE_EXHAUSTED PAIR_NOT_ALLOWED MERCHANT_SUSPENDED CHECKOUT_LIMIT_EXCEEDED CHECKOUT_NOT_FOUND PAYMENT_NOT_FOUND REFERENCE_ALREADY_USED IDEMPOTENCY_KEY_REUSED REQUEST_IN_PROGRESS CHECKOUT_NOT_OPEN NO_ADDRESS_FOR_PAIR VALIDATION_ERROR RATE_LIMITED INTERNAL PAIR_AT_CAPACITY PAIR_PAUSED TRY_AGAIN
message
required

For people. May be reworded, so never branch on it.

string
request_id
required
string
details

More about the failure. For VALIDATION_ERROR, a map of field name to reason.

object
key
additional properties
any
max_checkout_micro

Only with CHECKOUT_LIMIT_EXCEEDED. The largest Checkout the Merchant may create now, in micro-USD.

integer format: int64

Examples

Exampledefault
{
"error": {
"code": "MERCHANT_SUSPENDED",
"message": "This account is suspended. Contact support.",
"request_id": "req_01J9…"
}
}

RATE_LIMITED: back off, per Retry-After.

Media typeapplication/json
object
error
required
object
code
required

The stable identifier a client branches on.

string
Allowed values: INVALID_API_KEY BALANCE_EXHAUSTED PAIR_NOT_ALLOWED MERCHANT_SUSPENDED CHECKOUT_LIMIT_EXCEEDED CHECKOUT_NOT_FOUND PAYMENT_NOT_FOUND REFERENCE_ALREADY_USED IDEMPOTENCY_KEY_REUSED REQUEST_IN_PROGRESS CHECKOUT_NOT_OPEN NO_ADDRESS_FOR_PAIR VALIDATION_ERROR RATE_LIMITED INTERNAL PAIR_AT_CAPACITY PAIR_PAUSED TRY_AGAIN
message
required

For people. May be reworded, so never branch on it.

string
request_id
required
string
details

More about the failure. For VALIDATION_ERROR, a map of field name to reason.

object
key
additional properties
any
max_checkout_micro

Only with CHECKOUT_LIMIT_EXCEEDED. The largest Checkout the Merchant may create now, in micro-USD.

integer format: int64

Examples

Exampledefault
{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests. Wait for the time in Retry-After, then try again.",
"request_id": "req_01J9…"
}
}
Retry-After
integer
>= 1

Seconds to wait before trying again.

INTERNAL: an unexpected failure. Quote request_id when reporting it.

Media typeapplication/json
object
error
required
object
code
required

The stable identifier a client branches on.

string
Allowed values: INVALID_API_KEY BALANCE_EXHAUSTED PAIR_NOT_ALLOWED MERCHANT_SUSPENDED CHECKOUT_LIMIT_EXCEEDED CHECKOUT_NOT_FOUND PAYMENT_NOT_FOUND REFERENCE_ALREADY_USED IDEMPOTENCY_KEY_REUSED REQUEST_IN_PROGRESS CHECKOUT_NOT_OPEN NO_ADDRESS_FOR_PAIR VALIDATION_ERROR RATE_LIMITED INTERNAL PAIR_AT_CAPACITY PAIR_PAUSED TRY_AGAIN
message
required

For people. May be reworded, so never branch on it.

string
request_id
required
string
details

More about the failure. For VALIDATION_ERROR, a map of field name to reason.

object
key
additional properties
any
max_checkout_micro

Only with CHECKOUT_LIMIT_EXCEEDED. The largest Checkout the Merchant may create now, in micro-USD.

integer format: int64

Examples

Exampledefault
{
"error": {
"code": "INTERNAL",
"message": "Something went wrong on our side. Quote the request id if this continues.",
"request_id": "req_01J9…"
}
}

TRY_AGAIN: a time limit cut the request short and nothing was committed.

Media typeapplication/json
object
error
required
object
code
required

The stable identifier a client branches on.

string
Allowed values: INVALID_API_KEY BALANCE_EXHAUSTED PAIR_NOT_ALLOWED MERCHANT_SUSPENDED CHECKOUT_LIMIT_EXCEEDED CHECKOUT_NOT_FOUND PAYMENT_NOT_FOUND REFERENCE_ALREADY_USED IDEMPOTENCY_KEY_REUSED REQUEST_IN_PROGRESS CHECKOUT_NOT_OPEN NO_ADDRESS_FOR_PAIR VALIDATION_ERROR RATE_LIMITED INTERNAL PAIR_AT_CAPACITY PAIR_PAUSED TRY_AGAIN
message
required

For people. May be reworded, so never branch on it.

string
request_id
required
string
details

More about the failure. For VALIDATION_ERROR, a map of field name to reason.

object
key
additional properties
any
max_checkout_micro

Only with CHECKOUT_LIMIT_EXCEEDED. The largest Checkout the Merchant may create now, in micro-USD.

integer format: int64

Examples

Exampledefault
{
"error": {
"code": "TRY_AGAIN",
"message": "Nothing was committed. Try the request again.",
"request_id": "req_01J9…"
}
}
Retry-After
integer
>= 1

Seconds to wait before trying again.