Skip to content

Commit 45df948

Browse files
authored
Add region and currencies list to grid customers (#320)
1 parent d54bcae commit 45df948

8 files changed

Lines changed: 270 additions & 0 deletions

File tree

mintlify/openapi.yaml

Lines changed: 84 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

openapi.yaml

Lines changed: 84 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

openapi/components/schemas/customers/Customer.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,21 @@ properties:
1515
example: 9f84e0c2a72c4fa
1616
customerType:
1717
$ref: ./CustomerType.yaml
18+
region:
19+
type: string
20+
description: >-
21+
Country code (ISO 3166-1 alpha-2) representing the customer's regional identity
22+
and regulatory jurisdiction.
23+
example: US
24+
currencies:
25+
type: array
26+
items:
27+
type: string
28+
description: >-
29+
List of currency codes enabled for this customer.
30+
example:
31+
- USD
32+
- USDC
1833
umaAddress:
1934
type: string
2035
description: >-

openapi/components/schemas/customers/CustomerCreateRequest.yaml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,29 @@ properties:
99
example: 9f84e0c2a72c4fa
1010
customerType:
1111
$ref: ./CustomerType.yaml
12+
region:
13+
type: string
14+
description: >-
15+
Country code (ISO 3166-1 alpha-2) representing the customer's regional identity.
16+
This determines the regulatory jurisdiction and KYC requirements for the customer.
17+
Required if the customer will use currencies with different KYC requirements across
18+
regions. A customer with accounts in multiple regions should be registered as separate
19+
customers. This field is immutable after creation.
20+
example: US
21+
currencies:
22+
type: array
23+
items:
24+
type: string
25+
description: >-
26+
List of currency codes the customer will use (ISO 4217 for fiat, e.g. "USD", "EUR";
27+
tickers for crypto, e.g. "BTC", "USDC"). Required if the customer will use more than
28+
one sending currency, since the correct currencies cannot always be inferred. If not
29+
provided, currencies will be inferred from the customer's region. Some currency
30+
combinations may require separate customers — if so, the request will be rejected
31+
with details.
32+
example:
33+
- USD
34+
- USDC
1235
umaAddress:
1336
type: string
1437
description: >-

0 commit comments

Comments
 (0)