Manage stablecoin remitters

Create, view, and manage stablecoin remitters associated with a budget. Remitters are individuals or businesses that send stablecoin payments.

Create a new stablecoin remitter

Post/stablecoins/remitters

Request

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

Sample requestRequest structure

Copy

Copied

curl -i -X POST \
  'https://api.equalsmoney.com/stablecoins/remitters?accountId=F50091' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
    "displayName": "John Smith",
    "sourceCurrencyCode": "USDC",
    "destinationCurrencyCode": "USD",
    "details": {
      "type": "INDIVIDUAL",
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1946-01-19",
      "emailAddress": "[test@equalsmoney.com](mailto:test@equalsmoney.com)",
      "nationality": "AD",
      "residentialAddress": {
        "streetName": "Upper Thames Street",
        "buildingNumber": "68",
        "buildingName": "Vintners Place",
        "postcode": "EC4V 3BJ",
        "city": "London",
        "region": "Greater London",
        "countryCode": "GB"
      }
    },
    "requesterIpAddress": "127.0.0.1"
  }'

Copy

Copied

curl -i -X POST \
  'https://api.equalsmoney.com/stablecoins/remitters?accountId=F50091' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "budgetId": "string",
    "displayName": "string",
    "sourceCurrencyCode": "string",
    "destinationCurrencyCode": "string",
    "details": {
      "type": "string",
      "firstName": "string",
      "lastName": "string",
      "dateOfBirth": "string",
      "emailAddress": "string",
      "nationality": "string",
      "residentialAddress": {
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "postcode": "string",
        "city": "string",
        "region": "string",
        "countryCode": "string"
      }
    },
    "requesterIpAddress": "string"
  }'

Query parameters

Parameter	Description
`accountId` string required	The ID of the account to work with. Allowable values: An existing `accountId` (<= 36 characters)

Request body schema

Parameter	Description
`budgetId` string required	The ID of the budget to work with. Allowable values: A valid UUID (<= 36 characters)
`displayName` string optional	Display name for the remitter. Allowable values: A string [ 1 .. 255 ] 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.
`requesterIpAddress` string optional	The IP address of the remitter requester.

Response

If your request is successful, you'll receive a 201 response.

Sample responseResponse structure

Copy

Copied

{
  "id": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
  "accountId": "F50091",
  "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
  "status": "OPEN",
  "displayName": "John Smith",
  "sourceCurrencyCode": "USDC",
  "destinationCurrencyCode": "USD",
  "details": {
    "type": "INDIVIDUAL",
    "firstName": "John",
    "lastName": "Smith",
    "dateOfBirth": "1946-01-19",
    "emailAddress": "[test@equalsmoney.com](mailto:test@equalsmoney.com)",
    "nationality": "AD",
    "residentialAddress": {
      "streetName": "Upper Thames Street",
      "buildingNumber": "68",
      "buildingName": "Vintners Place",
      "postcode": "EC4V 3BJ",
      "city": "London",
      "region": "Greater London",
      "countryCode": "GB"
    }
  },
  "link": {
    "url": "https://pay.sandbox.bvnk.com/channl?uuid=9d1f67f2-a647-404b-9b02-247c77be81d0",
    "chains": [
      {
        "protocol": "ETH",
        "address": "0x0000000000000000000000000000000000000000"
      }
    ]
  },
  "createdBy": "John Smith",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Copy

Copied

{
  "id": "string",
  "accountId": "string",
  "budgetId": "string",
  "status": "string",
  "displayName": "string",
  "sourceCurrencyCode": "string",
  "destinationCurrencyCode": "string",
  "details": {
    "type": "string",
    "firstName": "string",
    "lastName": "string",
    "dateOfBirth": "string",
    "emailAddress": "string",
    "nationality": "string",
    "residentialAddress": {
      "streetName": "string",
      "buildingNumber": "string",
      "buildingName": "string",
      "postcode": "string",
      "city": "string",
      "region": "string",
      "countryCode": "string"
    }
  },
  "link": {
    "url": "string",
    "chains": [
      {
        "protocol": "string",
        "address": "string"
      }
    ]
  },
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

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.

Sample requestRequest structure

Copy

Copied

curl -i -X GET \
    'https://api.equalsmoney.com/stablecoins/remitters?accountId=F50091&budgetId=775596ae-2624-40af-a9dc-9756110a4a03&sourceCurrencyCode=USDC&destinationCurrencyCode=USD&search=John&limit=200&offset=100' \
    -H 'Authorization: YOUR_API_KEY_HERE' \

Copy

Copied

curl -i -X GET \
    'https://api.equalsmoney.com/stablecoins/remitters?accountId=F50091&budgetId=string&sourceCurrencyCode=string&destinationCurrencyCode=string&search=string&limit=200&offset=100' \
    -H 'Authorization: YOUR_API_KEY_HERE' \

Query parameters

Parameter	Description
`accountId` string required	The ID of the account to work with. Allowable values: An existing `accountId` (<= 36 characters)
`budgetId` string optional	The ID of the budget to work with. Allowable values: A valid UUID (<= 36 characters)
`sourceCurrencyCode` string optional	Filter by source currency code. Allowable values: A string [ 3 .. 4 ] characters
`destinationCurrencyCode` string optional	Filter by destination currency code. Allowable values: A string [ 3 .. 4 ] characters
`search` string optional	The term to search the records for. Allowable values: A string (<= 100 characters)
`limit` integer optional	The maximum number of results to return. For example, `limit=200`. By default, this is set to `100`. Allowable values: `[ 1 .. 1000 ]`
`offset` integer optional	The number of items to skip before returning results. For example, `offset=100`. By default, this is set to `0`. Allowable values: A valid integer

Response

If your request is successful, you'll receive a 200 response.

Sample responseResponse structure

Copy

Copied

{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
      "accountId": "F50091",
      "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
      "status": "OPEN",
      "displayName": "John Smith",
      "sourceCurrencyCode": "USDC",
      "destinationCurrencyCode": "USD",
      "details": {
        "type": "INDIVIDUAL",
        "firstName": "John",
        "lastName": "Smith",
        "dateOfBirth": "1946-01-19",
        "emailAddress": "[test@equalsmoney.com](mailto:test@equalsmoney.com)",
        "nationality": "AD",
        "residentialAddress": {
          "streetName": "Upper Thames Street",
          "buildingNumber": "68",
          "buildingName": "Vintners Place",
          "postcode": "EC4V 3BJ",
          "city": "London",
          "region": "Greater London",
          "countryCode": "GB"
        }
      },
      "createdBy": "John Smith",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

Copy

Copied

{
  "limit": number,
  "offset": number,
  "count": number,
  "rows": [
    {
      "id": "string",
      "accountId": "string",
      "budgetId": "string",
      "status": "string",
      "displayName": "string",
      "sourceCurrencyCode": "string",
      "destinationCurrencyCode": "string",
      "details": {
        "type": "string",
        "firstName": "string",
        "lastName": "string",
        "dateOfBirth": "string",
        "emailAddress": "string",
        "nationality": "string",
        "residentialAddress": {
          "streetName": "string",
          "buildingNumber": "string",
          "buildingName": "string",
          "postcode": "string",
          "city": "string",
          "region": "string",
          "countryCode": "string"
        }
      },
      "createdBy": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

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.

Sample requestRequest structure

Copy

Copied

curl -i -X GET \
  'https://api.equalsmoney.com/stablecoins/remitters/e9293471-5eb3-4dbc-916c-dbaf9e2deefd?accountId=F50091&include=link' \
  -H 'Authorization: YOUR_API_KEY_HERE' \

Copy

Copied

curl -i -X GET \
  'https://api.equalsmoney.com/stablecoins/remitters/{id}?accountId=F50091&include=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \

Path parameters

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

Query parameters

Parameter	Description
`accountId` string required	The ID of the account to work with. Allowable values: An existing `accountId` (<= 36 characters)
`include` string optional	Controls which optional properties should be attached to the response. Allowable values: `link`

Response

If your request is successful, you'll receive a 200 response.

Sample responseResponse structure

Copy

Copied

{
  "id": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
  "accountId": "F50091",
  "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
  "status": "OPEN",
  "displayName": "John Smith",
  "sourceCurrencyCode": "USDC",
  "destinationCurrencyCode": "USD",
  "details": {
    "type": "INDIVIDUAL",
    "firstName": "John",
    "lastName": "Smith",
    "dateOfBirth": "1946-01-19",
    "emailAddress": "[test@equalsmoney.com](mailto:test@equalsmoney.com)",
    "nationality": "AD",
    "residentialAddress": {
      "streetName": "Upper Thames Street",
      "buildingNumber": "68",
      "buildingName": "Vintners Place",
      "postcode": "EC4V 3BJ",
      "city": "London",
      "region": "Greater London",
      "countryCode": "GB"
    }
  },
  "link": {
    "url": "https://pay.sandbox.bvnk.com/channl?uuid=9d1f67f2-a647-404b-9b02-247c77be81d0",
    "chains": [
      {
        "protocol": "ETH",
        "address": "0x0000000000000000000000000000000000000000"
      }
    ]
  },
  "createdBy": "John Smith",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Copy

Copied

{
  "id": "string",
  "accountId": "string",
  "budgetId": "string",
  "status": "string",
  "displayName": "string",
  "sourceCurrencyCode": "string",
  "destinationCurrencyCode": "string",
  "details": {
    "type": "string",
    "firstName": "string",
    "lastName": "string",
    "dateOfBirth": "string",
    "emailAddress": "string",
    "nationality": "string",
    "residentialAddress": {
      "streetName": "string",
      "buildingNumber": "string",
      "buildingName": "string",
      "postcode": "string",
      "city": "string",
      "region": "string",
      "countryCode": "string"
    }
  },
  "link": {
    "url": "string",
    "chains": [
      {
        "protocol": "string",
        "address": "string"
      }
    ]
  },
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

For more detailed information about this request and its response, see API reference.