API Docs
API referenceCountries

List countries

GET/api/v2/countries

Every country a counterparty can live in, with the tax data it needs. Ordered by id. Never paged. Needs counterparties:read or counterparties:write.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/countries"
{  "object": "list",  "data": [    {      "object": "country",      "id": "DE",      "name": "string",      "taxRequirements": {        "individual": {          "fields": [            {              "key": "taxId",              "label": "string",              "pattern": "string",              "example": "string"            }          ],          "anyOf": [            [              "string"            ]          ]        },        "organization": {          "fields": [            {              "key": "taxId",              "label": "string",              "pattern": "string",              "example": "string"            }          ],          "anyOf": [            [              "string"            ]          ]        }      }    }  ]}

Delete a counterparty DELETE

Refused while a payout to it is `created`, `approved`, `requested`, or `failed`. A deleted counterparty is gone from the API: every endpoint answers 404 `COUNTERPARTY_NOT_FOUND` for it, and its `customId` is free again. Payouts to it keep its id in `recipient.counterpartyId`. Needs `counterparties:write`.

List payment method types GET

Every payment method type a counterparty can save, with the currencies or assets it settles in right now. Currencies and assets may be added or removed without a new API version, so build your form from this list. Never paged. Needs `counterparties:read` or `counterparties:write`.