Common Field Types

Common field types

Field name or pattern
JSON type
Format / constraints
Example

id

string

24-character lowercase hex string

667d49883f41b399d78a15ac

dateTime

string

ISO 8601 in UTC, millisecond precision optional

2025-06-04T16:08:03Z

moneyAmount

integer

Minor units of the associated currency (cents, satoshi, wei, etc.)

1099

currency

string

ISO 4217 three-letter uppercase code

USD

tenderTypes

array<string>

Values taken from Tender Types list

[ "ethereum", "bitcoin" ]

isEnabled

boolean

true enables the resource for live use

false

address

object

See Address object schema below

pagination.total

integer

Total items in collection

250

pagination.page

integer

0-based page index returned

2

pagination.pageSize

integer

Items per page in response

50

pagination.pageId

string

Opaque cursor for next request

eyJzdGFydElkIjoiNjY3ZC4uLiJ9

Address object schema

Field
Required
Notes

address1

yes

Street line 1

address2

no

Suite, floor, etc.

city

yes

Locality or town

region

no

State, province, or county

postalCode

yes

ZIP or postal code

country

yes

ISO 3166-1 alpha-2 code (e.g. US)

Boolean flags

A small number of resources include binary flags; all use JSON true or false (never "true"/"false" strings).

Flag
Typical meaning

isEnabled

Can accept payments or be used in API calls

displayLogo

Hosted page should render merchant logo

Error object fields

Repeated from the Error Codes page for quick reference:

Field
Type
Description

code

integer

HTTP status mirrored in body

error

string

Machine-readable key

message

string

Human explanation

details

array

Field-level validation issues

Use these definitions when building request bodies, validating responses, or creating JSON schemas for client libraries.

Last updated