Skip to main content
POST
/
stablecoins
/
remitters
Create a new stablecoin remitter
curl --request POST \
  --url https://api.equalsmoney.com/v2/stablecoins/remitters \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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",
    "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"
}
'
{
  "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",
    "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/channel?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"
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
accountId
string
required

The ID of the account to work with.

Example:

"F50091"

Body

application/json

Body

​
budgetId
string<uuid>
required

The ID of the budget to work with.

Maximum string length: 36
Example:

"775596ae-2624-40af-a9dc-9756110a4a03"

​
sourceCurrencyCode
string
required

The currency the remitter will send.

Required string length: 3 - 4
Example:

"USDC"

​
destinationCurrencyCode
string
required

The currency that should be received into the budget.

Required string length: 3 - 4
Example:

"USD"

​
details
Individual · object
required
​
displayName
string | null
Required string length: 1 - 255
Example:

"John Smith"

​
requesterIpAddress
string

The IP address of the remitter requester.

Example:

"127.0.0.1"

Response

201 - application/json

Created

​
id
string<uuid>
required

The ID of the BVNK remitter to work with.

Example:

"e9293471-5eb3-4dbc-916c-dbaf9e2deefd"

​
accountId
string
required

The ID of the account to work with.

Example:

"F50091"

​
budgetId
string<uuid>
required

The ID of the budget to work with.

Maximum string length: 36
Example:

"775596ae-2624-40af-a9dc-9756110a4a03"

​
status
enum<string>
required
Available options:
OPEN
​
sourceCurrencyCode
string
required

The currency the remitter will send.

Required string length: 3 - 4
Example:

"USDC"

​
destinationCurrencyCode
string
required

The currency that should be received into the budget.

Required string length: 3 - 4
Example:

"USD"

​
details
Individual · object
required
​
createdBy
string
required
Required string length: 1 - 255
Example:

"John Smith"

​
createdAt
string<date-time>
required

The date the Resource was initially created. ISO 8601 format without milliseconds.

​
updatedAt
string<date-time>
required

The date the Resource was last modified. ISO 8601 format without milliseconds.

​
displayName
string | null
Required string length: 1 - 255
Example:

"John Smith"

​
link
object