External accounts

External account APIs are used to connect to a third party custodian, typically a trading venue, to instruct trading orders directly from Harmonize. The following calls allow to setup a connection with an external provider, list the external accounts and their balances.

Operações

/v1/domains/{domainId}/external-accounts/providers

Requisição

Connect an external account provider

Segurança

httpAuth

Caminho

domainIdstring, (uuid)obrigatório

Corpoapplication/json

idstring or null, (uuid)

domainIdstring, (uuid)obrigatório

aliasstring, non-emptyobrigatório

parametersobjectobrigatório

curl -i -X POST \
  'https://docs.ripple.com/_mock/pt-br/products/custody/devbox/v1/domains/{domainId}/external-accounts/providers' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "domainId": "8a0b02c3-fdd8-452e-bc6e-ef07a335ec7e",
    "alias": "string",
    "parameters": {
      "apiKey": "string",
      "secret": "string",
      "type": "Kraken"
    }
  }'

Respostas

Success

Corpoapplication/json

idstring, (uuid)read-onlyobrigatório

domainIdstring, (uuid)read-onlyobrigatório

aliasstringread-onlyobrigatório

parametersobjectobrigatório

connectionStatestringobrigatório

Enum:"Connected""Disconnected""ConnectionError""InvalidConnection"

Resposta

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domainId": "8a0b02c3-fdd8-452e-bc6e-ef07a335ec7e",
  "alias": "string",
  "parameters": {
    "apiKey": "string",
    "secret": "string",
    "type": "Kraken"
  },
  "connectionState": "Connected"
}