> ## Documentation Index
> Fetch the complete documentation index at: https://docs.equalsmoney.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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

<Note>
  **POST** `/stablecoins/remitters`
</Note>

### Request

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

<CodeGroup>
  ```bash Sample request theme={null}
  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"
    }'
  ```

  ```bash Request structure theme={null}
  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"
    }'
  ```
</CodeGroup>

#### Query parameters

<ParamField body="accountId" type="string" required>
  The ID of the account to work with.

  Allowable values: An existing `accountId` (≤ 36 characters)
</ParamField>

#### Request body schema

<ParamField body="budgetId" type="string" required>
  The ID of the budget to work with.

  Allowable values: A valid UUID (≤ 36 characters)
</ParamField>

<ParamField body="sourceCurrencyCode" type="string" required>
  The currency the remitter will send.

  Allowable values: A string \[ 3 .. 4 ] characters (e.g., `USDC`)
</ParamField>

<ParamField body="destinationCurrencyCode" type="string" required>
  The currency that should be received into the budget.

  Allowable values: A string \[ 3 .. 4 ] characters (e.g., `USD`)
</ParamField>

<ParamField body="details" type="object" required>
  Individual or Business details object.
</ParamField>

<ParamField body="details.type" type="string" required>
  Type of remitter.

  Allowable values: `INDIVIDUAL`, `BUSINESS`
</ParamField>

<ParamField body="details.firstName" type="string" required>
  First name (for individuals).
</ParamField>

<ParamField body="details.lastName" type="string" required>
  Last name (for individuals).
</ParamField>

<ParamField body="details.dateOfBirth" type="string" required>
  Date of birth in YYYY-MM-DD format (for individuals).
</ParamField>

<ParamField body="details.emailAddress" type="string" required>
  Email address.
</ParamField>

<ParamField body="details.nationality" type="string" required>
  Nationality as a two-letter country code.
</ParamField>

<ParamField body="details.residentialAddress" type="object" required>
  Residential address object.
</ParamField>

### Response

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

<CodeGroup>
  ```json Sample response theme={null}
  {
    "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"
  }
  ```

  ```json Sample response (business) theme={null}
  {
    "id": "b2222222-3333-4444-5555-666666666666",
    "accountId": "F50091",
    "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
    "status": "OPEN",
    "displayName": "Acme Corporation",
    "sourceCurrencyCode": "USDC",
    "destinationCurrencyCode": "USD",
    "details": {
      "type": "BUSINESS",
      "legalName": "Acme Corporation Ltd",
      "registrationNumber": "12345678",
      "emailAddress": "payments@acme-corp.com",
      "registeredAddress": "10 King William Street, London, EC4R 9AT",
      "registeredCountryCode": "GB"
    },
    "link": {
      "url": "https://pay.sandbox.example.com/channel?uuid=8c2e56a1-b536-403a-a8f1-136d47be92c0",
      "chains": [
        {
          "protocol": "ETH",
          "address": "0x0000000000000000000000000000000000000000"
        }
      ]
    },
    "createdBy": "John Smith",
    "createdAt": "2025-01-30T09:00:00Z",
    "updatedAt": "2025-01-30T09:00:00Z"
  }
  ```

  ```json Response structure theme={null}
  {
    "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"
  }
  ```
</CodeGroup>

For more detailed information about this request and its response, [see API reference](/api-reference/remitters/create-a-new-stablecoin-remitter).

## List stablecoin remitters

<Note>
  **GET** `/stablecoins/remitters`
</Note>

### Request

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

<CodeGroup>
  ```bash Sample request theme={null}
  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' \
  ```

  ```bash Request structure theme={null}
  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' \
  ```
</CodeGroup>

#### Query parameters

<ParamField body="accountId" type="string" required>
  The ID of the account to work with.

  Allowable values: An existing `accountId` (≤ 36 characters)
</ParamField>

<ParamField body="budgetId" type="string">
  The ID of the budget to work with.

  Allowable values: A valid UUID (≤ 36 characters)
</ParamField>

<ParamField body="sourceCurrencyCode" type="string">
  The source currency code to filter by, in ISO 4217 format.

  Allowable values: A string \[ 3 .. 4 ] characters (e.g., `USDC`)
</ParamField>

<ParamField body="destinationCurrencyCode" type="string">
  The destination currency code to filter by, in ISO 4217 format.

  Allowable values: A string \[ 3 .. 4 ] characters (e.g., `USD`)
</ParamField>

<ParamField body="search" type="string">
  Search term to filter remitters.
</ParamField>

<ParamField body="limit" type="integer" required>
  The maximum number of results to return. For example, `limit=200`. Defaults to `100` if not provided.

  Allowable values: `[ 1 .. 1000 ]`
</ParamField>

<ParamField body="offset" type="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
</ParamField>

### Response

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

<CodeGroup>
  ```json Sample response theme={null}
  {
    "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"
      }
    ]
  }
  ```

  ```json Response structure theme={null}
  {
    "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"
      }
    ]
  }
  ```
</CodeGroup>

For more detailed information about this request and its response, [see API reference](/api-reference/remitters/list-stablecoin-remitters).

## Retrieve a specific stablecoin remitter

<Note>
  **GET** `/stablecoins/remitters/{id}`
</Note>

### Request

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

<CodeGroup>
  ```bash Sample request theme={null}
  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' \
  ```

  ```bash Request structure theme={null}
  curl -i -X GET \
    'https://api.equalsmoney.com/stablecoins/remitters/{id}?accountId=F50091&include=string' \
    -H 'Authorization: YOUR_API_KEY_HERE' \
  ```
</CodeGroup>

#### Path parameters

<ParamField body="id" type="string" required>
  The unique ID of the remitter.

  Allowable values: A valid UUID
</ParamField>

#### Query parameters

<ParamField body="accountId" type="string" required>
  The ID of the account to work with.

  Allowable values: An existing `accountId` (≤ 36 characters)
</ParamField>

### Response

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

<CodeGroup>
  ```json Sample response theme={null}
  {
    "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"
  }
  ```

  ```json Response structure theme={null}
  {
    "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"
  }
  ```
</CodeGroup>

For more detailed information about this request and its response, [see API reference](/api-reference/remitters/retrieve-a-stablecoin-remitter).