Skip to main content

Create a new stablecoin remitter

POST /stablecoins/remitters

Request

Use this endpoint to create a new stablecoin remitter for a given budget.

Query parameters

accountId
string
required
The ID of the account to work with.Allowable values: An existing accountId (≤ 36 characters)

Request body schema

budgetId
string
required
The ID of the budget to work with.Allowable values: A valid UUID (≤ 36 characters)
sourceCurrencyCode
string
required
The currency the remitter will send.Allowable values: A string [ 3 .. 4 ] characters (e.g., USDC)
destinationCurrencyCode
string
required
The currency that should be received into the budget.Allowable values: A string [ 3 .. 4 ] characters (e.g., USD)
details
object
required
Individual or Business details object.
details.type
string
required
Type of remitter.Allowable values: INDIVIDUAL, BUSINESS
details.firstName
string
required
First name (for individuals).
details.lastName
string
required
Last name (for individuals).
details.dateOfBirth
string
required
Date of birth in YYYY-MM-DD format (for individuals).
details.emailAddress
string
required
Email address.
details.nationality
string
required
Nationality as a two-letter country code.
details.residentialAddress
object
required
Residential address object.

Response

If your request is successful, you’ll receive a 201 response.
For more detailed information about this request and its response, see API reference.

List stablecoin remitters

GET /stablecoins/remitters

Request

Use this endpoint to retrieve a paginated list of all stablecoin remitters for a given budget. You can filter results using query parameters.

Query parameters

accountId
string
required
The ID of the account to work with.Allowable values: An existing accountId (≤ 36 characters)
budgetId
string
The ID of the budget to work with.Allowable values: A valid UUID (≤ 36 characters)
sourceCurrencyCode
string
The source currency code to filter by, in ISO 4217 format.Allowable values: A string [ 3 .. 4 ] characters (e.g., USDC)
destinationCurrencyCode
string
The destination currency code to filter by, in ISO 4217 format.Allowable values: A string [ 3 .. 4 ] characters (e.g., USD)
Search term to filter remitters.
limit
integer
required
The maximum number of results to return. For example, limit=200. Defaults to 100 if not provided.Allowable values: [ 1 .. 1000 ]
offset
integer
required
The number of items to skip before returning results. For example, offset=100. Defaults to 0 if not provided.Allowable values: A valid integer

Response

If your request is successful, you’ll receive a 200 response.
For more detailed information about this request and its response, see API reference.

Retrieve a specific stablecoin remitter

GET /stablecoins/remitters/{id}

Request

Use this endpoint to retrieve details of a specific stablecoin remitter.

Path parameters

id
string
required
The unique ID of the remitter.Allowable values: A valid UUID

Query parameters

accountId
string
required
The ID of the account to work with.Allowable values: An existing accountId (≤ 36 characters)

Response

If your request is successful, you’ll receive a 200 response.
For more detailed information about this request and its response, see API reference.