Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
465 changes: 245 additions & 220 deletions mintlify/openapi.yaml

Large diffs are not rendered by default.

465 changes: 245 additions & 220 deletions openapi.yaml

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions openapi/components/schemas/config/PlatformConfigUpdateRequest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
type: object
properties:
umaDomain:
type: string
example: mycompany.com
webhookEndpoint:
type: string
example: https://api.mycompany.com/webhooks/uma
supportedCurrencies:
type: array
items:
$ref: ./PlatformCurrencyConfig.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
type: object
required:
- jobId
- status
properties:
jobId:
type: string
description: Unique identifier for the bulk import job
example: Job:019542f5-b3e7-1d02-0000-000000000006
status:
type: string
enum:
- PENDING
- PROCESSING
14 changes: 14 additions & 0 deletions openapi/components/schemas/customers/KycLinkResponse.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
type: object
properties:
kycUrl:
type: string
description: A hosted KYC link for your customer to complete KYC
example: "https://example.com/redirect"
platformCustomerId:
type: string
description: The platform id of the customer to onboard
example: 019542f5-b3e7-1d02-0000-000000000001
customerId:
type: string
description: The customer id of the newly created customer on the system
example: Customer:019542f5-b3e7-1d02-0000-000000000001
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
type: object
required:
- inviteeUma
properties:
inviteeUma:
type: string
description: The UMA address of the customer claiming the invitation
example: $invitee@uma.domain
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
type: object
required:
- inviterUma
properties:
inviterUma:
type: string
description: The UMA address of the customer creating the invitation
example: $inviter@uma.domain
firstName:
type: string
description: First name of the invitee to show as part of the invite
example: Alice
amountToSend:
description: >
An amount to send (in the smallest unit of the customer's currency)
to the invitee when the invitation is claimed.

This is optional and if not provided, the invitee will not
receive any amount. Note that the actual sending of

the amount must be done by the inviter platform once the
INVITATION_CLAIMED webhook is received. If the inviter

platform either does not send the payment or the payment fails,
the invitee will not receive this amount. This

field is primarily used for display purposes on the claiming
side of the invitation.
type: integer
format: int64
example: 12550
expiresAt:
type: string
format: date-time
description: When the invitation expires (if at all)
example: '2025-09-01T14:30:00Z'
13 changes: 13 additions & 0 deletions openapi/components/schemas/sandbox/SandboxFundRequest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
type: object
required:
- amount
properties:
amount:
type: integer
format: int64
description: >-
Amount to add in the smallest unit of the account's currency (e.g.,
cents for USD/EUR, satoshis for BTC)
exclusiveMinimum: 0
maximum: 100000000000
example: 100000
21 changes: 21 additions & 0 deletions openapi/components/schemas/sandbox/SandboxSendRequest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
type: object
required:
- quoteId
- currencyCode
properties:
quoteId:
type: string
description: The unique identifier of the quote
example: Quote:019542f5-b3e7-1d02-0000-000000000006
currencyCode:
type: string
description: Currency code for the funds to be sent
example: USD
currencyAmount:
type: integer
format: int64
description: >-
The amount to send in the smallest unit of the currency (eg.
cents). If not provided, the amount will be derived from the quote.
exclusiveMinimum: 0
example: 1000
32 changes: 32 additions & 0 deletions openapi/components/schemas/sandbox/SandboxUmaReceiveRequest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
type: object
required:
- senderUmaAddress
- receivingCurrencyCode
- receivingCurrencyAmount
properties:
senderUmaAddress:
type: string
description: UMA address of the sender from the sandbox
example: $success.usd@sandbox.grid.uma.money
receiverUmaAddress:
type: string
description: UMA address of the receiver (optional if customerId is provided)
example: $receiver@uma.domain
customerId:
type: string
description: >-
System ID of the receiver (optional if receiverUmaAddress is
provided)
example: Customer:019542f5-b3e7-1d02-0000-000000000001
receivingCurrencyCode:
type: string
description: The currency code for the receiving amount
example: USD
receivingCurrencyAmount:
type: integer
format: int64
description: >-
The amount to be received in the smallest unit of the currency
(eg. cents)
exclusiveMinimum: 0
example: 1000
14 changes: 14 additions & 0 deletions openapi/components/schemas/tokens/ApiTokenCreateRequest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
type: object
required:
- name
- permissions
properties:
name:
type: string
description: Name of the token to help identify it
example: Sandbox read-only
permissions:
type: array
description: A list of permissions to grant to the token
items:
$ref: ./Permission.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
type: object
properties:
receiverCustomerInfo:
type: object
additionalProperties: true
description: >-
Information about the recipient, provided by the platform if
requested in the original webhook via
`requestedReceiverCustomerInfoFields`.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
type: object
properties:
reason:
type: string
description: >-
Optional reason for rejecting the payment. This is just for
debugging purposes or can be used for a platform's own purposes.
example: RESTRICTED_JURISDICTION
32 changes: 32 additions & 0 deletions openapi/components/schemas/transfers/TransferInRequest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
type: object
required:
- source
- destination
properties:
source:
type: object
required:
- accountId
properties:
accountId:
type: string
description: Reference to an external account ID
example: ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965
description: Source external account details
destination:
type: object
required:
- accountId
properties:
accountId:
type: string
description: Reference to an internal account ID
example: InternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123
description: Destination internal account details
amount:
type: integer
format: int64
description: >-
Amount in the smallest unit of the currency (e.g., cents for USD/EUR,
satoshis for BTC)
example: 12550
32 changes: 32 additions & 0 deletions openapi/components/schemas/transfers/TransferOutRequest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
type: object
required:
- source
- destination
properties:
source:
type: object
required:
- accountId
properties:
accountId:
type: string
description: Reference to an internal account ID
example: InternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123
description: Source internal account details
destination:
type: object
required:
- accountId
properties:
accountId:
type: string
description: Reference to an external account ID
example: ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965
description: Destination external account details
amount:
type: integer
format: int64
description: >-
Amount in the smallest unit of the currency (e.g., cents for USD/EUR,
satoshis for BTC)
example: 12550
15 changes: 1 addition & 14 deletions openapi/paths/customers/customers_bulk_csv.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -118,20 +118,7 @@ post:
content:
application/json:
schema:
type: object
required:
- jobId
- status
properties:
jobId:
type: string
description: Unique identifier for the bulk import job
example: Job:019542f5-b3e7-1d02-0000-000000000006
status:
type: string
enum:
- PENDING
- PROCESSING
$ref: ../../components/schemas/customers/BulkCustomerImportJobAccepted.yaml
'401':
description: Unauthorized
content:
Expand Down
15 changes: 1 addition & 14 deletions openapi/paths/customers/customers_kyc_link.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,7 @@ get:
content:
application/json:
schema:
type: object
properties:
kycUrl:
type: string
description: A hosted KYC link for your customer to complete KYC
example: "https://example.com/redirect"
platformCustomerId:
type: string
description: The platform id of the customer to onboard
example: 019542f5-b3e7-1d02-0000-000000000001
customerId:
type: string
description: The customer id of the newly created customer on the system
example: Customer:019542f5-b3e7-1d02-0000-000000000001
$ref: ../../components/schemas/customers/KycLinkResponse.yaml
'401':
description: Unauthorized
content:
Expand Down
37 changes: 1 addition & 36 deletions openapi/paths/invitations/invitations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,42 +12,7 @@ post:
content:
application/json:
schema:
type: object
required:
- inviterUma
properties:
inviterUma:
type: string
description: The UMA address of the customer creating the invitation
example: $inviter@uma.domain
firstName:
type: string
description: First name of the invitee to show as part of the invite
example: Alice
amountToSend:
description: >
An amount to send (in the smallest unit of the customer's currency)
to the invitee when the invitation is claimed.

This is optional and if not provided, the invitee will not
receive any amount. Note that the actual sending of

the amount must be done by the inviter platform once the
INVITATION_CLAIMED webhook is received. If the inviter

platform either does not send the payment or the payment fails,
the invitee will not receive this amount. This

field is primarily used for display purposes on the claiming
side of the invitation.
type: integer
format: int64
example: 12550
expiresAt:
type: string
format: date-time
description: When the invitation expires (if at all)
example: '2025-09-01T14:30:00Z'
$ref: ../../components/schemas/invitations/UmaInvitationCreateRequest.yaml
responses:
'201':
description: Invitation created successfully
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,7 @@ post:
content:
application/json:
schema:
type: object
required:
- inviteeUma
properties:
inviteeUma:
type: string
description: The UMA address of the customer claiming the invitation
example: $invitee@uma.domain
$ref: ../../components/schemas/invitations/UmaInvitationClaimRequest.yaml
responses:
'200':
description: Invitation claimed successfully
Expand Down
13 changes: 1 addition & 12 deletions openapi/paths/platform/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,7 @@ patch:
content:
application/json:
schema:
type: object
properties:
umaDomain:
type: string
example: mycompany.com
webhookEndpoint:
type: string
example: https://api.mycompany.com/webhooks/uma
supportedCurrencies:
type: array
items:
$ref: ../../components/schemas/config/PlatformCurrencyConfig.yaml
$ref: ../../components/schemas/config/PlatformConfigUpdateRequest.yaml
example:
umaDomain: mycompany.com
webhookEndpoint: https://api.mycompany.com/webhooks/uma
Expand Down
Loading