Bitpanda Whitelabel API Documentation (2.30.0)

Download OpenAPI specification:Download

Authentication

We use authentication based on the OAuth 2.0 standard.

As a Partner, you will receive client_id and client_secret from Bitpanda. To make the exchange secure, we will ask you to share a public GPG/PGP key with Bitpanda, as well as an email address for future technical communication. Bitpanda will send back your client_id and client_secret, which is encrypted with the key, shared in the previous step.

With the provided client_id and client_secret you can issue one or more initial Refresh tokens.

Refresh tokens can not be used to call the endpoints. They can be used only for requesting a short-lived Access Token and a new Refresh Token.

For the API authorization you will need an active Access Token, which can be issued by using a valid Refresh token.

Each White Label API request must contain an authorization header (in the format below) to make a call: Authorization: Bearer [YourAccessTokenHere].

Access tokens have a limited lifetime (currently set to 10 minutes). If your application needs access to a Whitelabel API beyond the lifetime of a single access token, it can obtain a new Access token by using a valid Refresh token.

To get a new Access Token you will need a valid Refresh token. When a new Access Token is claimed, it will be provided along with a new Refresh Token. When you receive the new set consisting of access - refresh token:

the Refresh token, which you used in the request, will be invalidated.
The “old” Access token will not be invalidated when you receive the new one. It will become inactive only after its TTL lapses. In this way you can have a smooth transition between the old and the new access token, when doing API requests

Refresh tokens also have a relatively short lifespan, currently set to 24h.

A refresh token will become invalid either

24h after its issuing
when an access token is renewed by using an active refresh token
In case you initiate refresh token revocation

OAuth 2.0

Obtain a Refresh and Access Tokens

This endpoint supports two key operations:

Obtain an initial Refresh Token by passing grant_type: "client_credentials" together with your client_id and client_secret. The response will contain the initial Refresh Token and an Access Token.
Renew Access Token by passing grant_type: refresh_token using a valid Refresh Token next to your client_id. The Refresh token, used in the request, will be invalidated.

Request

Request Body schema: application/json

Request Access Token

grant_type required	string Enum: "client_credentials" "refresh_token"
client_id required	string
client_secret	string required if the grant_type is `client_credentials`
refresh_token	string required if the grant_type is `refresh_token`. Pass a valid Refresh token.

Responses

200

Success Response

Response Schema: application/json

expires_in	integer TTL of the Access token, determining how many seconds the token will be valid.
access_token	string Used when making API requests. Each request must contain an authorization header in the following format: `Authorization: Bearer [YourAccessTokenHere]`.
refresh_token	string The Refresh token, which you can use the next time you do a request for issuing a new Access token. Bear in mind that the Refresh token, used in the request, will be invalidated as soon as you receive the new one.

413

Error

Response Schema: application/json

Array of objects

422

Error

Response Schema: application/json

Array of objects

429

Too Many Requests

Response Schema: application/json

Array of objects

500

Error

Response Schema: application/json

Array of objects

post/v1/oauth/token

Request samples

application/json

{"grant_type": "client_credentials",
"client_id": "partner",
"client_secret": "secret12345",
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6Imx5ZGlhIiwiZXhwIjoxNjY0MDIzMzkyLCJuYmYiOjE2NjM5MzY5OTIsImlhdCI6MTY2MzkzNjk5MiwianRpIjoiY2UxZmFjMDEtNDhjZC00NWE4LWI3YjQtYTA2NDQxZTUwZWE4In0.ZYafj15LT5hrFXzWjtzZci1yvL9INKyv85FeGxUaRfE"
}

Response samples

200
413
422
429
500

application/json

{"expires_in": 600,
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6Imx5ZGlhIiwiZXhwIjoxNjYzOTM3NTkyLCJuYmYiOjE2NjM5MzY5OTIsImlhdCI6MTY2MzkzNjk5MiwianRpIjoiMTc2NzM0Y2ItYjVmOC00OGFkLTlhMDMtYzRkYjYxZjQwM2I1In0.e-exoz0u-xyE7wN8I3vQwnXSP98Jekh3-7Fo_UrzDKqw9bfZ38kbLndsZXbXpdgqT1eziOg_TVx27St8f3EeBKUg_vCPfJrlPFMXJCVjWwEXg2E1a1cQJWbgdY4PudBF68R4bUUTHpstjD6zufxj5rRERG-6iDhc-xNuBw-IdFaYeJO8-upWJEtt-p23FlpiH4RkflXoxqpP-oWc22aGyAJdMWWY_IIOPCFn3w4f7LhBhh8AWpAbwnTl1ZgFCH1kq3QncBvbRHuqN7UYPlpon_ygBpae6xhYbsBtmfDNnZacZ7-HABLwe3rTJlGw5ltAl_OeB3sq_wAmrJuF4L56OA",
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6Imx5ZGlhIiwiZXhwIjoxNjY0MDIzMzkyLCJuYmYiOjE2NjM5MzY5OTIsImlhdCI6MTY2MzkzNjk5MiwianRpIjoiY2UxZmFjMDEtNDhjZC00NWE4LWI3YjQtYTA2NDQxZTUwZWE4In0.ZYafj15LT5hrFXzWjtzZci1yvL9INKyv85FeGxUaRfE"
}

Revoke a Refresh Token

Use this endpoint to revoke a Refresh Token if you suspect it has been compromised, effectively preventing its further use for authentication.

Request

Request Body schema: application/json

Revoke Refresh Token

client_id required	string
client_secret required	string
refresh_token required	string The refresh token which you want to invalidate

Responses

200

Success Response

422

Error

Response Schema: application/json

Array of objects

429

Too Many Requests

Response Schema: application/json

Array of objects

500

Error

Response Schema: application/json

Array of objects

post/v1/oauth/revoke

Request samples

application/json

{"client_id": "partner",
"client_secret": "secret12345",
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6Imx5ZGlhIiwiZXhwIjoxNjY0MDIzMzkyLCJuYmYiOjE2NjM5MzY5OTIsImlhdCI6MTY2MzkzNjk5MiwianRpIjoiY2UxZmFjMDEtNDhjZC00NWE4LWI3YjQtYTA2NDQxZTUwZWE4In0.ZYafj15LT5hrFXzWjtzZci1yvL9INKyv85FeGxUaRfE"
}

Response samples

422
429
500

application/json

{"errors": [{"code": "the.client_id.field.is.required.",
"title": "The client_id field is required."
},
{"code": "the.client_secret.field.is.required.",
"title": "The client_secret field is required."
},
{"code": "the.refresh_token.field.is.required.",
"title": "The refresh_token field is required."
},
{"code": "http.bad.request",
"title": "Bad JSON received."
},
{"code": "refresh.token.unknown",
"title": "Refresh token is unknown"
},
{"code": "refresh.token.invalid",
"title": "Refresh token is invalid"
},
{"code": "credentials.invalid",
"title": "client_id is unknown, wrong or there is a client_id/client_secret mismatch"
},
{"code": "header.content.type",
"title": "Unsupported content type"
}
]
}

Users

Get Terms & Conditions

The endpoint returns a list of Bitpanda Terms which the user needs to accept in order to create an account. The terms, which shall be accepted may differ based on the user’s country of residence.

You can pass the parameter Accept-Language with a string containing ISO 639-1 language code to get the list of Terms translated into the chosen language. Currently, Bitpanda supports translations for German, Polish, French, Spanish, Italian, and Turkish. The default language is English (en). If you pass the parameter for a language that does not have an existing translation in our database, the response returns the Terms in English.

SecuritybearerAuth

Request

query Parameters

country	string Alpha-2 ISO 3166 country code. Represents user's country of residence. Example: country=AT
account_type	string Account type Enum: "user" "business_user" Example: account_type=user
user_journey	string (UserJourney) Filters results for a specific user journey. If not provided, all terms are included in the response. Enum: "onboarding" "trading_stocks_buy" "trading_stocks_sell" "trading_etf_buy" "trading_etf_sell" "trading_metals_buy" "trading_metals_sell" "change_of_circumstances_dac8" "appropriateness_consent" "appropriateness_warning"
page_size	integer Number of elements to be displayed on a page Example: page_size=10
page	integer Display page number Example: page=1

header Parameters

Accept-Language

string

ISO 639-1 2-letter code representing user's language

Example: en

Responses

200

An array of policies

Response Schema: application/json

	Array of objects (Term)
	object (PaginationMeta)
	object (PaginationLinks)

get/v1/terms

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"id": 1,
"title": "User Agreement BTS EN",
"type": "securities_policy",
"version": "3.0.2",
"mandatory": true,
"effective_at": "2024-12-20T08:14:20+00:00",
"source": "https://www.bitpanda.com/en/legal#privacy"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Get Terms & Conditions v2

The endpoint returns a list of Bitpanda Terms which the user needs to accept in order to create an account. The terms, which shall be accepted may differ based on the user’s country of residence.

You can pass the parameter Accept-Language with a string containing ISO 639-1 language code to get the list of Terms translated into the chosen language. Currently, Bitpanda supports translations for German, Polish, French, Spanish, Italian, and Turkish. The default language is English (en). If you pass the parameter for a language that does not have an existing translation in our database, the response returns the Terms in English.

SecuritybearerAuth

Request

query Parameters

country required	string Alpha-2 ISO 3166 country code. Represents user's country of residence. Example: country=AT
account_type required	string Account type Enum: "user" "business_user" Example: account_type=user
user_journey[]	Array of strings (UserJourney) Filters results for one or more specific user journeys. If not provided, all terms are included in the response. Items Enum: "onboarding" "trading_stocks_buy" "trading_stocks_sell" "trading_etf_buy" "trading_etf_sell" "trading_metals_buy" "trading_metals_sell" "change_of_circumstances_dac8" "appropriateness_consent" "appropriateness_warning"

header Parameters

Accept-Language

string

ISO 639-1 2-letter code representing user's language

Example: en

Response samples

application/json

{"data": [{"id": 1,
"content_type": "link",
"title": "User Agreement BTS EN",
"type": "GENERAL_TERMS",
"version": "3.0.2",
"mandatory": true,
"effective_at": "2025-08-21T08:14:20+00:00",
"url": "https://cdn.bitpanda.com/terms-and-conditions/general-terms-en-3.0.2.pdf"
}
]
}

Get AML questions

The endpoint returns the list of all possible AML questions and answers that the user needs to select during the onboarding process before starting investing.

You can pass the parameter Accept-Language with a string containing ISO 639-1 language code to get the list of AML questions and answers translated into the chosen language. Currently, Bitpanda supports translations for German, Polish, French, Spanish, Italian, and Turkish. The default language is English (en). If you pass the parameter for a language that does not have an existing translation in our database, the response returns the AML questions and answers in English.

SecuritybearerAuth

Request

query Parameters

page_size	integer Number of elements to be displayed on a page Example: page_size=10
page	integer Display page number Example: page=1
account_type	string Default: "user" Account type Enum: "user" "business_user" Example: account_type=business_user

header Parameters

Accept-Language

string

ISO 639-1 language used for translation

Example: en

Responses

200

Success Response

Response Schema: application/json

	Array of objects (AmlQuestion)
	object (PaginationMeta)
	object (PaginationLinks)

application/json

{"data": [{"id": 1,
"question": "What is the origin of funds you intend to invest?",
"translation_key": "aml.question.one",
"description": "Question 1 out of 6",
"description_translation_key": "aml.question.one.description",
"step": 1,
"type": "single_choice",
"answers": [{"id": 1,
"answer": "Salary (personal income)",
"translation_key": "aml.question.one.answer.one",
"nested_questions": [{"id": 2,
"question": "How do you plan to use your Bitpanda account?",
"translation_key": "aml.question.two",
"description": "Question 2 out of 6",
"description_translation_key": "aml.question.two.description",
"step": 2,
"type": "single_choice",
"answers": [null
]
}
]
}
]
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Get appropriateness questions

The endpoint returns the list of questions and answers related to trading with stocks and ETFs. The user must answer the questions before starting investing in stocks and ETFs.

Based on regulatory rules, users may need to retake the test after a certain time period or based on their trading activity. Check whether the user needs to complete or resubmit the test by calling GET /v1/users/{User-ID}

Note that some of the appropriateness questions and answers apply only to users with specific citizenship.

The parameter country containing the user’s citizenship in Alpha-2 ISO 3166 format is mandatory.

You can pass the parameter Accept-Language with a string containing ISO 639-1 language code to get the list of appropriateness questions and answers translated into the chosen language. Currently, Bitpanda supports translations for German, Polish, French, Spanish, Italian and Turkish. The default language is English (en). If you pass the parameter for a language that does not have an existing translation, the response will return the appropriateness questions and answers in English.

SecuritybearerAuth

Request

query Parameters

page_size	integer Number of elements to be displayed on a page Example: page_size=10
page	integer Display page number Example: page=1
country required	string Get regulatory code questions by country of citizenship. Use Alpha-2 ISO 3166 country code. Example: country=AT
user_id	string <uuid> Unique identifier of the user in UUID format. Optional. Must be provided when the user retakes the appropriateness test. Example: user_id=a5431f30-b43f-11f0-82fe-02da11e44a6f

header Parameters

Accept-Language

string

ISO 639-1 language used for translation

Example: en

Responses

200

Success Response

Response Schema: application/json

	Array of objects (QuestionnaireQuestion)
	object (PaginationMeta)
	object (PaginationLinks)

get/v1/appropriateness

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"id": 1,
"label": "knowledge_and_experience_in_stocks_investing",
"sort": 1,
"question": "How much knowledge and experience do you have with investing in stocks?",
"type": "single_choice",
"translation_key": "appropriateness.questions.one",
"answers": [{"id": 1,
"label": "little_or_no_knowledge_or_experience_in_stocks_investing",
"sort": 1,
"answer": "Little or no knowledge or experience.",
"translation_key": "appropriateness.questions.one.answers.one"
}
]
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Get client categorization questionnaire

The endpoint returns the client categorization questionnaire that the user needs to respond during the onboarding process before starting investing.

You can pass the parameter Accept-Language with a string containing ISO 639-1 language code to get the questionnaire translated into the chosen language. Currently, Bitpanda supports translations for German, Polish, French, Spanish, Italian, and Turkish. The default language is English (en). If you pass the parameter for a language that does not have an existing translation in our database, the response returns the questionnaire in English.

SecuritybearerAuth

Request

header Parameters

Accept-Language

string

ISO 639-1 language used for translation

Example: en

Array of objects

get/v1/client-categorization

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"id": 1,
"question": "Which statement best describes your investor profile?",
"title": "Restricted Investor statement",
"subtitle": "Percentage",
"instruction": "In the last financial year did you have:",
"style": "selector",
"type": "statement",
"answers": [{"id": 2,
"answer": "High net worth investor",
"description": "I am earning more than £ 100,000 annually or I have net assets of more than £ 250,000, excluding my primary residence.",
"next_item_id": 2,
"nested_questions": [{"id": 1,
"question": "Which statement best describes your investor profile?",
"title": "Restricted Investor statement",
"subtitle": "Percentage",
"instruction": "In the last financial year did you have:",
"style": "selector",
"type": "statement",
"answers": [null
]
}
]
}
],
"parts": [{"id": 1,
"question": "Which statement best describes your investor profile?",
"title": "Restricted Investor statement",
"subtitle": "Percentage",
"instruction": "In the last financial year did you have:",
"style": "selector",
"type": "statement",
"answers": [{"id": 2,
"answer": "High net worth investor",
"description": "I am earning more than £ 100,000 annually or I have net assets of more than £ 250,000, excluding my primary residence.",
"next_item_id": 2
}
]
}
]
}
]
}

Get DAC8 questionnaire

The endpoint provides the DAC8 questionnaire explaining why a tax ID is not supplied during onboarding for a given country.

If the user selects multiple countries, the questionnaire will be shown once for each selected country.

tax-country parameter represents the country where the user is taxed. country parameter represents the user's country of residence.

You can pass the parameter Accept-Language with a string containing ISO 639-1 language code to get the questionnaire translated into the chosen language. Currently, Bitpanda supports translations for German, Polish, French, Spanish, Italian, and Turkish. The default language is English (en). If you pass the parameter for a language that does not have an existing translation in our database, the response returns the questionnaire in English.

SecuritybearerAuth

Request

path Parameters

tax-country

required

string = 2 characters

Alpha-2 ISO 3166 country code. Represents the user's tax country.

Example: FR

query Parameters

country

required

string = 2 characters

Alpha-2 ISO 3166 country code. Represents user's country of residence.

Example: country=AT

header Parameters

Accept-Language

string = 2 characters

ISO 639-1 language used for translation

Example: en

Array of objects

get/v1/questionnaires/dac8/{tax-country}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"id": 1,
"question": "What is the reason of not providing Tax ID information?",
"translation_key": "dac8.question.one",
"type": "single_choice",
"answers": [{"id": 1,
"answer": "Country does not issue Tax Identification Numbers to individuals",
"translation_key": "dac8.question.one.answer.one"
}
]
}
]
}

Get FATCA questionnaire

This endpoint provides the FATCA questionnaire regarding U.S. indicia that the user must complete during onboarding before beginning to invest.

You can pass the parameter Accept-Language with a string containing ISO 639-1 language code to get the questionnaire translated into the chosen language. Currently, Bitpanda supports translations for German, Polish, French, Spanish, Italian, and Turkish. The default language is English (en). If you pass the parameter for a language that does not have an existing translation in our database, the response returns the questionnaire in English.

SecuritybearerAuth

Request

query Parameters

country

required

string

Alpha-2 ISO 3166 country code. Represents user's country of residence.

Example: country=AT

header Parameters

Accept-Language

string

ISO 639-1 language used for translation

Example: en

Array of objects

get/v1/questionnaires/fatca

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"id": 1,
"question": "Does the account holder have any U.S. indicia?",
"translation_key": "fatca.question.one",
"type": "single_choice",
"answers": [{"id": 1,
"answer": "US citizenship",
"translation_key": "fatca.question.one.answer.one"
}
]
}
]
}

Get account levels

Account levels serve to categorise users into various tiers. Depending on the account levels configuration, distinct trading fees will be applied on users. The account level of a user can be set during user creation or adjusted later. In cases where no account level is specified upon user creation, the default level, as determined during the integration phase, will automatically be assigned to the user.

SecuritybearerAuth

Request

query Parameters

page_size	integer Number of elements to be displayed on a page Example: page_size=10
page	integer Display page number Example: page=1

Responses

200

An array of account levels

Response Schema: application/json

	Array of objects (AccountLevel)
	object (PaginationMeta)
	object (PaginationLinks)

application/json

{"data": [{"id": 1,
"name_key": "Panda"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Create new user

For Partners, using BTS “Investment as a Service” solution:

The endpoint allows to create a new user in Bitpanda system. The parameters in the query body can contain:

Customer master data
KYC/verification data
Accepted Terms & Conditions

If the user has more than one first name or first and middle name, send all names in first_name field separated by a space. The success response returns the ID of the newly created user.

For Partners, using BTS “Bring Your Own License” solution:

The request can include the external_id parameter, which must be unique for each account (user), and the account_level_id parameter.

SecuritybearerAuth

Request

Request Body schema: application/json

The user to create.

email required	string
phone required	string Phone number in E.164 standard format
first_name required	string Allowed characters: uppercase/lowercase letters, comma, full stop, hyphen, apostrophe, and space
last_name required	string Allowed characters: uppercase/lowercase letters, comma, full stop, hyphen, apostrophe, and space
language required	string ISO 639-1 language code for user account
country required	string Alpha-2 ISO 3166 country code. Represents user's citizenship.
terms required	Array of integers The IDs of the accepted terms and conditions and privacy policy
required	Array of objects (AmlQuestionAnswerRequest)
	Array of objects (AppropriatenessQuestionAnswerRequest) Appropriateness test answers shall be provided latest before the first trade with stocks or ETFs
	Array of objects (ClientCategorizationQuestionAnswerRequest) Client categorization questionnaire answers. Required only for UK users.
required	Array of objects (FatcaQuestionAnswerRequest) FATCA questionnaire answers.
	object Answers to the no-tax-ID reason questionnaire, organized by country code (ISO 3166-1 alpha-2). Required if no Tax Identification Number is provided. The user can submit answers for multiple countries.
required	object (UserVerificationV2Request)
	object (UserTax) Deprecated The tax field has been deprecated in favor of tax_identification_numbers. The new tax_identification_numbers field supports multiple tax information entries, allowing users to store and manage more than one tax identifier. Use this field instead of tax for improved flexibility and future compatibility.
	Array of objects (UserMultipleTax) Array of tax information entries, supporting multiple tax residences and identifications
	object (UserExtCompliance) Compliance information, provided by the Partner
account_level_id	integer User account level ID. If not specified, the configured default account level ID will be used.
external_id	string User’s identifier at the partner side. Case insensitive
	object Set of key-value pairs, allowing Partner to provide additional information, as agreed during the integration process

{"email": "username@domain.com",
"phone": "+33123123412",
"first_name": "Jean",
"last_name": "Pascal",
"language": "en",
"country": "FR",
"terms": [1,
2
],
"aml": [{"question_id": 1,
"answer_id": 2,
"answer_value": "Free text user answer"
}
],
"appropriateness": [{"question_id": 1,
"answer_id": 2,
"value": "BP 21321412421"
}
],
"client_categorization": [{"question_id": 1,
"answer_id": 2,
"answer_value": "Free text user answer"
}
],
"fatca": [{"question_id": 1,
"answer_id": 2,
"answer_value": "Free text user answer"
}
],
"dac8": {"AT": {"question_id": 1,
"answer_id": 2,
"answer_value": "Free text user answer"
},
"FR": {"question_id": 2,
"answer_id": 3
}
},
"verification": {"report": "5ce18a58-26f7-4c5d-a9ff-bc348f84b48d",
"files": ["8074815a-905a-4cad-9190-5842bf236d02"
],
"provider": "Verification Provider Name",
"token": "verification-token",
"issuing_date": "2021-04-25",
"issuing_authority": "Ministry of Interior",
"issuing_country": "AT",
"expiration_date": "2028-04-24",
"verification_date": "2021-11-30",
"address": {"street": "52 RUE DES FLEURS",
"city": "Lyon",
"zip_code": "33500",
"country_of_residence": "FR"
},
"gender": "male",
"birth_date": "1970-12-29",
"birth_place": "Lyon, France",
"national_id": "FR 213132132",
"mrz_code": "P<UTOERIKSSON<<JOHN<DOE<<<<<<<<<<<<<<<<<<<<<L898902C36UTO7401122F1202159ZE181226B<<<<<10",
"document_type": "id_card",
"language": "en"
},
"tax": {"id": "12345678",
"residence": "AT"
},
"tax_identification_numbers": [{"id": "12345678",
"residence": "AT"
}
],
"ext_compliance": {"ext_pep_statuses": ["Current PEP",
"Domestic PEP"
],
"ext_user_risk_level": "level 3",
"ext_user_reviewed_kyc_data_at": "2021-07-01T14:56:45+03:00"
},
"account_level_id": 1,
"external_id": "Ext-Id-1",
"external_meta": {"meta_1": "value_1",
"meta_2": "value_2"
}
}

Response samples

application/json

{"data": {"id": "6d7653c6-8ea5-4096-a30e-c86d8eee7d9d"
}
}

Get user list v2

The endpoint returns a list of users cursor-paginated.

SecuritybearerAuth

Request

query Parameters

id	string <uuid> Unique user identifier in UUID format. Example: id=8f3664a8-d98a-11ef-898b-02da11e44a70
type	string Indicates the user type. Enum: "retail" "business" Example: type=retail
verified	boolean Indicates if the user is verified. Example: verified=true
active	boolean Indicates if the user is active. Example: active=true
trading_active	boolean Indicates the user's trading active status. Example: trading_active=true
registered_after	string <date-time> Filters the users registered after a specific date. Value must be URL encoded. Example: registered_after=2025-01-01T00%3A00%3A00%2B00%3A00
registered_before	string <date-time> Filters the users registered before a specific date. Value must be URL encoded. Example: registered_before=2025-01-01T00%3A00%3A00%2B00%3A00
size	integer [ 1 .. 100 ] Indicates the number of results per page. Default value is 50 users per page. Example: size=50
order	string Allows results to be sorted in a specific order. Default value is "asc". Enum: "asc" "desc"
after	string Indicates the cursor value used for pagination. Example: after=eyJ1c2Vycy5pZCI6MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ

Responses

200

List of users cursor-paginated with filtering options.

Response Schema: application/json

	Array of objects (GetUserList)
	object (SimpleCursorPaginationMeta)

401

Unauthorized

Response Schema: application/json

Array of objects

422

Bad Request

Response Schema: application/json

Array of objects

503

Maintenance or Service unavailable

Response Schema: application/json

Array of objects

get/v2/users

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

200
401
422
503

application/json

{"data": [{"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"type": "retail",
"verified": true,
"active": true,
"trading_active": true,
"registered_at": "2025-01-01T12:00:00+00:00",
"offboarded": false,
"compliance": {"aml": "completed",
"appropriateness": "completed",
"client_categorization": "completed",
"cool_off_time_end": "2013-12-28T21:58:04+00:00"
},
"tax_compliant": true
}
],
"meta": {"next_cursor": "eyJ1c2Vycy5pZCI6MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
"prev_cursor": "eyJ1c2Vycy5pZCI6MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjpmYWxzZX0"
}
}

Search for users

Supports full match search by email and/or phone number. This means you can search for records using either an email address or a phone number, but the search will only return results that exactly match the provided email address or phone number.

Use this endpoint to check if a user with the given email/phone already exists. If you need to get more data about a user, call GET /v1/users/{User-ID} endpoint.

For Partners, using BTS “Bring Your Own License” solution, this endpoint is restricted.

SecuritybearerAuth

Request

query Parameters

email	string Email of user Example: email=john.doe@domain.com
phone	string User's phone number Example: phone=38712345678
page_size	integer Number of elements to be displayed on a page Example: page_size=10
page	integer Display page number Example: page=1

Responses

200

List users that match the search query parameters

Response Schema: application/json

	Array of objects (UserSearch)
	object (PaginationMeta)
	object (PaginationLinks)

application/json

{"data": [{"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"appropriateness_tag": {"short_name": "appropriateness.not_appropriate"
},
"active": true,
"verified": true,
"account_level_id": 1
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Get user details v2

The endpoint returns the user’s details based on their user ID. The response includes information about the user’s status (such as active or verified), the result of the appropriateness questionnaire, pending acceptance of terms & conditions, and more.

For Partners, using BTS “Bring Your Own License” solution, this endpoint is restricted.

SecuritybearerAuth

Request

path Parameters

User-ID

required

string <uuid>

User ID

query Parameters

user_journey[]

Array of strings (UserJourney)

Filters terms_not_accepted for one or more specific user journeys. If not provided, all not accepted terms are included in the response.

Items Enum: "onboarding" "trading_stocks_buy" "trading_stocks_sell" "trading_etf_buy" "trading_etf_sell" "trading_metals_buy" "trading_metals_sell" "change_of_circumstances_dac8" "appropriateness_consent" "appropriateness_warning"

header Parameters

Accept-Language

string

ISO 639-1 2-letter code representing user's language

Example: en

Array of objects

get/v2/users/{User-ID}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"type": "retail",
"verified": true,
"active": true,
"trading_active": true,
"registered_at": "2025-01-01T12:00:00+00:00",
"appropriateness_tag": {"short_name": "appropriateness.not_appropriate",
"requires_test_completion": false,
"requires_test_resubmission": false
},
"terms_not_accepted": [1008,
1012
],
"is_pep": false,
"offboarded": false,
"compliance": {"aml": "completed",
"appropriateness": "completed",
"client_categorization": "completed",
"cool_off_time_end": "2013-12-28T21:58:04+00:00"
},
"tax_compliant": true
}
}

Update an existing user

The endpoint allows to update the details for existing users based on user ID.

Updating the Verification Details
Verification details are stored as a single verification object. We do not store the preceding data, so in the case of updating existing data, we can only overwrite it. It is impossible to change a single detail of verification data, like birth date or nationality; if the update of verification data is needed, the whole verification object needs to be sent again.

For Partners, using BTS “Bring Your Own License” solution, this endpoint can only be used to update the account_level_id parameter.

SecuritybearerAuth

Request

path Parameters

User-ID

required

string <uuid>

User ID

Request Body schema: application/json

The user to create.

email	string User email
phone	string Phone number in E.164 standard format
first_name	string Allowed characters: uppercase/lowercase letters, comma, full stop, hyphen, apostrophe, and space
last_name	string Allowed characters: uppercase/lowercase letters, comma, full stop, hyphen, apostrophe, and space
language	string ISO 639-1 language code for user account
country	string Alpha-2 ISO 3166 country code. Represents user's citizenship.
terms	Array of integers The IDs of the accepted terms and conditions and privacy policy
	Array of objects (AmlQuestionAnswerRequest)
	Array of objects (AppropriatenessQuestionAnswerRequest) Appropriateness test answers shall be provided latest before the first trade with stocks or ETFs
	Array of objects (ClientCategorizationQuestionAnswerRequest) Client categorization questionnaire answers. Required only for UK users.
	object Answers to the no-tax-ID reason questionnaire, organized by country code (ISO 3166-1 alpha-2). Required if no Tax Identification Number is provided. The user can submit answers for multiple countries.
	object (UserVerificationV2Request)
	object (UserTax) Deprecated The tax field has been deprecated in favor of tax_identification_numbers. The new tax_identification_numbers field supports multiple tax information entries, allowing users to store and manage more than one tax identifier. Use this field instead of tax for improved flexibility and future compatibility.
	Array of objects (UserMultipleTax) Array of tax information entries, supporting multiple tax residences and identifications
	object (UserExtCompliance) Compliance information, provided by the Partner
account_level_id	integer User account level ID
external_id	string User’s identifier at the partner side. Case insensitive
	object Set of key-value pairs, allowing Partner to provide additional information, as agreed during the integration process

Array of objects

patch/v2/users/{User-ID}

Request samples

application/json

{"email": "username@domain.com",
"phone": "+33123123412",
"first_name": "Jean",
"last_name": "Pascal",
"language": "en",
"country": "FR",
"terms": [1,
2
],
"aml": [{"question_id": 1,
"answer_id": 2,
"answer_value": "Free text user answer"
}
],
"appropriateness": [{"question_id": 1,
"answer_id": 2,
"value": "BP 21321412421"
}
],
"client_categorization": [{"question_id": 1,
"answer_id": 2,
"answer_value": "Free text user answer"
}
],
"dac8": {"AT": {"question_id": 1,
"answer_id": 2,
"answer_value": "Free text user answer"
},
"FR": {"question_id": 2,
"answer_id": 3
}
},
"verification": {"report": "5ce18a58-26f7-4c5d-a9ff-bc348f84b48d",
"files": ["8074815a-905a-4cad-9190-5842bf236d02"
],
"provider": "Verification Provider Name",
"token": "verification-token",
"issuing_date": "2021-04-25",
"issuing_authority": "Ministry of Interior",
"issuing_country": "AT",
"expiration_date": "2028-04-24",
"verification_date": "2021-11-30",
"address": {"street": "52 RUE DES FLEURS",
"city": "Lyon",
"zip_code": "33500",
"country_of_residence": "FR"
},
"gender": "male",
"birth_date": "1970-12-29",
"birth_place": "Lyon, France",
"national_id": "FR 213132132",
"mrz_code": "P<UTOERIKSSON<<JOHN<DOE<<<<<<<<<<<<<<<<<<<<<L898902C36UTO7401122F1202159ZE181226B<<<<<10",
"document_type": "id_card",
"language": "en"
},
"tax": {"id": "12345678",
"residence": "AT"
},
"tax_identification_numbers": [{"id": "12345678",
"residence": "AT"
}
],
"ext_compliance": {"ext_pep_statuses": ["Current PEP",
"Domestic PEP"
],
"ext_user_risk_level": "level 3",
"ext_user_reviewed_kyc_data_at": "2021-07-01T14:56:45+03:00"
},
"account_level_id": 1,
"external_id": "Ext-Id-1",
"external_meta": {"meta_1": "value_1",
"meta_2": "value_2"
}
}

Response samples

application/json

{"data": {"id": "6d7653c6-8ea5-4096-a30e-c86d8eee7d9d"
}
}

Get user details

The endpoint returns the user’s details based on their user ID. The response includes information about the user’s status (such as active or verified), the result of the appropriateness questionnaire, pending acceptance of terms & conditions, and more.

For Partners, using BTS “Bring Your Own License” solution, this endpoint is restricted.

SecuritybearerAuth

Request

path Parameters

User-ID

required

string <uuid>

User ID

query Parameters

user_journey

string (UserJourney)

Filters terms_not_accepted for a specific user journey. If not provided, all not accepted terms are included in the response.

Enum: "onboarding" "trading_stocks_buy" "trading_stocks_sell" "trading_etf_buy" "trading_etf_sell" "trading_metals_buy" "trading_metals_sell" "change_of_circumstances_dac8" "appropriateness_consent" "appropriateness_warning"

header Parameters

Accept-Language

string

ISO 639-1 2-letter code representing user's language

Example: en

User-ID

required

string <uuid>

User ID

Request Body schema: application/json

The Off-boarding user request.

reason required	string The off-boarding reason Enum: "business_relation_end" "compliance" "deceased" "dunning_unsuccessful" "insolvency" "mentally_incapacitated" "other"
first_notice_of_termination	string The first notice of termination
country_of_residence	string Residence country code in Alpha-2 ISO 3166 format
liquidate_assets	boolean Recommendation on whether to liquidate the assets as part of the off-boarding process

{"reason": "other",
"first_notice_of_termination": "2021-04-25",
"country_of_residence": "AT",
"liquidate_assets": true
}

Response samples

application/json

{"data": {"id": "6d7653c6-8ea5-4096-a30e-c86d8eee7d9d",
"reason": "other"
}
}

Inactivate user

The endpoint deactivates the user. The procedure is reversible, but to activate again a previously deactivated user, you need to contact Bitpanda.

When may you want to deactivate the user?

User does not want to use your trading solution anymore and asks about the account deactivation
User did not provide the Proof of Funds
User suspects the account may have been compromised/hacked

SecuritybearerAuth

Request

path Parameters

User-ID

required

string <uuid>

User ID

User-ID

required

string <uuid>

User ID

query Parameters

user_journey

string (UserJourney)

Filters the user accepted terms for a specific user journey. If not provided, all accepted terms are included in the response.

Enum: "onboarding" "trading_stocks_buy" "trading_stocks_sell" "trading_etf_buy" "trading_etf_sell" "trading_metals_buy" "trading_metals_sell" "change_of_circumstances_dac8" "appropriateness_consent" "appropriateness_warning"

User-ID

required

string <uuid>

User ID

query Parameters

user_journey[]

Array of strings (UserJourney)

Filters the user accepted terms for one or more specific user journeys. If not provided, all accepted terms are included in the response.

Items Enum: "onboarding" "trading_stocks_buy" "trading_stocks_sell" "trading_etf_buy" "trading_etf_sell" "trading_metals_buy" "trading_metals_sell" "change_of_circumstances_dac8" "appropriateness_consent" "appropriateness_warning"

Response samples

application/json

{"data": [{"id": 1,
"content_type": "link",
"title": "User Agreement BTS EN",
"type": "GENERAL_TERMS",
"version": "3.0.2",
"mandatory": true,
"effective_at": "2024-12-20T08:14:20+00:00",
"url": "https://cdn.bitpanda.com/terms-and-conditions/general-terms-en-3.0.2.pdf",
"accepted_at": "2025-01-14T14:22:43+00:00"
}
]
}

User verification files

The endpoint enables the addition of verification files to the verification object when the complete files package cannot be transmitted at once via PATCH /users.

Using this endpoint eliminates the need to resend the entire verification object. The files will be appended to the existing verification object.

For Partners, using BTS “Bring Your Own License” solution, this endpoint is restricted.

SecuritybearerAuth

Request

path Parameters

User-ID

required

string <uuid>

User ID

Request Body schema: application/json

The files to validate.

files

Array of strings <uuid>

A list of unique file IDs returned by the File Service, representing additional user files

Responses

202

{"files": ["f9ccbeed-c74c-4ed8-81d4-ffffb6f06e87"
]
}

Response samples

application/json

{"errors": [{"code": "http.bad.request",
"title": "Bad JSON received."
}
]
}

Get Legal Documents

The endpoint returns a list of Bitpanda legal documents.

You can pass the parameter Accept-Language with a string containing ISO 639-1 language code to get the list of legal documented translated into the chosen language, if available.

SecuritybearerAuth

Request

query Parameters

country	string Alpha-2 ISO 3166 country code. Represents user's country of residence. Example: country=AT
account_type	string Account type Enum: "user" "business_user" Example: account_type=user

header Parameters

Accept-Language

string

ISO 639-1 2-letter code representing user's language

Example: en

Array of objects

get/v1/legal-documents

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"id": "f380abd0-4712-4e1c-96cd-43ea6809a317",
"version_id": "f380abd0-4712-4e1c-96cd-43ea6809a317",
"version": "1.0.0",
"title": "Cost Transparency Crypto Assets",
"slug": "COST_TRANSPARENCY_CRYPTO",
"language": "en",
"href": "https://cdn.bitpanda.com/cost-transparancy-crypto.pdf",
"released_at": "2024-10-18T23:35:24+00:00",
"effective_at": "2025-01-29T04:52:19+00:00"
}
]
}

Capture consent for User's final check

This endpoint captures the consent for User's final check, required to complete the pre-trade process. This action must be performed after the User's cool-off period has ended. Available only for UK users.

SecuritybearerAuth

Request

path Parameters

User-ID

required

string <uuid>

User ID

Responses

204

User successfully accepted final check

403

Error code

Response Schema: application/json

Array of objects

500

Error

Response Schema: application/json

Array of objects

503

Maintenance or Service unavailable

Response Schema: application/json

Array of objects

post/v1/users/{User-ID}/accept-final-check

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

403
500
503

application/json

{"errors": [{"code": "forbidden",
"title": "This action is forbidden."
},
{"code": "forbidden",
"title": "User cool-off period not stared."
},
{"code": "forbidden",
"title": "User is currently in cool-off period."
}
]
}

Retrieve Tax Identification Number Configuration

This endpoint retrieves tax identification number configuration rules and validation requirements for supported countries.

It provides country-level information on how tax identification numbers should be formatted, validated, and categorized.

The data returned can be used to guide user input validation or enforce country-specific compliance requirements when collecting tax-related information.

SecuritybearerAuth

Request

header Parameters

Accept-Language

string

ISO 639-1 language used for translation

Example: en

Responses

200

Successfully retrieved country-specific tax identification number configuration rules.

Response Schema: application/json

Array of objects

A list of country-specific tax identification number (TIN) configuration rules.

400

Invalid request or user context.

Response Schema: application/json

Array of objects

429

Too Many Requests

Response Schema: application/json

Array of objects

500

Internal Error

Response Schema: application/json

Array of objects

get/v1/countries/tax-rules

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

200
400
429
500

application/json

{"data": [{"country": "DE",
"country_name": "Germany",
"title": "Steueridentifikationsnummer",
"min_length": 11,
"max_length": 25,
"placeholder": "12 345 678 901"
}
]
}

Assets

Get a list of available assets

The endpoint returns a list of all assets enabled globally for the Partner. The list is sortable. To get specific infos for your asset you need to add the asset ID in your get request.

SecuritybearerAuth

Request

query Parameters

types[]	Array of strings Asset types Items Enum: "cryptocoin" "commodity" "index" "security" Example: types[]=cryptocoin&types[]=index
groups[]	Array of strings Asset groups Items Enum: "coin" "token" "metal" "index" "stock" "etf" "etc" "leveraged_token" "fiat_earn" "mutual_fund" "security_token" Example: groups[]=coin&groups[]=token
type	string Asset type Enum: "cryptocoin" "commodity" "index" "security" Example: type=cryptocoin
group	string Asset group Enum: "coin" "token" "metal" "index" "stock" "etf" "etc" "leveraged_token" "fiat_earn" "mutual_fund" "security_token" Example: group=coin
page_size	integer Number of elements to be displayed on a page Example: page_size=1
page	integer Display page number Example: page=1
sort_by	string Sort assets Enum: "change_24h" "change_1w" "change_1m" "change_1y" "display_price" "market_cap" Example: sort_by=market_cap
sort_order	string Sort order Enum: "asc" "desc" Example: sort_order=desc
tags[]	Array of strings Asset tags Example: tags[]=asset_tag.group.europe&tags[]=asset_tag.group.payments
q	string Query to search assets by name or symbol Example: q=btc
currency	string Indicates the currency symbol used to fetch values in a particular monetary unit Example: currency=USD
allow_buy	boolean Filters assets based on whether they are configured to be available for purchase Example: allow_buy=true

Responses

200

List assets

Response Schema: application/json

	Array of objects (Asset)
	object (PaginationMeta)
	object (PaginationLinks)

required

integer

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id required	integer Asset ID
fiatId required	integer Fiat ID
period required	string Period Enum: "day" "week" "month" "year" "6m" "5y" Example: day

Response samples

application/json

{"data": [{"open": "36133.2",
"high": "36133.2",
"close": "36094.2",
"low": "36088.9",
"time": "2021-06-13T15:40:00+02:00"
},
{"open": "36076.6",
"high": "36084.7",
"close": "35968.4",
"low": "35968.4",
"time": "2021-06-13T15:50:00+02:00"
},
{"open": "35948.2",
"high": "36037.2",
"close": "36024.5",
"low": "35948.2",
"time": "2021-06-13T16:00:00+02:00"
}
]
}

Get asset information

The endpoint returns general information on the asset based on the asset ID in the chosen language (default is English). It will also return the maintenance_reason if the selected asset is currently in maintenance mode.

Translation troubleshooting

Scenario 1: Description received in English instead of the chosen language

If Bitpanda does not support the language requested in the header, you will receive a description in English in the response. Currently, Bitpanda supports translation for German, Polish, French, Spanish, Italian and Turkish.

Scenario 2: Description received is empty

In some exceptional cases, a new asset can be released before having all the translations in supported languages available. If you received an empty description in the response, you would need to make another call with the language parameter changed to English (en) to get the default assets description.

SecuritybearerAuth

Request

path Parameters

id

required

integer

Asset ID

header Parameters

Accept-Language

string

ISO 639-1 language used for translation

Example: en

Array of objects

get/v1/assets/{id}/allocations

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"asset_id": 22,
"allocation": "0.13991500"
}
]
}

Get cryptocoin details

The endpoint returns details on crypto coins. These details are visible in the user interface in the app. Please note that each asset type will return information related only to that asset. For example, stock details will be different from crypto coins details.

SecuritybearerAuth

Request

path Parameters

id

required

integer

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

integer

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

integer

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

integer

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

integer

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

integer

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

integer

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

integer

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

integer

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

integer

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

types[]	Array of strings Asset types Items Enum: "cryptocoin" "commodity" "index" "security" Example: types[]=cryptocoin&types[]=index
groups[]	Array of strings Asset groups Items Enum: "coin" "token" "metal" "index" "stock" "etf" "etc" "leveraged_token" "fiat_earn" "mutual_fund" "security_token" Example: groups[]=coin&groups[]=token
type	string Asset type Enum: "cryptocoin" "commodity" "index" "security" Example: type=cryptocoin
group	string Asset group Enum: "coin" "token" "metal" "index" "stock" "etf" "etc" "leveraged_token" "fiat_earn" "mutual_fund" "security_token" Example: group=coin
page_size	integer Number of elements to be displayed on a page Example: page_size=1
page	integer Display page number Example: page=1
sort_by	string Sort assets Enum: "change_24h" "change_1w" "change_1m" "change_1y" "display_price" "market_cap" Example: sort_by=market_cap
sort_order	string Sort order Enum: "asc" "desc" Example: sort_order=desc
tags[]	Array of strings Asset tags Example: tags[]=asset_tag.group.europe&tags[]=asset_tag.group.payments
q	string Query to search assets by name or symbol Example: q=btc
currency	string Indicates the currency symbol used to fetch values in a particular monetary unit Example: currency=USD
allow_buy	boolean Filters assets based on whether they are configured to be available for purchase Example: allow_buy=true

Responses

200

List assets

Response Schema: application/json

	Array of objects (Asset-V2)
	object (PaginationMeta)
	object (PaginationLinks)

required

string <uuid>

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

Response samples

application/json

{"data": {"id": "5bf5897e-a5cc-4501-8afb-09aa502fd353",
"type": "cryptocoin",
"group": "coin",
"symbol": "BTC",
"logo": "https://cdn.example.com/logos/v4/asset/light/ea895436-edee-11eb-9bf0-06502b1fe55d.png",
"legal_url": "https://www.bitpanda.com/legal#terms",
"name": "Bitcoin",
"display_price": "32331.5501250000000000",
"change_24h": "9.0491629452993",
"change_1w": "7.4084352108699",
"change_1m": "-21.355858926521",
"change_1y": "289.56960376176",
"change_5y": "-0.067180931365",
"change_24h_amount": "2682.9501250000075744",
"change_1w_amount": "2230.0501250000027452",
"change_1m_amount": "-8779.6498749998745640",
"change_1y_amount": "24032.2501249999352311",
"change_5y_amount": "-71.1309012276816912",
"precision_display_fiat": 2,
"precision_display_asset": 4,
"precision_transaction_max_allowed": 8,
"min_buy_eur": "4.5",
"min_sell_eur": "2",
"buy_active": true,
"sell_active": false,
"market_cap": "250816161.6363840000000000",
"is_active": true,
"enabled_for_automated_orders": true,
"legal_classification": "NONE",
"staking": {"staking_type": "flexible",
"unbounded_period": 3,
"enabled_for_autostaking": true,
"reward_interval_in_days": 7,
"yearly_interest": "0.02500000",
"minimum_stakeable_amount": "0.10000000",
"enabled": true,
"soldout": false,
"next_reward_at": "2022-11-11T13:07:31+00:00",
"current_rewards_period_ends_at": "2022-11-11T13:07:31+00:00"
},
"asset_tags": ["asset_tag.group.payments",
"asset_tag.group.proof_of_work"
],
"network_information": {"default_network_id": "1ed76f61-37e9-6ef0-b0c1-529adbc40ff6",
"networks": [{"id": "1ed76f61-37e9-6ef0-b0c1-529adbc40ff6",
"name": "Mainnet",
"coin_network_id": "1ed76f61-37e9-6ef0-b0c1-529adbc40ff6",
"destination_tag": "rBnNhk95FrdNisZtXcStzriFS8vEzz53DM",
"min_deposit_threshold": "0.02500000",
"small_deposit_threshold": "0.02500000",
"small_deposit_fee": "0.02500000",
"min_withdrawal_fee": "0.02500000",
"min_withdrawal_threshold": "0.02500000",
"max_transaction_precision": 8,
"is_deposit_allowed": true,
"is_withdrawal_allowed": true,
"is_operational": true,
"logo_url": "https://cdn.example.com/logos/v4/network/light/1ede43b3-d312-6f0d-8186-4d0a766f2ec3.png"
}
]
}
}
}

Get asset information

The endpoint returns general information on the asset based on the asset ID in the chosen language (default is English). It will also return the maintenance_reason if the selected asset is currently in maintenance mode.

Translation troubleshooting

Scenario 1: Description received in English instead of the chosen language

If Bitpanda does not support the language requested in the header, you will receive a description in English in the response. Currently, Bitpanda supports translation for German, Polish, French, Spanish, Italian and Turkish.

Scenario 2: Description received is empty

In some exceptional cases, a new asset can be released before having all the translations in supported languages available. If you received an empty description in the response, you would need to make another call with the language parameter changed to English (en) to get the default assets description.

SecuritybearerAuth

Request

path Parameters

id

required

string <uuid>

Asset ID

Example: 2e4c89ac-1290-426f-8de0-4c7b40b91d3a

header Parameters

Accept-Language

string

ISO 639-1 language used for translation

Example: en

id required	string <uuid> Asset ID
currency required	string The three letter ISO 4217 currency code Example: USD
period required	string Period Enum: "day" "week" "month" "year" "6m" "5y" Example: day

id

required

string <uuid>

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

string <uuid>

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

string <uuid>

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

string <uuid>

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

string <uuid>

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

string <uuid>

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

string <uuid>

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

string <uuid>

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

string <uuid>

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

id

required

string <uuid>

Asset ID

query Parameters

currency

string

Indicates the currency symbol used to fetch values in a particular monetary unit

Example: currency=USD

Response samples

application/json

{"data": {"daily_high": "24.09897048325",
"daily_low": "21.161279791300",
"high_52_w": "31.061946541",
"low_52_w": "9.1657455708750000",
"monthly_volatility": "0.2719807987529688136364548853",
"market_cap": "1316239540.50000000",
"time": "2022-11-08T12:53:57.176773Z"
}
}

Get asset tags mapping

The endpoint returns a list of all available asset tags grouped by types

SecuritybearerAuth

Responses

200

Asset tags mapping

Response Schema: application/json

Array of objects (TagsMapping)

401

Unauthorized

Response Schema: application/json

Array of objects

500

Error

Response Schema: application/json

Array of objects

503

Maintenance or Service unavailable

Response Schema: application/json

Array of objects

get/v1/tags

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

200
401
500
503

application/json

{"data": [{"label": "asset_tag.type.region",
"translation": "Region",
"groups": [{"label": "asset_tag.group.europe",
"translation": "Europe"
}
]
}
]
}

Get prices

Display Asset price with fees

SecuritybearerAuth

Request

query Parameters

asset_id required	integer Asset ID Example: asset_id=1
fiat_id required	integer Fiat ID Example: fiat_id=1
type required	string Type Enum: "buy" "sell" Example: type=buy

header Parameters

bp-user-id

required

string <uuid>

User ID

asset_id required	string <uuid> Asset ID Example: asset_id=1e0f8b2c-4d3a-4b5e-8c7f-9a2b3c4d5e6f
fiat_id required	string <uuid> Fiat ID Example: fiat_id=1e0f8b2c-4d3a-4b5e-8c7f-9a2b3c4d5e6h
type required	string Type Enum: "buy" "sell" Example: type=buy

header Parameters

bp-user-id

required

string <uuid>

User ID

Response samples

application/json

{"data": {"id": "1e0f8b2c-4d3a-4b5e-8c7f-9a2b3c4d5e6f",
"symbol": "BTC",
"price": "34810.79865432",
"net_price": "32810.79865432",
"fee": "18.12345678"
}
}

Asset ESG Data

Get asset ESG data

The endpoint returns ESG data for a specific asset.

SecuritybearerAuth

Request

path Parameters

id

required

integer

Asset ID

header Parameters

Accept-Language

string

ISO 639-1 2-letter code representing user's language

Example: en

id

required

string <uuid>

Asset ID

header Parameters

Accept-Language

string

ISO 639-1 2-letter code representing user's language

Example: en

Response samples

application/json

{"data": {"legal_entity_id": "9845005X9B7N610K0093",
"crypto_asset_name": "Algorand",
"consensus_mechanism_desc": "[...]",
"incentive_mechanism_desc": "[...]",
"reporting_period": {"start": "2024-01-08",
"end": "2025-01-08"
},
"energy_consumption_total": {"unit": "kWh/a",
"value": "420961.80000"
},
"energy_consumption_renewable": {"unit": "%",
"value": "17.2043909674"
},
"energy_consumption_desc": "[...]",
"energy_intensity": {"unit": "kWh",
"value": "0.00002"
},
"emissions_scope1": {"unit": "tCO2e/a",
"value": "0.00000"
},
"emissions_scope2": {"unit": "tCO2e/a",
"value": "141.76181"
},
"ghg_intensity": {"unit": "kgCO2e",
"value": "0.00001"
},
"energy_sources_desc": "[...]",
"ghg_sources_desc": "[...]"
}
}

Exchange rate

Get the exchange rate for two assets

The endpoint returns the exchange rate from source to target asset.

SecuritybearerAuth

Request

path Parameters

sourceAssetId required	string <uuid> Source Asset ID Example: 1d9e339b-7233-4aa6-ba16-8518bbf354e5
targetAssetId required	string <uuid> Target Asset ID Example: 1d9e339b-7233-4aa6-ba16-8518bbf354e5

Responses

200

Success Response

Response Schema: application/json

exchange_rate

string

Response samples

application/json

{"exchange_rate": "0.121234786512765"
}

Swap exchange rate

Get the swap exchange rate between two assets

The endpoint returns the swap exchange rate from source to target asset. One of source or target asset can be fiat.

SecuritybearerAuth

Request

path Parameters

sourceAssetId required	string <uuid> Source Asset ID Example: 1d9e339b-7233-4aa6-ba16-8518bbf354e5
targetAssetId required	string <uuid> Target Asset ID Example: 1d9e339b-7233-4aa6-ba16-8518bbf354e5

query Parameters

source_asset_amount

number <float>

A string parameter representing the source amount

Example: source_asset_amount=5

Responses

200

Success Response

Response Schema: application/json

exchange_rate

string

The swap exchange rate for the two provided assets

401

Unauthorized

Response Schema: application/json

Array of objects

403

Forbidden

Response Schema: application/json

Array of objects

422

Error

Response Schema: application/json

Array of objects

500

Error

Response Schema: application/json

Array of objects

get/v1/exchange/{sourceAssetId}/{targetAssetId}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

200
401
403
422
500

application/json

{"exchange_rate": "0.12345678"
}

Fiats

List all available fiats per partner

This endpoint retrieves a list of all fiat currencies available in the Partner's application, as initially configured.

SecuritybearerAuth

Response samples

200
401
429
500
503

application/json

{"data": [{"id": "147d37bb-3928-11ef-8339-068cf35b246f",
"symbol": "EUR",
"name": "Euro",
"default": true
}
]
}

Trades

List all trades per user

The endpoint retrieves a list of buy and sell trades in finished status associated with a specified user ID.

SecuritybearerAuth

Request

query Parameters

types[]	string Trade type Enum: "buy" "sell" Example: types[]=buy
page_size	integer Number of elements to be displayed on a page Example: page_size=10
page	integer Display page number Example: page=1
asset_id	integer If asset_id is provided only the trades for that specific asset will be in the response Example: asset_id=1

header Parameters

bp-user-id

required

string <uuid>

User ID

Responses

200

List user trades

Response Schema: application/json

	Array of objects
	object (PaginationMeta)
	object (PaginationLinks)

get/v1/trades

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"offer_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"type": "buy",
"fiat_id": 1,
"asset_id": 1,
"fiat_amount": "1.89",
"tax_amount": "0.10",
"total_amount": "1.99",
"asset_amount": "0.00004884",
"asset_price": "40743.41527688",
"time": "2021-07-01T14:56:45+03:00",
"status": "finished",
"spread": "0.12000000",
"final_revenue_share": "0.12000000",
"initiated_by": "user"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Get trades history for user using asset and fiat uuid

The endpoint retrieves a list of buy and sell trades in finished status associated with a specified user ID.

SecuritybearerAuth

Request

query Parameters

types[]	string Trade type Enum: "buy" "sell" Example: types[]=buy
page_size	integer Number of elements to be displayed on a page Example: page_size=10
page	integer Display page number Example: page=1
asset_id	string <uuid> If asset_id is provided only the trades for that specific asset will be in the response Example: asset_id=ea895436-edee-11eb-9bf0-06502b1fe55d

header Parameters

bp-user-id

required

string <uuid>

User ID

Responses

200

List user trades

Response Schema: application/json

	Array of objects
	object (PaginationMeta)
	object (PaginationLinks)

get/v2/trades

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"offer_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"type": "buy",
"fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"asset_id": "ea895436-edee-11eb-9bf0-06502b1fe55d",
"fiat_amount": "1.89",
"tax_amount": "0.10",
"total_amount": "1.99",
"asset_amount": "0.00004884",
"asset_price": "40743.41527688",
"time": "2021-07-01T14:56:45+03:00",
"status": "finished",
"spread": "0.12000000",
"final_revenue_share": "0.12000000",
"initiated_by": "user"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Transaction timeline per user

This endpoint retrieves a chronological list of all transactions for a specific user. It provides detailed information on each transaction, including the date, time, amount, and type of transaction, allowing users to track their financial activity.

SecuritybearerAuth

Request

query Parameters

category	string Filter by category Enum: "trade" "corporate_action" "crypto_action" "non_user_initiated" "crypto_transfer" Example: category=trade
size	integer [ 1 .. 50 ] Default: 10 Number of elements to be displayed on a page Example: size=10
cursor	string Page cursor Example: cursor=MjAyNC0wNC0yOFQxODowNTozM1o
asset_int	integer >= 1 Deprecated If asset_int is provided only the transactions for that specific asset will be in the response Example: asset_int=1
asset_id	string <uuid> If asset_id is provided only the transactions for that specific asset will be in the response Example: asset_id=ea895436-edee-11eb-9bf0-06502b1fe55d

header Parameters

bp-user-id

required

string

User ID

Responses

200

Success Response

Response Schema: application/json

	Array of objects (TransactionTimelineItem)
	object

application/json

{"data": [{"id": "1ef3c8b7-8b65-6784-912a-b7cc10fee72f",
"category": "non_user_initiated",
"type": "reward",
"credited_at": "2024-04-21T18:05:21Z",
"status": "finished",
"transactions": [{"id": "1ef3c8b7-8b65-6784-912a-b7cc10fee72f",
"direction": "incoming",
"fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"asset_id": "ea8962d5-edee-11eb-9bf0-06502b1fe55d",
"fiat_int": 1,
"asset_int": 5,
"fiat_amount": "10.00",
"asset_amount": "0.11045080",
"asset_price": "24.74633041",
"net_asset_price": "24.74633041",
"tax_amount": "0.003",
"spread": "0.3",
"fee_percentage": "0.9",
"offer_id": "648bc8ac-faad-4162-8916-4f6a6a7ea88c"
}
]
}
],
"meta": {"cursor": "MjAyNC0wNS0yM1QwODo0NTo1OS42MjVa",
"size": 10
}
}

Search for trades

This endpoint allows you to search for finished trades by date range, trade ID, offer ID or user ID, individually or in combination, with the search period limited to a maximum of 31 days.

SecuritybearerAuth

Request

query Parameters

date_start	string Start date for search in Y-m-d format Example: date_start=2021-04-25
date_end	string End date for search in Y-m-d format Example: date_end=2021-06-25
status	string The trade status Enum: "all" "failed" "finished" Example: status=all
internal_trade_id	string <uuid> The unique trade identifier Example: internal_trade_id=2e4c89ac-1290-426f-8de0-4c7b40b91d3a
external_transaction_id	string <uuid> The unique external trade identifier Example: external_transaction_id=77b5d766-e5da-4dd9-bd18-58a43c35b8ac
offer_id	string <uuid> The unique offer_id identifier Example: offer_id=abc5d766-e5da-4dd9-bd18-58a43c35b8ac
user_pid	string <uuid> Unique User Identifier Example: user_pid=abc2d123-a5db-4dd9-bd18-58a43c35b9ab
initiated_by	string The initiator of the trade Enum: "all" "user" "automated_order" "bitpanda_corporate_action" "bitpanda_manual_trade" "bitpanda_savings" "bitpanda_swaps" Example: initiated_by=all
page_size	integer Number of elements to be displayed on a page Example: page_size=10
page	integer Display page number Example: page=1

Responses

200

List trades that match the search query parameters

Response Schema: application/json

	Array of objects (TradeSearchV2)
	object (PaginationMeta)
	object (PaginationLinks)

application/json

{"data": [{"id": "abcc89ac-1290-426f-8de0-4c7b40b91d3a",
"offer_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"type": "buy",
"fiat_id": 1,
"asset_id": 1,
"fiat_amount": "1.89",
"tax_amount": "0.10",
"total_amount": "1.99",
"asset_amount": "0.00060120",
"asset_price": "11278.15044158",
"time": "2022-09-30T14:56:45+03:00",
"external_transaction_id": "abc-ext-123-123",
"user_pid": "abc170cc-abcb-4318-abc5-24abc9210d75",
"status": "finished",
"fiat_symbol": "EUR",
"asset_symbol": "BTC",
"gross_fee": "11278.15044158",
"fees_after_cost": "0.00000000",
"final_revenue_share": "0.00000000",
"initiated_by": "user"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Lightweight Search for trades V2

This endpoint allows you to search for trades by date range, id, user_id, status, asset symbol, type, initiated_by individually or in combination.

SecuritybearerAuth

Request

query Parameters

start	string Start date for search in UTC timezone Example: start=2024-06-01T00:00:00Z
end	string End date for search in UTC timezone Example: end=2024-06-30T23:59:59Z
status	string The trade status Enum: "created" "failed" "in progress" "finished" "expired" Example: status=failed
initiated_by	string The initiator of the trade Enum: "user" "bitpanda_corporate_action" "bitpanda_manual_trade" "bitpanda_savings" "bitpanda_swaps" "automated_order" Example: initiated_by=user
asset_symbol	string The asset symbol Example: asset_symbol=BTC
type	string The trade type Enum: "buy" "sell" Example: type=buy
id	string <uuid> The unique trade identifier Example: id=abc5d766-e5da-4dd9-bd18-58a43c35b8ac
user_id	string <uuid> Unique User Identifier Example: user_id=abc2d123-a5db-4dd9-bd18-58a43c35b9ab
external_transaction_id	string <uuid> External Transaction ID Example: external_transaction_id=abc5d766-e5da-4dd9-bd18-58a43c35b8ad
page_size	integer Number of elements to be displayed on a page Example: page_size=10
cursor	string <uuid> Cursor for the next page Example: cursor=abc5d766-e5da-4dd9-bd18-58a43c35b8ac

Responses

200

List trades that match the search query parameters

Response Schema: application/json

	Array of objects (trades-search-lightweight)
	object (NextPrevCursorPagination)

application/json

{"data": [{"id": "abcc89ac-1290-426f-8de0-4c7b40b91d3a",
"user_id": "abcc89ac-1290-426f-8de0-4c7b40b91d3b",
"type": "buy",
"status": "finished",
"initiated_by": "user",
"fiat_id": "abcc89ac-1290-426f-8de0-4c7b40b91d3c",
"asset_id": "abcc89ac-1290-426f-8de0-4c7b40b91d3d",
"fiat_amount": "1.89",
"asset_amount": "0.00060120",
"tax_amount": "0.10",
"total_amount": "1.99",
"asset_price": "11278.15044158",
"created_at": "2022-09-30T14:56:45+03:00",
"time": "2022-09-30T14:56:45+03:00",
"external_transaction_id": "abc-ext-123-123",
"fiat_symbol": "EUR",
"asset_symbol": "BTC",
"gross_fee": "11278.15044158",
"fees_after_cost": "0.08382600",
"final_revenue_share": "0.03112211"
}
],
"meta": {"next": "abc2d123-a5db-4dd9-bd18-58a43c35b9ab",
"prev": "abc2d123-a5db-4dd9-bd18-58a43c35b9ac",
"page_size": 15
}
}

Create a trade offer

This endpoint is responsible for initiating a buy/sell trade offer on behalf of the user.

The request triggers the creation of a trade offer that can later be accepted by the user within its validity (as defined in offer_validity & expires_at response parameters).
The offer includes details such as the asset to be traded, the fiat currency and the amount either in fiat currency or in units of the asset being traded. By accommodating both fiat and asset unit denominations, the user experience is enhanced, catering to a wide range of trading preferences and strategies.

The trade offer response outlines the details of the proposed trade, including: asset, amount, price, fees, preliminary tax calculations if applicable, and any warning messages relevant to the user.

SecuritybearerAuth

Request

header Parameters

bp-user-id

required

string <uuid>

User ID

Request Body schema: application/json

The offer to be created.

type required	string Offer Type Enum: "buy" "sell"
fiat_id required	integer Fiat ID
asset_id required	integer Asset ID
amount required	string Transaction amount
amount_defined_for required	string Amount defined for Enum: "fiat" "asset"

{"type": "sell",
"fiat_id": 1,
"asset_id": 1,
"amount": "10",
"amount_defined_for": "fiat"
}

Response samples

application/json

{"data": {"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"type": "sell",
"fiat_id": 1,
"asset_id": 1,
"fiat_amount": "7.25",
"tax_amount": "2.75",
"total_amount": "10.00",
"asset_amount": "0.00448235",
"asset_price": "2230.97065877",
"net_asset_price": "2259.97327734",
"spread": "0.13000000",
"volume": "10.13",
"offer_validity": 60,
"expires_at": "2021-07-01T18:00:09+03:00",
"time": "2021-07-01T17:59:09+03:00",
"warning": [{"message": "Please keep in mind that if you sell your assets now,you will lose your right to receive dividends for the amount you sell !",
"message_key": "corporate.action.dividend.warning.message.sell",
"helpdesk_article_id": "360020583999",
"link_message": "For further information, please visit our helpdesk.",
"link_message_key": "corporate.action.dividend.warning.link.message"
},
{"message": "Tax withholding provider is not available",
"message_key": "tax.withholding.not.available",
"helpdesk_article_id": "",
"link_message": "",
"link_message_key": ""
},
{"message": "Due to illiquid orderbook price deviates more than 10% to the traded price",
"message_key": "illiquid.orderbook.price",
"helpdesk_article_id": "",
"link_message": "",
"link_message_key": ""
}
]
}
}

Create a trade offer V2

This endpoint is responsible for initiating a buy/sell trade offer on behalf of the user.

The request triggers the creation of a trade offer that can later be accepted by the user within its validity (as defined in offer_validity & expires_at response parameters).
The offer includes details such as the asset to be traded, the fiat currency and the amount either in fiat currency or in units of the asset being traded. By accommodating both fiat and asset unit denominations, the user experience is enhanced, catering to a wide range of trading preferences and strategies.

The trade offer response outlines the details of the proposed trade, including: asset, amount, price, fees, preliminary tax calculations if applicable, and any warning messages relevant to the user.

SecuritybearerAuth

Request

header Parameters

bp-user-id

required

string <uuid>

User ID

Request Body schema: application/json

The offer to be created.

type required	string Offer Type Enum: "buy" "sell"
fiat_id required	string <UUID> Fiat UUID
asset_id required	string <UUID> Asset UUID
amount required	string Transaction amount
amount_defined_for required	string Amount defined for Enum: "fiat" "asset"

{"type": "sell",
"fiat_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3b",
"asset_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3c",
"amount": "10",
"amount_defined_for": "fiat"
}

Response samples

application/json

{"data": {"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"type": "sell",
"fiat_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3b",
"asset_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3c",
"fiat_amount": "7.25",
"tax_amount": "2.75",
"total_amount": "10.00",
"asset_amount": "0.00448235",
"asset_price": "2230.97065877",
"net_asset_price": "2259.97327734",
"spread": "0.13000000",
"volume": "10.13",
"offer_validity": 60,
"expires_at": "2021-07-01T18:00:09+03:00",
"time": "2021-07-01T17:59:09+03:00",
"warning": [{"message": "Please keep in mind that if you sell your assets now,you will lose your right to receive dividends for the amount you sell !",
"message_key": "corporate.action.dividend.warning.message.sell",
"helpdesk_article_id": "360020583999",
"link_message": "For further information, please visit our helpdesk.",
"link_message_key": "corporate.action.dividend.warning.link.message"
},
{"message": "Tax withholding provider is not available",
"message_key": "tax.withholding.not.available",
"helpdesk_article_id": "",
"link_message": "",
"link_message_key": ""
},
{"message": "Due to illiquid orderbook price deviates more than 10% to the traded price",
"message_key": "illiquid.orderbook.price",
"helpdesk_article_id": "",
"link_message": "",
"link_message_key": ""
}
]
}
}

[Deprecated] Accept a trade offer

Upon presentation of a trade offer, this endpoint facilitates the user's acceptance of the offer, effectively signalling their agreement to proceed with the trade under the specified conditions. A user can only accept the newest offer created and it can be done within its validity.

When a user submits a request to accept a trade offer, the platform immediately begins to process this request to finalise the trade. However, there are instances when the processing cannot be completed within a short, predefined time frame (e.g. 10 seconds). In such cases, rather than leaving the user uncertain of the request's status, the API responds with a 202 Accepted status code. This response serves as an acknowledgment that the user's request has been successfully received and is in the queue for processing (in progress status), but it has not yet been finalised.

After receiving 202 Accepted, check the offer status using the Offer Status endpoint.

SecuritybearerAuth

Request

path Parameters

Offer-ID

required

string <uuid>

Offer ID

query Parameters

external_transaction_id

required

string

External transaction ID

header Parameters

bp-user-id

required

string <uuid>

User ID

Responses

200

Offer has been accepted

Response Schema: application/json

object

202

Response samples

application/json

{"data": {"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"trade_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"type": "sell",
"fiat_id": 1,
"asset_id": 1,
"fiat_amount": "7.25",
"tax_amount": "2.75",
"total_amount": "10.00",
"asset_amount": "0.00448235",
"asset_price": "2230.97065877",
"time": "2021-07-01T14:56:45+03:00",
"spread": "0.13000000",
"fees_after_cost": "0.10974002",
"warning": [{"message": "Tax withholding provider is not available",
"message_key": "tax.withholding.not.available",
"helpdesk_article_id": "",
"link_message": "",
"link_message_key": ""
}
]
}
}

Accept a trade offer V2

Upon presentation of a trade offer, this endpoint facilitates the user's acceptance of the offer, effectively signalling their agreement to proceed with the trade under the specified conditions. A user can only accept the newest offer created and it can be done within its validity (as defined in offer_validity & expires_at response parameters).

When a user submits a request to accept a trade offer, the platform immediately begins to process this request to finalise the trade. However, there are instances when the processing cannot be completed within a short, predefined time frame (e.g. 10 seconds). In such cases, rather than leaving the user uncertain of the request's status, the API responds with a 202 Accepted status code. This response serves as an acknowledgment that the user's request has been successfully received and is in the queue for processing (in progress status), but it has not yet been finalised.

After receiving 202 Accepted, there are two strategic options to proceed:

Retry sending the same request until you receive a 200 Offer has been accepted status response
Check the offer status using the Offer Status endpoint

SecuritybearerAuth

Request

path Parameters

Offer-ID

required

string <uuid>

Offer ID

query Parameters

external_transaction_id

required

string

External transaction ID

header Parameters

bp-user-id

required

string <uuid>

User ID

Responses

200

Offer has been accepted

Response Schema: application/json

object

202

Response samples

application/json

{"data": {"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"trade_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"type": "sell",
"fiat_id": 1,
"asset_id": 1,
"fiat_amount": "7.25",
"tax_amount": "2.75",
"total_amount": "10.00",
"asset_amount": "0.00448235",
"asset_price": "2230.97065877",
"time": "2021-07-01T14:56:45+03:00",
"spread": "0.13000000",
"fees_after_cost": "0.10974002",
"warning": [{"message": "Tax withholding provider is not available",
"message_key": "tax.withholding.not.available",
"helpdesk_article_id": "",
"link_message": "",
"link_message_key": ""
}
]
}
}

Accept a trade offer V3

Upon presentation of a trade offer, this endpoint facilitates the user's acceptance of the offer, effectively signalling their agreement to proceed with the trade under the specified conditions. A user can only accept the newest offer created and it can be done within its validity (as defined in offer_validity & expires_at response parameters).

When a user submits a request to accept a trade offer, the platform immediately begins to process this request to finalise the trade. However, there are instances when the processing cannot be completed within a short, predefined time frame (e.g. 10 seconds). In such cases, rather than leaving the user uncertain of the request's status, the API responds with a 202 Accepted status code. This response serves as an acknowledgment that the user's request has been successfully received and is in the queue for processing (in progress status), but it has not yet been finalised.

After receiving 202 Accepted, there are two strategic options to proceed:

Retry sending the same request until you receive a 200 Offer has been accepted status response
Check the offer status using the Offer Status endpoint

SecuritybearerAuth

Request

path Parameters

Offer-ID

required

string <uuid>

Offer ID

query Parameters

external_transaction_id

required

string

External transaction ID

header Parameters

bp-user-id

required

string <uuid>

User ID

Responses

200

Offer has been accepted

Response Schema: application/json

object

202

Response samples

application/json

{"data": {"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"trade_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"type": "sell",
"fiat_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3b",
"asset_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3c",
"fiat_amount": "7.25",
"tax_amount": "2.75",
"total_amount": "10.00",
"asset_amount": "0.00448235",
"asset_price": "2230.97065877",
"time": "2021-07-01T14:56:45+03:00",
"spread": "0.13000000",
"fees_after_cost": "0.10974002",
"warning": [{"message": "Tax withholding provider is not available",
"message_key": "tax.withholding.not.available",
"helpdesk_article_id": "",
"link_message": "",
"link_message_key": ""
}
]
}
}

Get a trade offer status

The endpoint retrieves the current status of a specific trade offer, providing information on whether it is created, in progress, finished, or failed, thereby enabling users to monitor and manage their trading activities effectively.

In case of failure, it provides additional details about the error to help users and partners understand and address the issue.

SecuritybearerAuth

Request

path Parameters

Offer-ID

required

string <uuid>

Offer ID

header Parameters

bp-user-id

required

string <uuid>

User ID

Response samples

application/json

{"data": {"status": "failed",
"errors": {"code": "422",
"title": "user.transaction.trading.disabled"
}
}
}

List all non-user initiated transactions per partner or per userDeprecated

This endpoint returns a list of non-user-initiated transactions, categorised as either incoming (from staking rewards and giveaways) or outgoing (from metal storage fees):

Metal storage fees are deducted weekly for users with metal assets
Staking rewards are credited based on staked amounts
Giveaways occur sporadically, typically during marketing campaigns.

Either a date range (date_start and date_end) or a user_id has to be provided to retrieve these transactions.

SecuritybearerAuth

Request

query Parameters

date_start	string <date> Start date for search in Y-m-d format Example: date_start=2020-10-10
date_end	string <date> End date for search in Y-m-d format Example: date_end=2020-10-10
types[]	string Types of the non-user initiated transactions to be include in the result Enum: "metal_storage_fee" "staking_reward" "giveaway" "tax_refund" "deduction" Example: types[]=staking_reward
directions[]	string Directions of the non-user initiated transactions to be include in the result Enum: "incoming" "outgoing" Example: directions[]=incoming
user_id	string <uuid> Search by unique user identifier Example: user_id=2e4c89ac-1290-426f-8de0-4c7b40b91d3a
page_size	integer [ 1 .. 100 ] Number of elements to be displayed on a page Example: page_size=10
page	integer >= 1 Display page number Example: page=1

Responses

200

Non-user initiated transactions collection.

Response Schema: application/json

	Array of objects (NonUserInitiatedTransactions)
	object (PaginationMeta)
	object (PaginationLinks)

application/json

{"data": [{"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"asset_id": 1,
"user_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"type": "metal_storage_fee",
"direction": "incoming",
"amount": "0.00000001",
"related_offer_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"created_at": "2022-07-20T08:14:20+00:00"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

List all non-user initiated transactions per partner or per user V2

This endpoint returns a list of non-user-initiated transactions, categorised as either incoming (from staking rewards and giveaways) or outgoing (from metal storage fees):

Metal storage fees are deducted weekly for users with metal assets
Staking rewards are credited based on staked amounts
Giveaways occur sporadically, typically during marketing campaigns.

Either a date range (date_start and date_end) or a user_id has to be provided to retrieve these transactions.

SecuritybearerAuth

Request

query Parameters

date_start	string <date> Start date for search in Y-m-d format Example: date_start=2020-10-10
date_end	string <date> End date for search in Y-m-d format Example: date_end=2020-10-10
types[]	string Types of the non-user initiated transactions to be include in the result Enum: "metal_storage_fee" "staking_reward" "giveaway" "tax_refund" "deduction" Example: types[]=staking_reward
directions[]	string Directions of the non-user initiated transactions to be include in the result Enum: "incoming" "outgoing" Example: directions[]=incoming
user_id	string <uuid> Search by unique user identifier Example: user_id=2e4c89ac-1290-426f-8de0-4c7b40b91d3a
page_size	integer [ 1 .. 100 ] Number of elements to be displayed on a page Example: page_size=10
page	integer >= 1 Display page number Example: page=1

Responses

200

Non-user initiated transactions collection.

Response Schema: application/json

	Array of objects (NonUserInitiatedTransactionsV2)
	object (PaginationMeta)
	object (PaginationLinks)

application/json

{"data": [{"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"asset_id": 3,
"asset_amount": "0.00000001",
"fiat_id": 1,
"fiat_amount": "0.00075356",
"user_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"type": "metal_storage_fee",
"direction": "incoming",
"related_offer_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"asset_fee": "0.00005356",
"type_defined_for": "asset",
"created_at": "2022-07-20T08:14:20+00:00"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

TradeDetails

Response Schema: application/json

Array of objects

get/v2/trades/details/{Trade-ID}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"id": "abcc89ac-1290-426f-8de0-4c7b40b91d3a",
"user_id": "abcc89ac-1290-426f-8de0-4c7b40b91d3b",
"type": "buy",
"status": "finished",
"initiated_by": "user",
"fiat_id": "abcc89ac-1290-426f-8de0-4c7b40b91d3c",
"asset_id": "abcc89ac-1290-426f-8de0-4c7b40b91d3d",
"fiat_amount": "1.89",
"asset_amount": "0.00060120",
"tax_amount": "0.10",
"total_amount": "1.99",
"asset_price": "11278.15044158",
"created_at": "2022-09-30T14:56:45+03:00",
"time": "2022-09-30T14:56:45+03:00",
"external_transaction_id": "abc-ext-123-123",
"fiat_symbol": "EUR",
"asset_symbol": "BTC",
"gross_fee": "11278.15044158",
"taxable_amount": "1.99",
"capital_gain": "1.99",
"fees_after_cost": "0.08382600",
"final_revenue_share": "0.03112233",
"error": {"error_code": "insufficient.wallet.balance",
"error_message": "Not enough funds to execute the trade."
}
}
}

Corporate Actions

List all corporate actions per partner or per user

This endpoint returns a list of corporate actions specific for stock assets for a partner within a specified date range, from start_date to end_date, limited to a maximum period of 31 days, with an option to filter results by user.

SecuritybearerAuth

Request

query Parameters

date_start required	string/([\d]{4})-(?:[\d]{2})-([\d]{2})(\s[\d]{2}:[\... Corporate Actions start date. Example: date_start=2021-01-31 17:30
date_end required	string/([\d]{4})-(?:[\d]{2})-([\d]{2})(\s[\d]{2}:[\... Corporate Actions end date. It needs to be after start_date and the period should be less than 1 month Example: date_end=2021-01-31 17:30
actions[]	Array of strings Corporate Action Items Enum: "delisting" "dividend" "merger_cash" "merger_stock" "reverse_stock_split" "stock_split" "spin_off" Example: actions[]=dividend
type	string Filter Actions by Type Enum: "payout" "subtract" "both" Example: type=payout
page_size	integer >= 1 Number of elements to be displayed on a page Example: page_size=10
page	integer >= 1 Display page number Example: page=1
user_id	string <uuid> Filter corporate actions for a specific User ID Example: user_id=2e4c89ac-1290-426f-8de0-4c7b40b91d3a
ca_id	string <uuid> Corporate Action ID Example: ca_id=1e3d89ac-1234-426f-8de0-4a6b40b91d33

Responses

200

List user corporate actions

Response Schema: application/json

	Array of objects (CorporateActions)
	object
	object

application/json

{"data": [{"id": "12c34f56-1234-abca-1efa-12379349f123",
"ca_id": "12c34f56-1234-abca-1efa-12379349f123",
"action": "dividend",
"user_id": "12c34f56-1234-abca-1efa-12379349f123",
"type": "payout",
"defined_for": "asset",
"asset_id": 1,
"asset_symbol": "BTC",
"asset_amount": "12.00220000",
"fiat_id": 1,
"fiat_symbol": "EUR",
"fiat_amount": "122.00000000",
"credited_at": "2021-07-01T14:56:45+03:00"
}
],
"meta": {"total_count": 100,
"page": 1,
"page_size": 10
},
"links": {"next": "/v1/trades/corporate-actions/search?page_size=10&page=3",
"previous": "/v1/trades/corporate-actions/search?page_size=10&page=1",
"self": "/v1/trades/corporate-actions/search?page_size=10&page=1"
}
}

Operational Transactions

Corporate action details

Retrieve details for corporate actions based on the provided ID

SecuritybearerAuth

Request

path Parameters

id

required

string <uuid>

Unique identifier for corporate action allocated to the user

header Parameters

bp-user-id

required

string <uuid>

User ID

Responses

200

Get corporate action details

Response Schema: application/json

object

401

Unauthorized

Response Schema: application/json

Array of objects

404

Transaction not found

Response Schema: application/json

Array of objects

500

Error

Response Schema: application/json

Array of objects

get/v1/corporate-actions/{id}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

200
401
404
500

application/json

{"data": {"id": "12c34f56-1234-abca-1efa-12379349f123",
"corporate_action_id": "12c34f56-1234-abca-1efa-12379349f123",
"action": "dividend",
"type_defined_for": "asset",
"direction": "incoming",
"credited_at": "2024-12-15T09:00:01+01:00",
"asset": {"id": "9a8e2316-c808-4ae2-bc67-110d372f94e4",
"amount": "0.62",
"price": "83.19"
},
"fiat": {"id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"amount": "1.89"
}
}
}

Non-user initiated transaction details

Retrieve details for non-user initiated transactions based on the provided ID

SecuritybearerAuth

Request

path Parameters

id

required

string <uuid>

Unique identifier for the NUIT allocated to the user

header Parameters

bp-user-id

required

string <uuid>

User ID

Responses

200

Get non user initiated transaction details

Response Schema: application/json

object

401

Unauthorized

Response Schema: application/json

Array of objects

404

Transaction not found

Response Schema: application/json

Array of objects

500

Error

Response Schema: application/json

Array of objects

get/v1/non-user-initiated-transactions/{id}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

200
401
404
500

application/json

{"data": {"id": "1effa8d8-2ef7-6c06-81e5-334cabffcd28",
"type": "giveaway",
"type_defined_for": "asset",
"direction": "incoming",
"created_at": "2024-12-15T09:00:01+01:00",
"asset": {"id": "9a8e2316-c808-4ae2-bc67-110d372f94e4",
"amount": "0.62"
},
"fiat": {"id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"amount": "1.89"
}
}
}

Crypto action detailsDeprecated

Retrieve details for crypto actions based on the provided ID.

SecuritybearerAuth

Request

path Parameters

id

required

string <uuid>

Unique identifier for crypto action allocated to the user

header Parameters

bp-user-id

required

string <uuid>

User ID

Responses

200

Get crypto action details

Response Schema: application/json

object

401

Unauthorized

Response Schema: application/json

Array of objects

404

Transaction not found

Response Schema: application/json

Array of objects

500

Error

Response Schema: application/json

Array of objects

get/v1/crypto-actions/{id}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

200
401
404
500

application/json

{"data": {"id": "12c34f56-1234-abca-1efa-12379349f123",
"crypto_action_id": "12c34f56-1234-abca-1efa-12379349f123",
"type": "merger_crypto",
"type_defined_for": "asset",
"direction": "incoming",
"credited_at": "2024-12-15T09:00:01+01:00",
"asset": {"id": "9a8e2316-c808-4ae2-bc67-110d372f94e4",
"amount": "0.62",
"price": "83.19"
},
"fiat": {"id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"amount": "1.89"
}
}
}

Operational Transactions V2

Crypto action details V2

Retrieve details for crypto actions based on the provided ID.

SecuritybearerAuth

Request

path Parameters

id

required

string <uuid>

Unique identifier for crypto action allocated to the user

header Parameters

bp-user-id

required

string <uuid>

User ID

Responses

200

Get crypto action details

Response Schema: application/json

object

401

Unauthorized

Response Schema: application/json

Array of objects

404

Transaction not found

Response Schema: application/json

Array of objects

500

Error

Response Schema: application/json

Array of objects

get/v2/crypto-actions/{id}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

200
401
404
500

application/json

{"data": {"id": "12c34f56-1234-abca-1efa-12379349f123",
"type": "merger_crypto",
"credited_at": "2024-12-15T09:00:01+01:00",
"transactions": [{"id": "12c34f56-1234-abca-1efa-12379349f123",
"type_defined_for": "asset",
"direction": "outgoing",
"asset": {"id": "1ef135f0-440b-6304-8c10-6b2e5a069bd0",
"amount": "1817.55314307"
},
"fiat": {"id": "ea895d94-edee-11eb-9bf0-06502b1fe55d",
"amount": "123.29"
}
},
{"id": "ff30827b-cf70-485f-b302-1d9dd6968a0a",
"type_defined_for": "asset",
"direction": "incoming",
"asset": {"id": "1ef135f0-440b-6304-8c10-6b2e5a069bd1",
"amount": "100.012"
},
"fiat": {"id": "ea895d94-edee-11eb-9bf0-06502b1fe55d",
"amount": "123.29"
}
}
]
}
}

Portfolio

Returns the list of owned assets

The endpoint returns the fiat equivalent of user's assets. For example, as a user I have 2.5 ETH, so the endpoint will return how much is my ETH asset worth (e.g. fiat_balance 1000.34). Depending on the passed fiat_id, the amount will be returned in the corresponding currency. Asset balance for a given asset is the sum of its available balance and staked balance.

SecuritybearerAuth

Request

path Parameters

fiatId

required

integer <int32>

header Parameters

bp-user-id

required

string <uuid>

get/v1/portfolio/groups/overview/fiats/{fiatId}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"asset_group": "coin",
"asset_count": 1,
"total_fiat_balance": "5891.91739815",
"total_return_percent": "9.87"
}
]
}

Portfolio performance based on timeframe

The endpoint returns how user’s portfolio has changed in the selected time period (daily/weekly/monthly/yearly).

SecuritybearerAuth

Request

path Parameters

fiatId required	integer <int32>
period required	string Specifies the performance window. Example: period=max (up to 5 years of data—2-day intervals for ≤ 1 year, then weekly intervals anchored to Sunday 00:00 UTC; all points at 00:00 UTC) Enum: "day" "week" "month" "6m" "year" "max"

header Parameters

bp-user-id

required

string <uuid>

assetId required	integer <int32>
fiatId required	integer <int32>

header Parameters

bp-user-id

required

string <uuid>

Array of objects

get/v1/portfolio/assets/{assetId}/fiats/{fiatId}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"total_return": "-5.23",
"total_invested": "100.00",
"average_buy_price": "57.75684575",
"fiat_balance": "94.77",
"asset_balance": "1.73139649",
"daily_return": "-0.77",
"daily_return_percent": "-0.81",
"current_asset_price": "54.73815655",
"total_return_percent": "-5.23",
"staked_balance": "5.12351293",
"staked_balance_percent": "1.23",
"fiat_total_staked_amount": "5496.06358700"
}
}

Returns the list of owned assets

The endpoint returns the fiat equivalent of user's assets. For example, as a user I have 2.5 ETH, so the endpoint will return how much is my ETH asset worth (e.g. fiat_balance 1000.34). Depending on the passed fiat_id, the amount will be returned in the corresponding currency. Asset balance for a given asset is the sum of its available balance and staked balance.

SecuritybearerAuth

Request

path Parameters

fiatId

required

string <uuid>

header Parameters

bp-user-id

required

string <uuid>

get/v2/portfolio/groups/overview/fiats/{fiatId}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"asset_group": "coin",
"asset_count": 1,
"total_fiat_balance": "5891.91739815",
"total_return_percent": "9.87"
}
]
}

Portfolio performance based on timeframe

The endpoint returns how user’s portfolio has changed in the selected time period (daily/weekly/monthly/yearly).

SecuritybearerAuth

Request

path Parameters

fiatId required	string <uuid>
period required	string Specifies the performance window. Example: period=max (up to 5 years of data—2-day intervals for ≤ 1 year, then weekly intervals anchored to Sunday 00:00 UTC; all points at 00:00 UTC) Enum: "day" "week" "month" "6m" "year" "max"

header Parameters

bp-user-id

required

string <uuid>

assetId required	string <uuid>
fiatId required	string <uuid>

header Parameters

bp-user-id

required

string <uuid>

Array of objects

get/v2/portfolio/assets/{assetId}/fiats/{fiatId}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"total_return": "-5.23",
"total_invested": "100.00",
"average_buy_price": "57.75684575",
"fiat_balance": "94.77",
"asset_balance": "1.73139649",
"daily_return": "-0.77",
"daily_return_percent": "-0.81",
"current_asset_price": "54.73815655",
"total_return_percent": "-5.23",
"staked_balance": "5.12351293",
"staked_balance_percent": "1.23",
"fiat_total_staked_amount": "5496.06358700"
}
}

Settlement

List all available fiats per partner

This endpoint retrieves a list of all fiat currencies available in the Partner's application, as initially configured. Additionally, it provides the current fiat balance based on user transactions and settlement activities.

SecuritybearerAuth

Request

query Parameters

page_size	integer >= 1 Number of elements to be displayed on a page Example: page_size=10
page	integer >= 1 Display page number Example: page=1

Responses

200

List fiats

Response Schema: application/json

	Array of objects (Fiat)
	object (PaginationMeta)
	object (PaginationLinks)

application/json

{"data": [{"id": 1,
"symbol": "EUR",
"balance": "50000.00000000",
"time": "2021-07-20T12:30:00+02:00"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Create a settlement deposit

Availability of this endpoint may vary based on the settlement process agreed upon between Bitpanda and its partners.

This endpoint is designed for partners to notify us before making a bank deposit, essentially a promise for payment. Upon receiving the notification, Bitpanda will create a pending deposit. Once the receipt of the deposit is confirmed, it will be updated to finished state.

SecuritybearerAuth

Request

Request Body schema: application/json

Transaction details

fiat_symbol required	string
reference required	string The unique 10-digit code that is used to make payments between the Partner and Bitpanda
amount required	string Deposit amount containing max 24 digits for the integer part and 8 digits for the fractional part
sepa_type	string Enum: "instant" "classic"

Array of objects

post/v1/deposit

Request samples

application/json

{"fiat_symbol": "EUR",
"reference": "1638305327-test-deposit",
"amount": "123.45",
"sepa_type": "classic"
}

Response samples

application/json

{"data": {"pid": "a5caa443-831b-4b07-8db6-cb4577aca298",
"amount": "123.12345678",
"state": "pending",
"type": "deposit",
"domain": "b2b2c",
"fiat_symbol": "EUR",
"payment_reference": "1638305327",
"created_at": "2022-01-21T10:51:22+01:00"
}
}

Update the fiat stock

Availability of this endpoint may vary based on the settlement process agreed upon between Bitpanda and its partners.

This is only applicable for the settlement type where fiat money is transferred between users’ and Bitpanda’s bank accounts every time users trade. The partner will use this endpoint to notify Bitpanda about any new bank transfer of fiat money related to a transaction.

SecuritybearerAuth

Request

Request Body schema: application/json

Request details

reference required	string <uuid> The reference that is used to make the payment. Reference shall have the same value as the id of a successful trade or the same value as the id of a tax refund in order to be reflected in the settlement
transaction_id	string <uuid> Bitpanda offer_id (trade_id), to which the bank transfer relates
amount required	string
currency required	string
balance_after	string The account balance immediately following a transaction. It reflects the total available funds after the transaction has been processed.
status required	string Value: "finished"
direction required	string For Buy trades the expected direction is Debit. The amount in the Partner's corporate wallet will be increased with the amount in the settlement transaction. For Sell trades, the expected direction is Credit. The amount in the Partner's corporate wallet will be decreased with the amount in the settlement transaction. Enum: "debit" "credit" "refund"
timestamp	string

Array of objects

post/v1/fiat-stock

Request samples

application/json

{"reference": "ca9d287e-6e2f-4ac5-9e8f-eedfa5aa2db5",
"transaction_id": "a5caa443-831b-4b07-8db6-cb4577aca298",
"amount": "123.45",
"currency": "EUR",
"balance_after": "22.46",
"status": "finished",
"direction": "debit",
"timestamp": "2022-03-07T11:08:06+01:00"
}

Response samples

application/json

{"data": {"pid": "a5caa443-831b-4b07-8db6-cb4577aca298",
"amount": "123.45",
"status": "finished",
"type": "deposit",
"currency": "EUR",
"reference": "ca9d287e-6e2f-4ac5-9e8f-eedfa5aa2db5",
"created_at": "2022-01-21T10:51:22+01:00"
}
}

List all settlement transactions per partner

The endpoint returns a list of all settlement transactions for a partner over a specified date range, from date_start to date_end, with the search period limited to a maximum of 31 days.

SecuritybearerAuth

Request

query Parameters

date_start required	string Start date for search in Y-m-d or Y-m-d H:i:s formats Examples: Only date date_start=2021-04-25 Date with time date_start=2021-04-25 13:45:00
date_end required	string End date for search in Y-m-d or Y-m-d H:i:s formats Examples: Only date date_end=2021-06-25 Date with time date_end=2021-06-25 13:45:00
page_size	integer [ 1 .. 100 ] Default: 10 Number of elements to be displayed on a page Example: page_size=10
page	integer >= 1 Default: 1 Display page number Example: page=1
order	string Default: "desc" Order by creation date Enum: "asc" "desc" Example: order=asc
type	string Type Enum: "deposit" "withdrawal" Example: type=deposit
payment_reference	string Payment reference

Responses

200

List settlement transactions that match the search query parameters

Response Schema: application/json

	Array of objects (TransactionSearch)
	object (PaginationMeta)
	object (PaginationLinks)

application/json

{"data": [{"pid": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"amount": "25000.00000000",
"state": "pending",
"type": "withdrawal",
"fiat_id": 1,
"fiat_symbol": "EUR",
"payment_reference": "string",
"created_at": "2021-07-01T14:56:45+03:00"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Reports

Get all available report types per user

Retrieve a list of all report types available for the user, currently available tax reports and account statements.

SecuritybearerAuth

Request

header Parameters

bp-user-id

required

string <uuid>

User ID

Responses

200

Get all available report types per user

Response Schema: application/json

data	Array of strings List of available report types for the user

get/v1/reports/user-reports/types

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": ["crypto-tax",
"account-statement",
"xpct"
]
}

Get all generated reports per user

Retrieve all generated reports (tax reports, account statements) for a user.

SecuritybearerAuth

Request

query Parameters

type	string Type of report (e.g. crypto-tax) Example: type=crypto-tax
before	string Cursor value to start paginating from Example: before=MjAyNC0xMC0yMlQyMjozODoxN1o=
after	string Cursor value to start paginating after Example: after=MjAyNC0xMC0yMlQyMjozODoxN1o=
page_size	integer Number of reports to display per page Example: page_size=10

header Parameters

bp-user-id

required

string <uuid>

User ID

Responses

200

List of generated reports for the user

Response Schema: application/json

start_cursor	string or null Cursor pointing to the start of the page
end_cursor	string or null Cursor pointing to the end of the page
has_next_page	boolean Indicates if there is a next page
has_previous_page	boolean Indicates if there is a previous page
page_size	integer Number of items per page
	Array of objects

get/v1/reports/user-reports

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"start_cursor": "MjAyNC0xMC0yMlQyMjozODoxN1o=",
"end_cursor": "MjAyNC0xMC0yMlQyMjozODoxN1o=",
"has_next_page": true,
"has_previous_page": false,
"page_size": 5,
"items": [{"meta": {"cursor": "MjAyNC0xMC0yMlQyMjozODoxN1o="
},
"data": {"id": "7e45651c-fba7-459f-a55b-9bccef67e570",
"display_name": "2024 Report",
"type": "crypto-tax",
"created_at": "2022-08-01T00:00:00+00:00",
"trigger": "schedule"
}
}
]
}

Create Account Statement Report

Generates a detailed Account Statement Report for a specified date range.

The report includes account transactions, balances, and related financial activity within the requested period. This endpoint can be used for auditing, reconciliation, or personal record-keeping purposes.

Once the report is generated, the response will include a temporary download link and its expiry timestamp.
The link remains valid only until the expiry time — after which a new report request must be submitted to obtain a fresh link.

Usage notes:

The from and to fields define the reporting period; the to date must not precede the from date.

SecuritybearerAuth

Request

header Parameters

bp-user-id

required

string <uuid>

User ID

Request Body schema: application/json

The Create report request body.

from required	string <date> Start date of the reporting period in `YYYY-MM-DD` format. Must be earlier than or equal to the `to` date.
to required	string <date> End date of the reporting period in `YYYY-MM-DD` format. Must be later than or equal to the `from` date.

Array of objects

post/v1/reports/user-reports

Request samples

application/json

{"from": "2025-01-01",
"to": "2025-12-31"
}

Response samples

application/json

{"data": {"id": "7e45651c-fba7-459f-a55b-9bccef67e570",
"type": "account-statement",
"display_name": "2025 Report",
"created_at": "2025-08-01T00:00:00+00:00",
"download_link": "https://www.bitpanda.com/2025-report",
"download_link_expiry_date": "2022-08-01T00:00:00+00:00",
"trigger": "schedule"
}
}

Download a specific report

Download a specific report, including tax reports, or account statements. Note: The download link returned by this endpoint is only effective for a limited time. The response includes an expiry timestamp, and the report must be downloaded before this timestamp expires. After the expiry, a new request may be required to generate a fresh download link.

SecuritybearerAuth

Request

path Parameters

reportId

required

string <uuid>

Unique identifier of the report to be downloaded

Example: 7e45651c-fba7-459f-a55b-9bccef67e570

header Parameters

bp-user-id

required

string <uuid>

User ID

Response samples

application/json

{"data": {"id": "7e45651c-fba7-459f-a55b-9bccef67e570",
"type": "crypto-tax",
"display_name": "2025 Report",
"created_at": "2025-08-01T00:00:00+00:00",
"download_link": "https://www.bitpanda.com/2025-report",
"download_link_expiry_date": "2022-08-01T00:00:00+00:00",
"trigger": "schedule"
}
}

Files

Upload a file

Use this endpoint to upload user related files. When a file is uploaded, an id will be returned, which shall be used as a reference to a file in other user related endpoints, e.g. when creating or updating user or sending additional verification files. A validation, based on the file purpose and the MIME type is performed. The filename must be minimum 3 characters long and maximum 255 characters long. The filename cannot start with "." (dot). The file should have a minimum of 15 bytes, and a maximum of 200 megabytes.

proof_of_address should be use to upload files used as evidence of the permanent residential address of a natural person, such as:

Electricity or Water Bill
Other Authority Bill
Landline Bill
Lease Agreement
Bank or Credit Card Statement
Empower Bill Statement
Bank Reference Letter or Educational Institutions Reference Letters
Mortgage Agreement

The following combinations are permitted:

verification_report (application/pdf, application/json)
idcard_both_sides (image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)
idcard_front (image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)
idcard_back (image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)
paper_id (image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)
passport (image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)
driving_licence (image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)
residence_permit (image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)
selfie_video (video/*)
proof_of_address (image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)
other (application/pdf , image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif* , video/*)

SecuritybearerAuth

Request

Request Body schema: multipart/form-data

The file to be uploaded.

purpose	string The purpose of the file Enum: "driving_licence" "idcard_back" "idcard_both_sides" "idcard_front" "other" "paper_id" "passport" "residence_permit" "selfie_video" "verification_report" "proof_of_address"
file	string <binary> The file content

Array of objects

post/v1/files

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"id": "f31f3c22-e7ea-11ec-8fea-0242ac120002",
"name": "user_verification.pdf",
"type": "application/pdf",
"size": 25,
"purpose": "verification_report",
"url": "/v1/files/f31f3c22-e7ea-11ec-8fea-0242ac120002/contents",
"created_at": "2022-07-20T08:14:20+00:00"
}
]
}

Get file contents

This endpoint fetches the contents of a file (download). Not that user files containing PII data cannot be downloaded, in this case 403 Forbidden will be returned.

SecuritybearerAuth

Request

path Parameters

File-ID

required

string <uuid>

Responses

200

Returns the contents of the file (download)

Response Schema: application/octet-stream

File-ID

required

string <uuid>

Response samples

application/json

{"data": [{"id": "f31f3c22-e7ea-11ec-8fea-0242ac120002",
"name": "user_verification.pdf",
"type": "application/pdf",
"size": 25,
"purpose": "verification_report",
"url": "/v1/files/f31f3c22-e7ea-11ec-8fea-0242ac120002/contents",
"created_at": "2022-07-20T08:14:20+00:00"
}
]
}

Staking

Get staking overview

This endpoint provides an overview of total staked amounts and rewards for a given user, aggregated both:

By asset (in asset units and converted fiat value).
As a total sum across all assets in the requested fiat currency.

It supports date-range filtering and asset filtering, allowing partners to query historical or specific subsets of staked amounts and rewards.

Keep in mind that since the staked amount is a point-in-time value, it reflects the amount staked as of the end date (or the most recent data if no end date is provided).

SecuritybearerAuth

Request

path Parameters

fiatSymbol

required

string = 3 characters

Example: EUR

query Parameters

start_date	string <date> Optional filter: start date (inclusive) in `YYYY-MM-DD`. Ignored for point-in-time staking amounts. If omitted, rewards are calculated from the beginning of available history. Example: start_date=2025-01-01
end_date	string <date> Optional filter: end date (inclusive) in `YYYY-MM-DD`. If omitted, staking amounts and rewards are calculated up to the most recent available data. Example: end_date=2025-01-31
asset_ids[]	Array of strings <uuid> Optional filter: one or more asset IDs. If provided, only totals and rewards for these assets are returned. If omitted, staking amounts and rewards for all assets are included. Non-existent asset IDs are ignored; invalid UUIDs will cause a validation error. Example: asset_ids[]=32b6f7de-1a71-4b8c-9d8a-1234567890ab&asset_ids[]=9f8d7c3e-2b33-41d2-bc99-abcdef123456

header Parameters

bp-user-id

required

string <uuid>

Responses

200

Success Response

Response Schema: application/json

	Array of objects List of aggregated staking amounts and rewards per asset.
	object

application/json

{"data": [{"asset_id": "1ed76f61-37e9-6ef0-b0c1-529adbc40ff6",
"rewards_asset": "123.45678900",
"rewards_fiat": "789.01",
"staked_asset": "123.45678900",
"staked_fiat": "789.01"
}
],
"meta": {"total_rewards_fiat": "789.01",
"total_staked_fiat": "789.01"
}
}

Get bonded overview

This endpoint provides an overview of bonded (locked) assets following an unstake action for assets that have a defined bonding period.

It returns aggregated data both:

Per asset — including the bonded amount (in asset units) and its corresponding fiat value.
Across all assets — showing the total bonded value in the requested fiat currency.

The endpoint also supports asset filtering, allowing partners to query specific subsets of bonded assets after unstaking.

SecuritybearerAuth

Request

path Parameters

fiatSymbol

required

string = 3 characters

Fiat currency symbol in ISO 4217 (3-letter) format.

Example: EUR

query Parameters

asset_ids[]

Array of strings <uuid>

Optional filter: one or more asset IDs.
If provided, only bonded amounts for these assets are returned.
If omitted, bonded amounts for all assets are included.
Non-existent PIDs are ignored but invalid UUIDs will cause a validation error.

Example: asset_ids[]=32b6f7de-1a71-4b8c-9d8a-1234567890ab&asset_ids[]=9f8d7c3e-2b33-41d2-bc99-abcdef123456

header Parameters

bp-user-id

required

string <uuid>

The unique identifier of the user whose bonded staking overview is being requested.

Responses

200

Success Response

Response Schema: application/json

	Array of objects List of bonded (locked) assets grouped by asset after unstake.
	object

application/json

{"data": [{"asset_id": "ea8962d5-edee-11eb-9bf0-06502b1fe55d",
"items": [{"asset_amount": "1.00000000",
"fiat_amount": "3750.77",
"release_date": "2022-11-12T13:07:31+00:00"
}
]
}
],
"meta": {"total_bonded_fiat": "30006.16"
}
}

Stake a crypto assetDeprecated

The endpoint enables users to lock a specified amount of cryptocurrency into a staking process in which participants in a network earn rewards by locking their coins into cryptocurrency wallets to validate network transactions or to supply liquidity to others. This endpoint accepts parameters such as the asset and the amount of crypto asset to stake and returns confirmation of the staking transaction along with details like the next expected reward date.

SecuritybearerAuth

Request

header Parameters

bp-user-id required	string <uuid>
idempotency-key required	string <= 128 characters A unique identifier for the stake request. The asset is only staked once regardless of how many requests are made for the same user and with the same idempotency key. Example: lorem ipsum

Request Body schema: application/json

The unstake action details.

asset_id required	integer Asset Id
amount required	string <double> The amount to be staked.

{"asset_id": 1,
"amount": "1.99"
}

Response samples

application/json

{"data": {"id": "1ed76f61-37e9-6ef0-b0c1-529adbc40ff6",
"asset_id": 1,
"amount": "1.99",
"type": "stake",
"balance_after": "100.99",
"created_at": "2022-11-11T13:07:31+00:00",
"next_reward_at": "2022-11-11T13:07:31+00:00"
}
}

Unstake a crypto assetDeprecated

The endpoint allows users to retrieve their previously staked cryptocurrency from the network, specifying parameters such as the staking identifier, the asset and the amount to unstake, and returns details of the unstaking transaction.

SecuritybearerAuth

Request

header Parameters

bp-user-id required	string <uuid>
idempotency-key required	string <= 128 characters A unique identifier for the stake request. The asset is only staked once regardless of how many requests are made for the same user and with the same idempotency key. Example: lorem ipsum

Request Body schema: application/json

The unstake action details.

asset_id required	integer Asset Id
amount required	string <double> The amount to be unstaked.

Array of objects

post/v1/staking/unstake

Request samples

application/json

{"asset_id": 1,
"amount": "1.99"
}

Response samples

application/json

{"data": {"id": "1ed77d61-c808-64f6-b076-f20f2d407427",
"asset_id": 1,
"amount": "1.99",
"type": "unstake",
"balance_after": "100.99",
"release_date": "2022-11-12T13:07:31+00:00",
"created_at": "2022-11-11T13:07:31+00:00"
}
}

List all staking actions per userDeprecated

This endpoint retrieves a comprehensive list of all staking actions for a specific user.

SecuritybearerAuth

Request

query Parameters

date_start	string <date> Start date for search in Y-m-d format Example: date_start=2022-12-01
date_end	string <date> End date for search in Y-m-d format Example: date_end=2022-12-31
type[]	Array of strings Search for one or more staking actions types Items Enum: "stake" "unstake" "reward" Example: type[]=stake&type[]=unstake
page_size	integer Number of elements to be displayed on a page Example: page_size=10
page	integer Display page number Example: page=1

header Parameters

bp-user-id

required

string <uuid>

Responses

200

Success Response

Response Schema: application/json

	Array of objects (SearchResponse)
	object (PaginationMeta)
	object (PaginationLinks)

application/json

{"data": [{"id": "1ed76f61-37e9-6ef0-b0c1-529adbc40ff6",
"asset_id": 1,
"amount": "1.99000000",
"type": "stake",
"balance_after": "100.99000000",
"asset_fee": "0.00005356",
"release_date": null,
"created_at": "2022-11-11T13:07:31+00:00"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

List all staking actions per user V2

This endpoint retrieves a comprehensive list of all staking actions for a specific user.

SecuritybearerAuth

Request

query Parameters

id	string <uuid> Filters results by a specific staking action ID, allowing retrieval of a particular action. Example: id=e69f4b1c-e3d7-4e5f-8561-4a6c09441097
asset_id	string <uuid> Filters staking actions by a specific asset id, such as BTC or ETH, identified by the asset’s UUID. Example: asset_id=1ed83487-f684-62a2-a155-fe633f0db292
asset_int	integer >= 1 Deprecated Filters staking actions by a specific asset id (integer value), such as BTC or ETH, identified by the asset’s UUID. Example: asset_int=1
type[]	Array of strings Search for one or more action types. Items Enum: "stake" "unstake" "reward" Example: type[]=stake&type[]=unstake&type[]=reward
size	integer Number of elements to be displayed on a page. Example: size=25
direction	string Specifies the direction of the results, based on the transaction ID as cursor. Use `before` to get results before a specific ID or `after` to get results after a specific ID. This provides flexibility in how results are displayed relative to the cursor. Enum: "before" "after"
cursor	string <uuid> A cursor for use in pagination. The cursor represents a staking action ID that defines your place in the list. Example: cursor=1ed804ad-41e9-6fc2-bf32-1e7e399643fb

header Parameters

bp-user-id

required

string <uuid>

Responses

200

Success Response

Response Schema: application/json

	Array of objects (SearchV2Response)
	object (PaginationMetaV2)

application/json

{"data": [{"id": "1ed76f61-37e9-6ef0-b0c1-529adbc40ff6",
"asset_id": "ea8962d5-edee-11eb-9bf0-06502b1fe55d",
"asset_int": 5,
"status": "success",
"asset_amount": "1.99000000",
"asset_fee": "0.00005356",
"type": "reward",
"asset_balance_after": "100.99000000",
"release_date": null,
"created_at": "2022-11-11T13:07:31+00:00"
}
],
"meta": {"size": 10
}
}

Stake a crypto asset V2

The endpoint enables users to lock a specified amount of cryptocurrency into a staking process in which participants in a network earn rewards by locking their coins into cryptocurrency wallets to validate network transactions or to supply liquidity to others. This endpoint accepts parameters such as the asset and the amount of crypto asset to stake and returns confirmation of the staking transaction along with details like the next expected reward date.

SecuritybearerAuth

Request

header Parameters

bp-user-id required	string <uuid>
idempotency-key required	string <= 128 characters A unique identifier for the stake request. The asset is only staked once regardless of how many requests are made for the same user and with the same idempotency key. Example: lorem-ipsum

Request Body schema: application/json

The unstake action details.

asset_id required	string <uuid> Asset ID
amount required	string <double> The amount to be staked.

{"asset_id": "b86c113a-efe3-11eb-b56f-0691764446a7",
"amount": "1.99"
}

Response samples

application/json

{"data": {"id": "1ed76f61-37e9-6ef0-b0c1-529adbc40ff6",
"asset_id": "b86c113a-efe3-11eb-b56f-0691764446a7",
"amount": "1.99",
"type": "stake",
"balance_after": "100.99",
"created_at": "2022-11-11T13:07:31+00:00",
"next_reward_at": "2022-11-11T13:07:31+00:00"
}
}

Unstake a crypto asset V2

The endpoint allows users to retrieve their previously staked cryptocurrency from the network, specifying parameters such as the staking identifier, the asset and the amount to unstake, and returns details of the unstaking transaction.

SecuritybearerAuth

Request

header Parameters

bp-user-id required	string <uuid>
idempotency-key required	string <= 128 characters A unique identifier for the stake request. The asset is only staked once regardless of how many requests are made for the same user and with the same idempotency key. Example: lorem-ipsum

Request Body schema: application/json

The unstake action details.

asset_id required	string <uuid> Asset ID
amount required	string <double> The amount to be unstaked.

Array of objects

post/v2/staking/unstake

Request samples

application/json

{"asset_id": "b86c113a-efe3-11eb-b56f-0691764446a7",
"amount": "1.99"
}

Response samples

application/json

{"data": {"id": "1ed77d61-c808-64f6-b076-f20f2d407427",
"asset_id": "b86c113a-efe3-11eb-b56f-0691764446a7",
"amount": "1.99",
"type": "unstake",
"balance_after": "100.99",
"release_date": "2022-11-12T13:07:31+00:00",
"created_at": "2022-11-11T13:07:31+00:00"
}
}

Get a staking action statusDeprecated

Use this endpoint to verify the status of a previously created staking transaction and see if it is pending, successful or failed.

SecuritybearerAuth

Request

path Parameters

id

required

string <uuid>

Staking Action ID

Example: 1ed76f61-37e9-6ef0-b0c1-529adbc40ff6

header Parameters

bp-user-id

required

string <uuid>

Response samples

application/json

{"data": [{"status": "pending"
}
]
}

Events

List all notification events per partner

This endpoint allows partners to consume notification events without exposing their endpoints to external access. This pattern provides a more granular control over the error handling and retries for a better management of failed notifications.

Notification events endpoint operates synchronously, meaning latency and performance impact especially for the high-volume or time-sensitive notifications, thus we strongly recommend using webhooks as it is less resource-intensive.

Payload examples for available types:

user.update
```
{"action":"verification","success":true,"timestamp":1671529439,"user_id":"1ed804ad-349c-61f8-a53d-826724196664"}
```
For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

user.corporate-action

{"id":"1ed9020e-35f5-62ac-b802-369ecc33bc49","time":"2023-01-09T14:26:33+01:00","type":"dividend","ca_id":"1ed901d6-4c21-6676-86e7-e6645454d14d","fiat_id":1,"asset_id":397,"fiat_symbol":"EUR","asset_amount":"0.18876873","asset_symbol":"BAYN","user_id":"1ed7aabf-3bfb-6bb2-8821-8626d6ed9c94"}

For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

user.non-user-initiated-tx

{"id":"1ed91009-a537-6fd0-a7bb-2eba2834ba6e","user_id":"1ed8b508-67a6-6722-99f3-f2ef672bfa54","asset_id":5,"asset_amount":"0.05465497","type":"staking_reward","direction":"incoming","created_at":"2023-01-10T16:05:29+00:00"}

For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

user.non-user-initiated-tx-v2

  {"id":"abcd1234-12ab-ab12-abcdef123456","user_id":"abcd1234-12ab-ab12-abcdef123456","asset_id":1,"fiat_id":1,"fiat_amount":"323000.78000000","asset_amount":"0.46987983466586","related_offer_id":"abcc89ac-1290-426f-8de0-4c7b40b91d3a","type":"giveaway","type_defined_for":"asset","direction":"incoming","created_at":"2024-01-09T13:08:00Z"}

For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

account.send-money

{"id":"1ed80ed8-3393-64ca-ba25-46e31c542a97","trade_id":77356859,"reference":"bitpanda-63a294cf86761-transfer","timestamp":1671599311,"amount_sent":"5.00000000","fiat_symbol":"EUR","fiat_balance":"734651.06000000"}

For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

account.send-money-success

{"id":"614c7a22-5abd-4511-aa99-5b3557e92e51","type":"withdrawal","reference":"bitpanda-62e9ba8a60608-transfer","timestamp": 1659484928,"fiat_amount":"31.00000000","fiat_symbol":"EUR"}

For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

account.top-up

{"trade_id":1234567,"timestamp":1671580811,"fiat_symbol":"EUR","fiat_balance":"388256.25000000","amount_to_deposit":"611743"}

For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

account.top-up-success

{"id":"1ed8065b-2a73-6b5e-b03f-2a65c999892d","type":"deposit","reference":"7945045137","timestamp":1671540979,"fiat_amount":"25.00000000","fiat_symbol":"EUR"}

For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

user.savings-plan-notification

{"fiat_id": 1,"user_id":"1ed97e4a-912c-69be-9320-0aa759597920","asset_id": 1,"fiat_amount":"3124.00000000","savings_plan_id":"1ed97e71-c379-6648-b86a-ee5ee367ea13","savings_plan_day": 1,"savings_plan_status":"active","savings_plan_frequency":"weekly","external_transaction_id":"1ed97e89-682e-6cbc-8b84-f2ddd95107cf","savings_plan_created_at":"2023-01-19 10:50:38","savings_plan_next_recurrence":"2023-01-19 12:00:00","savings_plan_transaction_confirmation_deadline":"2023-01-19 11:00:00"}

For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

user.savings-plan-trade-notification(failure)

{"user_id":"1ed97e4a-912c-69be-9320-0aa759597920","error_code":"403","error_message":"Saving plan transaction was not confirmed by 2023-01-19T11:00:00+00:00","savings_plan_id":"1ed97e71-c379-6648-b86a-ee5ee367ea13","external_transaction_id":"1ed97e89-682e-6cbc-8b84-f2ddd95107cf","savings_plan_transaction_status":"not_confirmed"}

For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

user.savings-plan-trade-notification(success)

{"user_id":"1ed97d32-dcb7-6974-a846-c6a5060457b4","offer_id":"abadd2dc-cfd7-4411-b135-7cbcbb0823ae","trade_id":"6739ad92-bdb0-4948-b571-d27dda7fc6b5","savings_plan_id":"1ed97d7d-d845-6698-ab33-fe00d406bd61","external_transaction_id":"1ed97d86-d8df-6974-8601-f2ddd95107cf","savings_plan_transaction_status":"finished"}

For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

user.crypto-transfer-notification

{"id": "4e465f96-6abf-4b91-9abb-f61b38eda58a", "fee": "0.0002000000000000", "address": "123456gPagfrEu2345Fmoqwe2weeei2ry1234567ABC", "user_id": "12345678-abcd-abcd-1234-123456789abc", "approved": true, "asset_id": 436, "credited": true, "currency": "EUR", "network_id": "12345678-1234-1234-1234-aaaabbbbcccc", "credited_at": null, "fiat_amount": "7.7000000000000000", "received_at": "2023-12-15T15:01:17.683653Z", "asset_amount": "0.1100000000000000", "asset_symbol": "SOL", "processed_at": null, "destination_tag": null, "asset_network_id": "1ede43b4-3348-6c84-a8d5-ad8ff12fd18a", "transaction_hash": "", "transaction_type": "withdrawal", "transaction_status": "finished", "tax_declaration_status": "undeclared"}

For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

user.crypto-action

{"id":"00000000-abcd-1234-12ab-abcd4c841234","user_id":"abcd71c8-abcd-1234-12ab-abcd4c841234","type":"merger_crypto","credited_at":"2024-04-10T09:31:08Z","transactions":[{"id":"11111111-abcd-1234-12ab-abcd4c841234","asset_id":"aaaaaaaa-abcd-1234-12ab-abcd4c841234","asset_int":1,"fiat_id":"abcd71c8-abcd-1234-12ab-abcd4c841234","fiat_int":2,"asset_amount":"100.30","fiat_amount":"200.60","fee_amount":"0.5","type_defined_for":"asset","direction":"outgoing"},{"id":"22222222-abcd-1234-12ab-abcd4c841234","asset_id":"bbbbbbbb-abcd-1234-12ab-abcd4c841234","asset_int":2,"fiat_id":"abcd71c8-abcd-1234-12ab-abcd4c841234","fiat_int":2,"asset_amount":"100.30","fiat_amount":"200.60","fee_amount":"0.5","type_defined_for":"asset","direction":"incoming"}]}

For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

user.automated-order

{"user_id":"1ef2efc7-1d0c-658b-8bdb-7398fd6afe94","domain_slug":"b2b2c_qa","trade_id":"01ef5401-cf20-6165-b0cb-3e1e8185fb3c","asset_id":"a49406ee-ee33-11ec-aafe-062d595118ef","fiat_id":"ea96ccef-edee-11eb-9bf0-06502b1fe55d","asset_amount":"2.43667276","fiat_amount":"1","type":"buy","status":"finished","created_at":"2024-08-06T14:40:21.848515Z"}

For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

user.savings-plan-auto-cancel-notification

{"saving_plan_id":"1f020444-59fc-6ab8-b914-12a53b25f111","user_id":"1f0202bc-77c3-6fb4-a27e-3bb4d2ab4937","asset_id":"ea89c3a1-edee-11eb-9bf0-06502b1fe55d","operation_type":"merger_crypto"}

For more details regarding the payload, please have a look at the request parameters for the corresponding webhook

SecuritybearerAuth

Request

query Parameters

type	string Event type. Enum: "user.corporate-action" "user.non-user-initiated-tx" "user.non-user-initiated-tx-v2" "user.update" "user.savings-plan-notification" "user.savings-plan-trade-notification" "user.crypto-transfer-notification" "account.send-money" "account.send-money-success" "account.top-up" "account.top-up-success" "user.crypto-action" "user.savings-plan-auto-cancel-notification" Example: type=user.corporate-action
size	integer Number of events to be displayed per page. Maximum value is 50. Example: size=20
after_id	string <uuid> A cursor for use in pagination. after_id is an Event ID that defines your place in the list. Example: after_id=1ed804ad-41e9-6fc2-bf32-1e7e399643fb

Responses

200

Success Response

Response Schema: application/json

	Array of objects (EventV2)
	object
	object

401

Error

Response Schema: application/json

Array of objects

422

Error

Response Schema: application/json

Array of objects

503

Maintenance or Service unavailable

Response Schema: application/json

Array of objects

get/v1/events

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

200
401
422
503

application/json

{"data": [{"id": "1ed83487-f684-62a2-a155-fe633f0db292",
"type": "user.corporate-action",
"payload": "{\"id\":\"1ed9020e-35f5-62ac-b802-369ecc33bc49\",\"time\":\"2023-01-09T14:26:33+01:00\",\"type\":\"dividend\",\"ca_id\":\"1ed901d6-4c21-6676-86e7-e6645454d14d\",\"fiat_id\":1,\"asset_id\":397,\"fiat_symbol\":\"EUR\",\"asset_amount\":\"0.18876873\",\"asset_symbol\":\"BAYN\",\"user_id\":\"1ed7aabf-3bfb-6bb2-8821-8626d6ed9c94\"}",
"created_at": "2024-02-20T08:14:20+00:00"
}
],
"meta": {"size": 10
},
"links": {"self": "/v1/events?size=10&type=user.update",
"next": "/v1/events?size=10&after_id=018e18d0-bcc6-7ac7-a9bb-26d1b37dcc8f&type=user.update"
}
}

Tax

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"tax_rule_id": "9a8e2316-c808-4ae2-bc67-110d372f94e4",
"tax_rule_key": "austrian.crypto.tax",
"tax_eligibility_status": "ELIGIBLE"
}
]
}

Update user’s tax eligibility status

This endpoint updates the requested user's eligibility status per tax rule.

SecuritybearerAuth

Request

path Parameters

Tax-rule-ID

required

string

Tax rule ID

Example: austrian.crypto.tax

header Parameters

bp-user-id required	string <uuid> User ID
Content-Type required	string Content type Example: application/json

Request Body schema: application/json

The eligibility status for update.

is_eligible

boolean

Eligibility TRUE/FALSE

Array of objects

put/v1/tax-status/{Tax-rule-ID}

Request samples

application/json

{"is_eligible": true
}

Response samples

application/json

{"data": {"tax_rule_id": "9a8e2316-c808-4ae2-bc67-110d372f94e4",
"tax_eligibility_status": "ELIGIBLE"
}
}

Get trade tax details

The endpoint retrieves additional tax information for a particular trade. This information helps users better understand the tax calculations associated with that specific trade.

SecuritybearerAuth

Request

path Parameters

Offer-ID

required

string <uuid>

Offer ID

Example: 975d9dbf-41ed-47ef-96eb-8f8a8be1ba4c

header Parameters

bp-user-id

required

string <uuid>

User ID

Response samples

application/json

{"data": {"type": "tax-details",
"trade_id": "975d9dbf-41ed-47ef-96eb-8f8a8be1ba4c",
"fiat_id": "975d9dbf-41ed-47ef-96eb-8f8a8be1ba4c",
"taxable_amount": "10",
"capital_gain": "-0.11"
}
}

Crypto-Transfers

List external addresses

This endpoint provides a paginated list of crypto addresses from Address-Book associated with a specific beneficiary. It supports several query parameters to help filter the results by specific criteria, such as address ID, asset ID, and network type.

This endpoint enables clients to retrieve only the necessary subset of addresses for a user, making it flexible and efficient for use cases requiring focused data retrieval.

SecuritybearerAuth

Request

query Parameters

id	string <uuid> Filters results by a specific crypto address ID. Use this parameter to retrieve a single address by its unique identifier if you need details for one address only. Example: id=11111111-12ab-ab12-eeeeeeeeeeee
asset_id	string <uuid> Filters results by a specific asset ID. This allows retrieval of addresses for a particular cryptocurrency asset (e.g., BTC, ETH). Use this to view all addresses associated with a specific asset type for a user. Example: asset_id=1ed83487-f684-62a2-a155-fe633f0db292
coin_network_id	string <uuid> Filters addresses by the coin network ID, specifying the network type associated with the asset (e.g., Bitcoin mainnet, Ethereum mainnet). This parameter helps retrieve addresses on a particular blockchain network. Example: coin_network_id=d969468d-2be6-4522-977e-ea4d92c45e86
sort	string Sorts results by specified field. Value: "owner_legal_name"

header Parameters

bp-user-id

required

string <uuid>

Example: 12312312-2be6-4522-977e-ea4d92c45e86

Array of objects

get/v1/crypto-transfers/addresses

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"id": "1ed83487-f684-62a2-a155-fe633f0db292",
"host_type": "KNOWN_VASP",
"host_name": "Bitpanda",
"host_id": "1ef3c8b7-8b65-6784-912a-b7cc10fee72f",
"address": "rBnNhk95FrdNisZtXcStzriFS8vEzz53DM",
"destination_tag": "6363869576905874",
"destination_tag_type": "string",
"user_owned": false,
"owner_legal_name": "John Doe",
"asset_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"coin_network_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"network_id": "1ede43b3-b3ac-65da-3070-298a90a0ab70",
"created_at": "2022-07-20T08:14:20Z"
}
]
}

Create deposit address

This endpoint allows users to create a new blockchain address on a specified network. If an address on that network already exists, the existing address will be returned.

It is expected to be used while performing crypto deposits, the information returned by this endpoint should be made visible to the users for their deposit requests.

SecuritybearerAuth

Request

header Parameters

bp-user-id

required

string <uuid>

Example: 12312312-2be6-4522-977e-ea4d92c45e86

Request Body schema: application/json

The address to be created.

coin_network_id

required

string <uuid>

Filters addresses by the coin network ID, specifying the network type associated with the asset (e.g., Bitcoin mainnet, Ethereum mainnet). This parameter helps retrieve addresses on a particular blockchain network.

Array of objects

post/v1/crypto-transfers/addresses

Request samples

application/json

{"coin_network_id": "d969468d-2be6-4522-977e-ea4d92c45e86"
}

Response samples

application/json

{"data": {"id": "1ed83487-f684-62a2-a155-fe633f0db292",
"address": "rBnNhk95FrdNisZtXcStzriFS8vEzz53DM",
"destination_tag": "6363869576905874",
"destination_tag_type": "string",
"asset_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"coin_network_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"network_id": "1ede43b3-b3ac-65da-3070-298a90a0ab70",
"created_at": "2022-07-20T08:14:20Z"
}
}

Update external address

This endpoint allows for the updating of a user’s external address, primarily to comply with Travel Rule requirements. It ensures that the user's address information is accurate and current, aiding in regulatory compliance and smooth transaction processing across different jurisdictions. This endpoint updates deposit addresses when necessary, but not all addresses can be updated.

SecuritybearerAuth

Request

path Parameters

id

required

string <uuid>

The unique identifier for the external address associated with this transaction. This Address ID links the withdrawal to a specific user address.

header Parameters

bp-user-id

required

string <uuid>

Example: 12312312-2be6-4522-977e-ea4d92c45e86

Request Body schema: application/json

The address details that needs to be updated.

host_type required	string Host Type - Specifies the type of wallet or entity hosting the crypto address. The possible values are: `KNOWN_VASP`: A verified Virtual Asset Service Provider (VASP) such as a licensed exchange. `UNKNOWN_VASP`: An unverified or unrecognized Virtual Asset Service Provider. In this case the `host_name` field is required. `SELF_HOSTED`: A self-custodied wallet, such as MetaMask, where the user has direct control over their private keys. Enum: "KNOWN_VASP" "UNKNOWN_VASP" "SELF_HOSTED"
host_name	string or null The name of the platform or wallet provider associated with the crypto address, represented as a string (e.g., “Binance,” “Coinbase,” etc.).
host_id	string or null <uuid> The id of the platform or wallet provider associated with the crypto address.
user_owned required	boolean A boolean indicating ownership of the address. true if the address belongs to the user making the request; false if it belongs to another user.
owner_legal_name	string The legal name of the address beneficiary, required only if `user_owned` is `false`. This specifies the full name of the person or entity that owns the address when it does not belong to the requesting user.

Array of objects

patch/v1/crypto-transfers/addresses/{id}

Request samples

application/json

{"host_type": "KNOWN_VASP",
"host_name": "Bitpanda",
"host_id": "1ef3c8b7-8b65-6784-912a-b7cc10fee72f",
"user_owned": false,
"owner_legal_name": "John Doe"
}

Response samples

application/json

{"data": {"id": "1ed83487-f684-62a2-a155-fe633f0db292",
"host_type": "KNOWN_VASP",
"host_name": "Bitpanda",
"host_id": "1ef3c8b7-8b65-6784-912a-b7cc10fee72f",
"address": "rBnNhk95FrdNisZtXcStzriFS8vEzz53DM",
"destination_tag": "6363869576905874",
"destination_tag_type": "string",
"user_owned": false,
"owner_legal_name": "John Doe",
"asset_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"coin_network_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"network_id": "1ede43b3-b3ac-65da-3070-298a90a0ab70",
"created_at": "2022-07-20T08:14:20Z"
}
}

Create withdrawal address

This endpoint is designed to create a beneficiary address within our Address Book, enabling the sender to initiate secure withdrawals. By registering this address, Bitpanda ensures complete beneficiary information is available, meeting both Travel Rule and MiCAR compliance requirements.

This process helps maintain a safe, regulated environment for crypto transactions, ensuring transparency and adherence to legal standards for all parties involved.

SecuritybearerAuth

Request

header Parameters

bp-user-id

required

string <uuid>

Example: 12312312-2be6-4522-977e-ea4d92c45e86

Request Body schema: application/json

The address to be created.

coin_network_id required	string <uuid> The unique identifier representing the specific coin and network for which the address will be created.
address required	string The generated address hash on the specified network, used for sending cryptocurrency transactions.
destination_tag	string or null An additional identifier used with certain cryptocurrencies (e.g., XRP, Stellar) to specify the recipient’s unique identifier within a wallet address, ensuring the transaction reaches the correct account.
host_type required	string Host Type - Specifies the type of wallet or entity hosting the crypto address. The possible values are: `KNOWN_VASP`: A verified Virtual Asset Service Provider (VASP) such as a licensed exchange. `UNKNOWN_VASP`: An unverified or unrecognized Virtual Asset Service Provider. In this case the `host_name` field is required. `SELF_HOSTED`: A self-custodied wallet, such as MetaMask, where the user has direct control over their private keys. Enum: "KNOWN_VASP" "UNKNOWN_VASP" "SELF_HOSTED"
host_name	string or null The name of the platform or wallet provider associated with the crypto address, represented as a string (e.g., “Binance,” “Coinbase,” etc.).
host_id	string or null <uuid> The id of the platform or wallet provider associated with the crypto address.
user_owned required	boolean A boolean indicating ownership of the address. true if the address belongs to the user making the request; false if it belongs to another user.
owner_legal_name	string or null The legal name of the address beneficiary, required only if `user_owned` is `false`. This specifies the full name of the person or entity that owns the address when it does not belong to the requesting user.

Array of objects

post/v1/crypto-transfers/addresses/withdrawals

Request samples

application/json

{"coin_network_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"address": "raDnEe3yGzkqK6nBUerb5s9wqszZDLYTbz",
"destination_tag": "6363869576905874",
"host_type": "KNOWN_VASP",
"host_name": "Bitpanda",
"host_id": "1ef3c8b7-8b65-6784-912a-b7cc10fee72f",
"user_owned": false,
"owner_legal_name": "John Doe"
}

Response samples

application/json

{"data": {"id": "1ed83487-f684-62a2-a155-fe633f0db292",
"host_type": "KNOWN_VASP",
"host_name": "Bitpanda",
"host_id": "1ef3c8b7-8b65-6784-912a-b7cc10fee72f",
"address": "rBnNhk95FrdNisZtXcStzriFS8vEzz53DM",
"destination_tag": "6363869576905874",
"destination_tag_type": "string",
"user_owned": false,
"owner_legal_name": "John Doe",
"asset_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"coin_network_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"network_id": "1ede43b3-b3ac-65da-3070-298a90a0ab70",
"created_at": "2022-07-20T08:14:20Z"
}
}

Response Schema: application/json

Array of objects

get/v1/crypto-transfers/vasps

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"popular": [{"id": "1ef3c8b7-8b65-6784-912a-b7cc10fee72f",
"name": "Bitpanda"
},
{"id": "4d74ffa4-6aa4-494e-994f-a03bacf19588",
"name": "Binance"
},
{"id": "36728892-7dc3-48d9-b5f9-24dab4e94356",
"name": "Coinbase"
}
],
"others": [{"id": "5851a148-da85-4a3d-a5e9-6fa2abffe1c0",
"name": "Kraken"
},
{"id": "83574df2-6325-415f-b880-873ddf2a969a",
"name": "MEXC"
},
{"id": "0d64f7ee-8b2e-47b8-b092-d7581ebfa95a",
"name": "Bitget"
},
{"id": "9655d1b7-ad60-4ac8-a2fa-e8bd252f4717",
"name": "Bybit"
},
{"id": "0bc4b01f-1fbc-4706-a976-72d87481b3aa",
"name": "KuCoin"
},
{"id": "1dcc26e3-7014-4d62-8e62-edbbff1e7ffe",
"name": "Phemex"
},
{"id": "a1877d3f-b410-46de-aea5-f30c8bd39285",
"name": "CoinEx"
},
{"id": "a3e98ff5-bac1-4a69-a620-809678cb09a3",
"name": "Crypto"
},
{"id": "8025ebee-6690-4bc6-8835-05bc639067ec",
"name": "Cobo"
},
{"id": "795fdd85-e5f2-4c15-96f5-6bf44f4a48d2",
"name": "BingX"
},
{"id": "2a75e8e2-7126-4f5c-b024-dc47d6f9c0b4",
"name": "Nexo"
},
{"id": "d3074baa-4114-42c5-ab89-0c78866b8815",
"name": "OKX"
},
{"id": "a6c994d2-1f3f-4b67-90e3-723571ada958",
"name": "ChangeNOW"
},
{"id": "44d7a12f-a6ca-48f6-866c-08a564355d1f",
"name": "Bitvavo"
},
{"id": "28827966-046d-4d0f-98bb-10fa776856b7",
"name": "Revolut"
}
]
}
}

Validate crypto address

This endpoint validates a given crypto address, along with an optional destination tag if required by the blockchain network. It ensures that the address is compatible with the specified coin network and that any additional information, such as the destination tag, is accurate. This validation helps prevent errors in transactions and ensures compliance with network standards.

SecuritybearerAuth

Request

header Parameters

bp-user-id

required

string <uuid>

Example: 12312312-2be6-4522-977e-ea4d92c45e86

Request Body schema: application/json

The withdrawal offer

address required	string The crypto address to be validated. This is the primary address provided by the user, which needs verification against the specified coin network.
coin_network_id required	string <uuid> A unique identifier representing the coin and network combination. This ensures that the validation is specific to the correct blockchain network.
destination_tag	string or null An additional identifier used by certain blockchain networks (e.g., XRP, Stellar) to direct the transaction to a specific account or purpose within the address. If the network requires a destination tag, this field is necessary.
destination_tag_type	string or null Specifies the type of destination tag being used, which can vary by blockchain (e.g., “memo_id” for Stellar, “memo_text” for EOS). This ensures that the correct format is applied during validation.

Array of objects

post/v1/crypto-transfers/addresses/validate

Request samples

application/json

{"address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
"coin_network_id": "d969468d-2be6-4522-977e-ea4d92c45e86",
"destination_tag": "123456789",
"destination_tag_type": "memo_id"
}

Response samples

application/json

{"data": {"is_valid": true,
"is_address_valid": true,
"is_destination_tag_valid": true
}
}

List all crypto transfers per user

This endpoint retrieves a paginated list of all crypto transactions, including deposits and withdrawals, for a specified user.

It allows filtering by transaction attributes like type, status, and date range, providing flexibility to view and manage transaction history efficiently.

SecuritybearerAuth

Request

query Parameters

id	string <uuid> Filters results by a specific transaction ID, allowing retrieval of a particular transaction. Example: id=e69f4b1c-e3d7-4e5f-8561-4a6c09441097
asset_id	string <uuid> Filters transactions by a specific asset, such as BTC or ETH, identified by the asset’s UUID. Example: asset_id=1ed83487-f684-62a2-a155-fe633f0db292
coin_network_id	string <uuid> Filters transactions by the coin network ID, allowing users to view transactions on a particular blockchain network. Example: coin_network_id=d969468d-2be6-4522-977e-ea4d92c45e86
status[]	Array of strings Filters transactions based on their current status. If no status is specified, all statuses will be returned. Note: The `not-confirmed` status applies only to withdrawals that have been created but never finalized. Items Enum: "pending" "not-confirmed" "processing" "on-hold" "finished" "canceled" "rejected" "refunded" Example: status[]=processing
transaction_type	string Filters transactions by type, distinguishing between deposits and withdrawals. Enum: "deposit" "withdrawal" Example: transaction_type=deposit
date_start	string Filters transactions by a start date, returning only those created on or after this date. Example: date_start=2023-12-20
date_end	string Filters transactions by an end date, returning only those created on or before this date. Example: date_end=2023-12-20
address_id	string <uuid> Filters transactions by address_id, returning only those with the specified address. Example: address_id=bf335d15-fd89-4b20-8b9e-62d52d33ba19
size	integer [ 1 .. 100 ] Sets the number of transaction records per page for pagination. Example: size=10
cursor	string <uuid> A cursor for use in pagination. The cursor represents a Transaction ID that defines your place in the list. Example: cursor=1ed804ad-41e9-6fc2-bf32-1e7e399643fb
direction	string Specifies the direction of the results, based on the transaction ID as cursor. Use `before` to get results before a specific ID or `after` to get results after a specific ID. This provides flexibility in how results are displayed relative to the cursor. Enum: "before" "after"

header Parameters

bp-user-id

required

string <uuid>

Example: 12312312-2be6-4522-977e-ea4d92c45e86

Responses

200

Success Response

Response Schema: application/json

	Array of objects (TransactionResponse)
	object (PaginationMetaV2)

get/v1/crypto-transfers/transactions/{transaction-ID}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"id": "1ed83487-f684-62a2-a155-fe633f0db292",
"internal_address_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"external_address_id": "779bb70d-715d-4734-824a-0b4d5127c69f",
"asset_id": "1ed97e4a-912c-69be-9320-0aa759597920",
"asset_legal_classification": "EMTS",
"asset_amount": "0.5",
"asset_fee": "0.1",
"fiat_id": "1ed97e4a-912c-69be-9320-0aa759597920",
"fiat_amount": "15000.00",
"fiat_amount_fee": "300.00",
"coin_network_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"transaction_type": "deposit",
"transaction_hash": "0x123456789abcdef",
"transaction_status": "finished",
"required_actions": ["BENEFICIARY_DETAILS"
],
"tax_declaration_status": "declared",
"created_at": "2023-12-20T08:14:20Z",
"credited_at": "2023-12-21T08:15:20Z"
}
}

Update tax declaration status for a crypto deposit transaction

This endpoint allows updating the tax declaration status of a specific deposit transaction. It enables users to declare tax-related details about crypto deposits, required for compliance with regulatory reporting standards.

SecuritybearerAuth

Request

path Parameters

transaction-ID

required

string <uuid>

Unique identifier (UUID) of the transaction to update.

header Parameters

bp-user-id

required

string <uuid>

Unique identifier (UUID) for the user

Example: 12312312-2be6-4522-977e-ea4d92c45e86

Request Body schema: application/json

Object containing details for updating the tax declaration status of a specific transaction.

currency_code required	string The currency code (e.g., EUR, USD) used for the declarations, for the amounts being declared.
required	Array of objects A list of declarations providing details about the acquisition and price of the asset for the deposited amount.

Responses

204

Array of objects

patch/v1/crypto-transfers/transactions/{transaction-ID}

Request samples

application/json

{"currency_code": "EUR",
"declarations": [{"type": "date_and_price",
"amount": "0.33",
"date_of_acquisition": "2019-08-24",
"total_paid_price": "100345.33",
"date_from": "2024-10-11",
"date_to": "2019-08-24"
}
]
}

Response samples

application/json

{"errors": [{"code": "invalid.transaction.id",
"title": "Invalid transaction ID"
}
]
}

Create a crypto withdrawal offer

This endpoint allows users to initiate a cryptocurrency withdrawal by submitting details such as the amount to withdraw, the destination address, blockchain destination tags (memo_id, memo_text), returning a structured offer that outlines the terms and conditions of the withdrawal including fees. Such an offer can later be confirmed by the user.

SecuritybearerAuth

Request

header Parameters

bp-user-id required	string <uuid> Example: 12312312-2be6-4522-977e-ea4d92c45e86
Idempotency-Key required	string <uuid> A unique key that the server uses to recognize subsequent retries of the same request

Request Body schema: application/json

The withdrawal offer

asset_amount required	string The asset amount the user intends to withdraw. It is the initial amount specified by the user before any deductions are made.
external_address_id required	string <uuid> A unique identifier (UUID) assigned to the newly created crypto address. This ID is returned by the Create Address endpoint and is used to reference, track, and manage the specific address within the system.

Array of objects

post/v1/crypto-transfers/withdrawals

Request samples

application/json

{"asset_amount": "0.2",
"external_address_id": "1ed83487-f684-62a2-a155-fe633f0db292"
}

Response samples

application/json

{"data": {"id": "1ed83487-f684-62a2-a155-fe633f0db292",
"external_address_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"coin_network_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"network_id": "1ede43b3-b3ac-65da-3070-298a90a0ab70",
"asset_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"asset_amount": "0.5",
"asset_fee": "0.01",
"fiat_id": "4fbc982a-d8f3-431a-8f14-3ed5d8f23312",
"fiat_amount": "15000.00",
"fiat_amount_fee": "300.00",
"transaction_status": "pending",
"created_at": "2022-07-21T08:14:20Z"
}
}

Confirm a withdrawal offer

This endpoint can be used to confirm a withdrawal offer. The withdrawal will be executed after the confirmation. This means the withdrawal is not guaranteed after this step and you need to call the Search for crypto transfers endpoint or listen to notification events through webhooks to retrieve the final status.

SecuritybearerAuth

Request

path Parameters

withdrawal-id

required

string <uuid>

A unique identifier (UUID) assigned to a specific withdrawal transaction. This ID is provided when a withdrawal offer is created and is used to reference, track, and manage the withdrawal within the system.

header Parameters

bp-user-id

required

string <uuid>

Example: 12312312-2be6-4522-977e-ea4d92c45e86

Array of objects

patch/v1/crypto-transfers/withdrawals/{withdrawal-id}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"id": "1ed83487-f684-62a2-a155-fe633f0db292",
"external_address_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"coin_network_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"network_id": "1ede43b3-b3ac-65da-3070-298a90a0ab70",
"asset_id": "1ed83487-f684-62a2-a155-fe633f0db292",
"asset_amount": "0.5",
"asset_fee": "0.01",
"fiat_id": "4fbc982a-d8f3-431a-8f14-3ed5d8f23312",
"fiat_amount": "15000.00",
"fiat_amount_fee": "300.00",
"transaction_status": "processing",
"created_at": "2024-10-15T08:14:20Z"
}
}

Savings

Create a savings plan

The endpoint enables users to set up a customised savings plan by specifying a portion of their income to be regularly saved (weekly, biweekly or monthly), with the aim of achieving a designated financial goal. It returns details of the created plan including next recurrence date and the date when the partner will be notified about the upcoming savings plan trade execution.

SecuritybearerAuth

Request

header Parameters

bp-user-id required	string <uuid>
idempotency-key required	string <uuid> A unique identifier for the create savings plan request. Guarantees that only one resource will be created regardless of how many times a request is sent to us. Example: 2e4c89ac-1290-426f-8de0-4c7b40b91d3a

Request Body schema: application/json

Create savings plan details.

asset_id required	integer Asset Id that needs to be bought when savings plan trade will be executed.
fiat_id required	integer The fiat id of the savings plan / Currency of the savings plan. Value: 1
amount required	string <double> The amount of the savings plan. Allowed 10-10000
frequency required	string The frequency of the savings plan (weekly, biweekly, monthly). Enum: "weekly" "biweekly" "monthly"
day required	integer [ 1 .. 31 ] Day of the savings plan execution. For a weekly & biweekly frequency, it's accepted only a value between 1...7 where 1 = Monday...7 = Sunday. For a monthly frequency it's accepted only a value between 1...31.
external_tx_id	string or null <uuid> An optional external transaction identifier provided by partners. It serves as a unique reference to link the partner’s savings plan ID with the Bitpanda savings plan ID. This field is not exposed in API responses but may be required in internal reports or reconciliation processes.

Array of objects

post/v1/savings-plan

Request samples

application/json

{"asset_id": 1,
"fiat_id": 1,
"amount": "20.11",
"frequency": "weekly",
"day": 5,
"external_tx_id": "c04cd877-cb9c-485c-bbc8-6bec3eb41b39"
}

Response samples

application/json

{"data": {"user_id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"fiat_id": 1,
"asset_id": 1,
"fiat_amount": "20.12",
"frequency": "weekly",
"day": 5,
"next_recurrence": "2023-01-06T12:00:00+00:00",
"notification_date": "2023-01-04",
"status": "active",
"id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"created_at": "2022-01-01T13:07:31+00:00"
}
}

Search for savings plans

List all savings plans with the possibility to filter by different identifiers like savings plan id, asset id, user id and status.

SecuritybearerAuth

Request

query Parameters

id	string <uuid> Search for savings plans by ID Example: id=1eda5f65-eb10-64ce-b872-0242ac12000b
user_id	string <uuid> Search for savings plans by user_id Example: user_id=5b2ca85b-0191-4e93-9165-413df4aa0c18
asset_id	integer Search for savings plans by asset_id Example: asset_id=1
status	string Search for savings plans by status. Enum: "active" "canceled" Example: status=active
page_size	integer Number of elements to be displayed on a page Example: page_size=10
page	integer Display page number Example: page=1

Responses

200

Success Response

Response Schema: application/json

	Array of objects (SearchSavingsPlanResponse)
	object (PaginationMeta)
	object (PaginationLinks)

get/v1/savings-plan

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"user_id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"fiat_id": 1,
"asset_id": 1,
"fiat_amount": "20.12",
"frequency": "weekly",
"day": 5,
"next_recurrence": "2023-01-06T12:00:00+00:00",
"notification_date": "2023-01-04",
"status": "active",
"id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"created_at": "2022-01-01T13:07:31+00:00"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Cancel a savings plan

This endpoint allows users to terminate an existing savings plan by submitting the unique identifier of the plan and the status canceled. This endpoint processes the cancellation request and provides back the successful cancellation of the plan and all its details.

SecuritybearerAuth

Request

path Parameters

savings_plan_id

required

string <uuid>

Savings plan id that needs to be canceled.

Example: 1eda5f65-eb10-64ce-b872-0242ac12000b

header Parameters

bp-user-id

required

string <uuid>

User id that savings plan belongs to.

Example: 5b2ca85b-0191-4e93-9165-413df4aa0c18

Request Body schema: application/json

Cancel a savings plan.

status

required

string

The new status of the savings plan. Only 'canceled' is accepted.(This will act as a confirmation)

Value: "canceled"

{"status": "canceled"
}

Response samples

application/json

{"data": {"user_id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"fiat_id": 1,
"asset_id": 1,
"fiat_amount": "20.12",
"frequency": "weekly",
"day": 5,
"status": "canceled",
"id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"created_at": "2022-01-01T13:07:31+00:00"
}
}

Cancel a savings plan V2

This endpoint allows users to terminate an existing savings plan by submitting the unique identifier of the plan and the status canceled. This endpoint processes the cancellation request and provides back the successful cancellation of the plan and all its details.

SecuritybearerAuth

Request

path Parameters

savings_plan_id

required

string <uuid>

Savings plan ID that needs to be canceled.

Example: 1eda5f65-eb10-64ce-b872-0242ac12000b

header Parameters

bp-user-id

required

string <uuid>

User ID that savings plan belongs to.

Example: 5b2ca85b-0191-4e93-9165-413df4aa0c18

Request Body schema: application/json

Cancel a savings plan.

status

required

string

The new status of the savings plan. Only 'canceled' is accepted.(This will act as a confirmation)

Value: "canceled"

{"status": "canceled"
}

Response samples

application/json

{"data": {"user_id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"fiat_id": "b88b8466-efe3-11eb-b56f-0691764446a7",
"asset_id": "b86c113a-efe3-11eb-b56f-0691764446a7",
"fiat_amount": "20.12",
"frequency": "weekly",
"day": 5,
"status": "canceled",
"id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"created_at": "2022-01-01T13:07:31+00:00"
}
}

Confirm a savings plan transaction

This endpoint is used to confirm the reservation of funds for a transaction associated with a savings plan. When a transaction related to a savings plan needs to be initiated, Partners are notified via webhook events in advance. Following this notification, they must use this endpoint to confirm the reservation of funds, ensuring the transaction is validated and processed according to the savings plan terms. If the transaction is not confirmed, that recurrence of the savings plan is skipped.

SecuritybearerAuth

Request

path Parameters

external_transaction_id

required

string

External transaction ID. It'll be generated, when Bitpanda create the savings plan notice.

Example: 1eda5f65-eb10-64ce-b872-0242ac12000b

Array of objects

patch/v1/savings-plan/transaction/{external_transaction_id}/confirm

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"external_transaction_id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"savings_plan_transaction_status": "confirmed",
"savings_plan_transaction_confirmed_at": "2023-01-04T12:00:00+00:00",
"savings_plan_id": "1eda5f65-eb10-64ce-b872-0242ac12000b",
"user_id": "5b2ca85b-0191-4e93-9165-413df4aa0c18",
"asset_id": 1,
"fiat_id": 1,
"fiat_amount": "20.12",
"frequency": "weekly",
"day": 5,
"next_recurrence": "2023-01-06T12:00:00+00:00",
"savings_plan_status": "active",
"created_at": "2022-01-01T13:07:31+00:00"
}
}

Confirm a savings plan transaction V2

This endpoint is used to confirm the reservation of funds for a transaction associated with a savings plan. When a transaction related to a savings plan needs to be initiated, Partners are notified via webhook events in advance. Following this notification, they must use this endpoint to confirm the reservation of funds, ensuring the transaction is validated and processed according to the savings plan terms. If the transaction is not confirmed, that recurrence of the savings plan is skipped.

SecuritybearerAuth

Request

path Parameters

external_transaction_id

required

string <uuid>

External transaction ID. It'll be generated, when Bitpanda create the savings plan notice.

Example: 1eda5f65-eb10-64ce-b872-0242ac12000b

Array of objects

patch/v2/savings-plan/transaction/{external_transaction_id}/confirm

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"external_transaction_id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"savings_plan_transaction_status": "confirmed",
"savings_plan_transaction_confirmed_at": "2023-01-04T12:00:00+00:00",
"savings_plan_id": "1eda5f65-eb10-64ce-b872-0242ac12000b",
"user_id": "5b2ca85b-0191-4e93-9165-413df4aa0c18",
"asset_id": "b86c113a-efe3-11eb-b56f-0691764446a7",
"fiat_id": "b88b8466-efe3-11eb-b56f-0691764446a7",
"fiat_amount": "20.12",
"frequency": "weekly",
"day": 5,
"next_recurrence": "2023-01-06T12:00:00+00:00",
"savings_plan_status": "active",
"created_at": "2022-01-01T13:07:31+00:00"
}
}

Create a savings plan V2

The endpoint enables users to set up a customised savings plan by specifying a portion of their income to be regularly saved (weekly, biweekly or monthly), with the aim of achieving a designated financial goal. It returns details of the created plan including next recurrence date and the date when the partner will be notified about the upcoming savings plan trade execution.

SecuritybearerAuth

Request

header Parameters

bp-user-id required	string <uuid>
idempotency-key required	string <uuid> A unique identifier for the create savings plan request. Guarantees that only one resource will be created regardless of how many times a request is sent to us. Example: 2e4c89ac-1290-426f-8de0-4c7b40b91d3a

Request Body schema: application/json

Create savings plan details.

asset_id required	string <uuid> Asset ID that needs to be bought when savings plan trade will be executed.
fiat_id required	string <uuid> The fiat ID of the savings plan / Currency of the savings plan.
amount required	string <double> The amount of the savings plan. Allowed 10-10000
frequency required	string The frequency of the savings plan (weekly, biweekly, monthly). Enum: "weekly" "biweekly" "monthly"
day required	integer [ 1 .. 31 ] Day of the savings plan execution. For a weekly & biweekly frequency, it's accepted only a value between 1...7 where 1 = Monday...7 = Sunday. For a monthly frequency it's accepted only a value between 1...31.
external_tx_id	string or null <uuid> An optional external transaction identifier provided by partners. It serves as a unique reference to link the partner’s savings plan ID with the Bitpanda savings plan ID. This field is not exposed in API responses but may be required in internal reports or reconciliation processes.

Array of objects

post/v2/savings-plan

Request samples

application/json

{"asset_id": "b86c113a-efe3-11eb-b56f-0691764446a7",
"fiat_id": "b88b8466-efe3-11eb-b56f-0691764446a7",
"amount": "20.11",
"frequency": "weekly",
"day": 5,
"external_tx_id": "c04cd877-cb9c-485c-bbc8-6bec3eb41b39"
}

Response samples

application/json

{"data": {"user_id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"fiat_id": "b88b8466-efe3-11eb-b56f-0691764446a7",
"asset_id": "b86c113a-efe3-11eb-b56f-0691764446a7",
"fiat_amount": "20.12",
"frequency": "weekly",
"day": 5,
"next_recurrence": "2023-01-06T12:00:00+00:00",
"notification_date": "2023-01-04",
"status": "active",
"id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"created_at": "2022-01-01T13:07:31+00:00"
}
}

Search for savings plans V2

List all savings plans with the possibility to filter by different identifiers like savings plan id, asset id, fiat id, user id and status.

SecuritybearerAuth

Request

query Parameters

id	string <uuid> Search for savings plans by ID Example: id=1eda5f65-eb10-64ce-b872-0242ac12000b
user_id	string <uuid> Search for savings plans by user ID Example: user_id=5b2ca85b-0191-4e93-9165-413df4aa0c18
asset_id	string <uuid> Search for savings plans by asset ID Example: asset_id=b86c113a-efe3-11eb-b56f-0691764446a7
fiat_id	string <uuid> Search for savings plans by fiat ID Example: fiat_id=b88b8466-efe3-11eb-b56f-0691764446a7
status	string Search for savings plans by status. Enum: "active" "canceled" Example: status=active
page_size	integer [ 1 .. 100 ] Number of elements to be displayed on a page Example: page_size=10
page	integer >= 1 Display page number Example: page=1

Responses

200

Success Response

Response Schema: application/json

	Array of objects (SearchSavingsPlanV2Response)
	object (PaginationMeta)
	object (PaginationLinks)

get/v2/savings-plan

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"user_id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"fiat_id": "b88b8466-efe3-11eb-b56f-0691764446a7",
"asset_id": "b86c113a-efe3-11eb-b56f-0691764446a7",
"fiat_amount": "20.12",
"frequency": "weekly",
"day": 5,
"next_recurrence": "2023-01-06T12:00:00+00:00",
"notification_date": "2023-01-04",
"status": "active",
"id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"created_at": "2022-01-01T13:07:31+00:00",
"total_successful_transactions": 10,
"total_asset_amount": "30.25"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Get savings plan next recurrence date.

The endpoint allows the calculation of the next recurrence date before creating the savings plan. The next recurrence date returned from this endpoint is the same value that would be returned from the create savings plan endpoint.

SecuritybearerAuth

Request

query Parameters

frequency required	string The frequency of the savings plan (weekly, biweekly, monthly). Enum: "weekly" "biweekly" "monthly" Example: frequency=weekly
day required	integer [ 1 .. 31 ] Day of the savings plan execution. For a weekly & biweekly frequency, it's accepted only a value between 1...7 where 1 = Monday...7 = Sunday. For a monthly frequency it's accepted only a value between 1...31. Example: day=5

Response samples

application/json

{"data": {"next_recurrence": "2023-01-06T12:00:00+00:00"
}
}

Swaps

Create a swap offer

By submitting a request to this endpoint, users can propose a swap offer, where they specify the assets they would like to exchange and the amount of units, either from the source or from the target asset. The request triggers the creation of a swap offer that can later be accepted by the user within its validity (as defined in offer_validity & expires_at response parameters).

The users can swap any asset that is present in their portfolio to any other supported digital asset on our platform. When swapping an asset, it is first sold as a fiat token (F-Token) before the desired asset is bought. This happens to avoid price fluctuations.

SecuritybearerAuth

Request

header Parameters

bp-user-id

required

string <uuid>

User ID

Request Body schema: application/json

The swap offer to be created.

source_asset_id required	integer The unique identifier of the asset to be sold when the swap is executed.
target_asset_id required	integer The unique identifier of the target asset to be acquired when the swap is executed.
amount required	string non-empty ^[0-9]+(\.[0-9]{1,8})?$ The quantity of the asset involved in the swap transaction. The specific amount will depend on the context defined by the 'amount_defined_for' parameter.
amount_defined_for required	string Specifies the context for the 'amount' parameter. If set to 'source', the 'amount' refers to the quantity or value of the 'source_asset_id' to be sold or exchanged. If set to 'target', the 'amount' refers to the quantity or value of the 'target_asset_id' to be acquired during the swap execution. Enum: "source" "target"

{"source_asset_id": 1,
"target_asset_id": 2,
"amount": "1.00000001",
"amount_defined_for": "source"
}

Response samples

application/json

{"data": {"id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"source_asset_id": 1,
"target_asset_id": 2,
"source_fiat_amount": "100.13",
"source_asset_amount": "0.00000001",
"target_asset_amount": "12.123",
"tax_amount": "0.10",
"net_asset_price": "1930.84694442",
"fee_amount": "0.45",
"fee_percentage": "2.25",
"time": "2025-09-04T12:32:01Z",
"expires_at": "2025-09-04T12:32:01Z",
"offer_validity": 60
}
}

Search for swaps

This endpoint allows you to search for finished swaps by date range, swap trade ID, or user ID, individually or in combination, with the search period limited to a maximum of 31 days.

SecuritybearerAuth

Request

query Parameters

date_start	string <date> Search swap trades by date_start. Example: date_start=2023-06-28
date_end	string <date> Search swap trades by date_end. Example: date_end=2023-06-28
swap_trade_id	string <uuid> Search swap trades by swap_trade_id. Example: swap_trade_id=d969468d-2be6-4522-977e-ea4d92c45e86
user_id	string <uuid> Search swap trades by user_id. Example: user_id=1edfadad-9ab8-6a30-9760-0242ac120003
page_size	integer [ 1 .. 100 ] Number of elements to be displayed on a page Example: page_size=10
page	integer >= 1 Display page number Example: page=1

Responses

200

List swap trades that match the search query parameters

Response Schema: application/json

	Array of objects (SwapTradesSearch)
	object (PaginationMeta)
	object (PaginationLinks)

get/v1/swaps/search

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"id": "d969468d-2be6-4522-977e-ea4d92c45e86",
"source_asset_id": 1,
"source_asset_symbol": "BTC",
"target_asset_id": 5,
"target_asset_symbol": "ETH",
"source_asset_amount": "0.00000001",
"target_asset_amount": "12345.12345700",
"status": "completed",
"tax_amount": "0.10",
"user_id": "1edfadad-9ab8-6a30-9760-0242ac120003",
"time": "2023-07-19T12:14:28+00:00"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"id": "d969468d-2be6-4522-977e-ea4d92c45e86",
"external_swap_id": "d969468d-2be6-4522-977e-ea4d92c45e87",
"user_id": "1edfadad-9ab8-6a30-9760-0242ac120003",
"time": "2023-07-19T12:14:28+00:00",
"source_offer": {"id": "d969468d-2be6-4522-977e-ea4d92c45e88",
"offer_id": "d969468d-2be6-4522-977e-ea4d92c45e89",
"type": "buy",
"fiat_id": 1,
"asset_id": 1,
"fiat_amount": "100.13",
"tax_amount": "100.14",
"total_amount": "100.15",
"asset_amount": "0.12345678",
"asset_price": "12.12345678",
"time": "2023-07-19T12:14:28+00:00",
"status": "completed",
"spread": "12.12345678",
"final_revenue_share": "100.16112233",
"initiated_by": "bitpanda_swaps"
},
"target_offer": {"id": "d969468d-2be6-4522-977e-ea4d92c45e88",
"offer_id": "d969468d-2be6-4522-977e-ea4d92c45e89",
"type": "buy",
"fiat_id": 1,
"asset_id": 1,
"fiat_amount": "100.13",
"tax_amount": "100.14",
"total_amount": "100.15",
"asset_amount": "0.12345678",
"asset_price": "12.12345678",
"time": "2023-07-19T12:14:28+00:00",
"status": "completed",
"spread": "12.12345678",
"final_revenue_share": "100.16112233",
"initiated_by": "bitpanda_swaps"
}
}
}

Create a swap offer V2

By submitting a request to this endpoint, users can propose a swap offer, where they specify the assets they would like to exchange and the amount of units, either from the source or from the target asset. The request triggers the creation of a swap offer that can later be accepted by the user within its validity (as defined in offer_validity & expires_at response parameters).

The users can swap any asset that is present in their portfolio to any other supported digital asset on our platform. When swapping an asset, it is first sold as a fiat token (F-Token) before the desired asset is bought. This happens to avoid price fluctuations.

SecuritybearerAuth

Request

header Parameters

bp-user-id

required

string <uuid>

User ID

Request Body schema: application/json

The swap offer to be created.

source_asset_id required	string <uuid> The unique identifier of the asset to be sold when the swap is executed.
target_asset_id required	string <uuid> The unique identifier of the target asset to be acquired when the swap is executed.
amount required	string non-empty ^[0-9]+(\.[0-9]{1,8})?$ The quantity of the asset involved in the swap transaction. The specific amount will depend on the context defined by the 'amount_defined_for' parameter.
amount_defined_for required	string Specifies the context for the 'amount' parameter. If set to 'source', the 'amount' refers to the quantity or value of the 'source_asset_id' to be sold or exchanged. If set to 'target', the 'amount' refers to the quantity or value of the 'target_asset_id' to be acquired during the swap execution. Enum: "source" "target"

{"source_asset_id": "e730eb50-5254-4285-9b6b-21e78f979b6f",
"target_asset_id": "238c3c18-efa1-459c-b1bb-379156986326",
"amount": "1.00000001",
"amount_defined_for": "source"
}

Response samples

application/json

{"data": {"id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"source_asset_id": "e730eb50-5254-4285-9b6b-21e78f979b6f",
"target_asset_id": "238c3c18-efa1-459c-b1bb-379156986326",
"source_fiat_amount": "100.13",
"source_asset_amount": "0.00000001",
"target_asset_amount": "12.123",
"tax_amount": "0.10",
"net_asset_price": "1930.84694442",
"fee_amount": "0.45",
"fee_percentage": "2.25",
"time": "2025-09-04T12:32:01Z",
"expires_at": "2025-09-04T12:32:01Z",
"offer_validity": 60
}
}

Search for swaps V2

This endpoint allows you to search for finished swaps by date range, swap trade ID, or user ID, individually or in combination, with the search period limited to a maximum of 31 days.

SecuritybearerAuth

Request

query Parameters

date_start	string <date> Search swap trades by date_start. Example: date_start=2023-06-28
date_end	string <date> Search swap trades by date_end. Example: date_end=2023-06-28
swap_trade_id	string <uuid> Search swap trades by swap_trade_id. Example: swap_trade_id=d969468d-2be6-4522-977e-ea4d92c45e86
user_id	string <uuid> Search swap trades by user_id. Example: user_id=1edfadad-9ab8-6a30-9760-0242ac120003
page_size	integer [ 1 .. 100 ] Number of elements to be displayed on a page Example: page_size=10
page	integer >= 1 Display page number Example: page=1

Responses

200

List swap trades that match the search query parameters

Response Schema: application/json

	Array of objects (SwapTradesSearchV2)
	object (PaginationMeta)
	object (PaginationLinks)

get/v2/swaps/search

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"id": "d969468d-2be6-4522-977e-ea4d92c45e86",
"source_asset_id": "e730eb50-5254-4285-9b6b-21e78f979b6f",
"source_asset_symbol": "BTC",
"target_asset_id": "238c3c18-efa1-459c-b1bb-379156986326",
"target_asset_symbol": "ETH",
"source_asset_amount": "0.00000001",
"target_asset_amount": "12345.12345700",
"status": "completed",
"tax_amount": "0.10",
"user_id": "1edfadad-9ab8-6a30-9760-0242ac120003",
"time": "2023-07-19T12:14:28+00:00"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"id": "d969468d-2be6-4522-977e-ea4d92c45e86",
"external_swap_id": "d969468d-2be6-4522-977e-ea4d92c45e87",
"user_id": "1edfadad-9ab8-6a30-9760-0242ac120003",
"time": "2023-07-19T12:14:28+00:00",
"source_offer": {"id": "d969468d-2be6-4522-977e-ea4d92c45e88",
"offer_id": "d969468d-2be6-4522-977e-ea4d92c45e89",
"type": "buy",
"fiat_id": "d969468d-2be6-4522-977e-ea4d92c45e89",
"asset_id": "d969468d-2be6-4522-977e-ea4d92c45e89",
"fiat_amount": "100.13",
"tax_amount": "100.14",
"total_amount": "100.15",
"asset_amount": "0.12345678",
"asset_price": "12.12345678",
"time": "2023-07-19T12:14:28+00:00",
"status": "completed",
"spread": "12.12345678",
"final_revenue_share": "100.16112233",
"initiated_by": "bitpanda_swaps"
},
"target_offer": {"id": "d969468d-2be6-4522-977e-ea4d92c45e88",
"offer_id": "d969468d-2be6-4522-977e-ea4d92c45e89",
"type": "buy",
"fiat_id": "d969468d-2be6-4522-977e-ea4d92c45e89",
"asset_id": "d969468d-2be6-4522-977e-ea4d92c45e89",
"fiat_amount": "100.13",
"tax_amount": "100.14",
"total_amount": "100.15",
"asset_amount": "0.12345678",
"asset_price": "12.12345678",
"time": "2023-07-19T12:14:28+00:00",
"status": "completed",
"spread": "12.12345678",
"final_revenue_share": "100.16112233",
"initiated_by": "bitpanda_swaps"
}
}
}

Accept a swap offer

This endpoint enables the users to formally accept an existing swap offer. When sending a request, it must include the unique identifier of the swap offer the users wish to accept, thereby indicating their intention to proceed with the exchange under the conditions previously outlined. The endpoint is idempotent so in case of an unknown status code returned a retry to accept the swap should respond with the correct status.

SecuritybearerAuth

Request

path Parameters

Swap-Offer-Id

required

string <uuid>

A string parameter representing the unique identifier of the swap offer to be accepted. This ID should be included in the path of the request URL

query Parameters

external_swap_id

required

string [ 10 .. 100 ] characters

A string parameter representing an external swap ID associated with the offer. It should be included as a query parameter in the URL

header Parameters

bp-user-id

required

string <uuid>

A string parameter representing the User ID (uuid format).

Responses

200

Success Response (The swap trade has bee executed)

Response Schema: application/json

object (AcceptSwapOfferResponse)

202

Swap-Offer-Id

required

string <uuid>

A string parameter representing the unique identifier of the swap offer to be accepted. This ID should be included in the path of the request URL

query Parameters

external_swap_id

required

string [ 10 .. 100 ] characters

A string parameter representing an external swap ID associated with the offer. It should be included as a query parameter in the URL

header Parameters

bp-user-id

required

string <uuid>

A string parameter representing the User ID (uuid format).

Responses

200

Success Response (The swap trade has bee executed)

Response Schema: application/json

object (AcceptSwapOfferResponseV2)

202

Response samples

application/json

{"data": {"id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
"source_asset_id": "e730eb50-5254-4285-9b6b-21e78f979b6f",
"target_asset_id": "238c3c18-efa1-459c-b1bb-379156986326",
"source_fiat_amount": "100.13",
"source_asset_amount": "0.00000001",
"target_asset_amount": "12.123",
"tax_amount": "0.10",
"time": "2025-09-04T12:32:01Z"
}
}

Automated Orders

List automated orders

This endpoint allows partners to search and list automated orders by filters such as a date interval, a specific User ID, Asset ID or Order Type.

Partners can navigate easily by using a specific Order ID as cursor and also use page_size parameter to choose the number of items to be displayed.

If no query parameter is specified, the endpoint will return the first 25 records from the database.

SecuritybearerAuth

Request

query Parameters

date_start	string Start date for search in UTC timezone Example: date_start=2024-06-01T00:00:00Z
date_end	string End date for search in UTC timezone Example: date_end=2024-06-30T23:59:59Z
type	string Type Enum: "buy" "sell" Example: type=buy
user_id	string Unique User Identifier Example: user_id=abc2d123-a5db-4dd9-bd18-58a43c35b9ab
asset_id	string Unique Asset Identifier Example: asset_id=abc2d123-a5db-4dd9-bd18-58a43c35b9ab
cursor	string Unique Cursor Identifier Example: cursor=abc2d123-a5db-4dd9-bd18-58a43c35b9ab
page_size	integer Number of elements to be displayed on a page Example: page_size=10

Responses

200

List of orders

Response Schema: application/json

	Array of objects (ListOrderResponse)
	object (ResponseMeta)

401

Error

Response Schema: application/json

Array of objects

405

Not Allowed

422

Validation Errors

Response Schema: application/json

Array of objects

500

Error

Response Schema: application/json

Array of objects

503

Maintenance or Service unavailable

Response Schema: application/json

Array of objects

get/v1/orders

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

200
401
422
500
503

application/json

{"data": [{"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"status": "finished",
"target_price": "40743.41527688",
"amount": "1.89",
"type": "buy",
"user_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"asset_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"created_at": "2024-06-13T13:30:32Z",
"updated_at": "2024-08-02T08:05:35Z"
}
],
"meta": {"cursor": "abc2d123-a5db-4dd9-bd18-58a43c35b9ab",
"page_size": 15
}
}

Create an automated order

This endpoint allows partners to create an automated buy order for a user.

Users can specify a price target at which a buy order will be executed. Once the market price reaches the set target price, a market buy order will be automatically placed.

The target price can be above the current price to initiate an stop buy order or below the current price to initiate a limit-market order.

Coming soon: automated sell orders are expected in the future iterations. This feature will allow your users to set the target price below the current price to initiate a stop loss order or above the current price to initiate a take-profit order. We will keep you posted.

SecuritybearerAuth

Request

header Parameters

bp-user-id

required

string <uuid>

User ID

Request Body schema: application/json

The automated order to be created.

type required	string Order Type Enum: "buy" "sell"
fiat_id required	string <uuid> Fiat ID
asset_id required	string <uuid> Asset ID
amount required	string Fiat amount for the automated order.
target_price required	string The asset price at which the automated order is triggered. It can be above or below the current price.

Unprocessable Entity

Response Schema: application/json

Array of objects

500

Error

Response Schema: application/json

Array of objects

503

Maintenance or Service unavailable

Response Schema: application/json

Array of objects

post/v1/orders

Request samples

application/json

{"type": "buy",
"fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"asset_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"amount": "1.99",
"target_price": "40743.41527688"
}

Response samples

application/json

{"data": {"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"type": "buy",
"fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"asset_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"fiat_amount": "1.89",
"asset_amount": "0.00004884",
"target_price": "40743.41527688",
"created_at": "2024-06-13T13:30:32Z"
}
}

Get an automated order details

This endpoint allows partners to get details of an automated order for a user.

It displays extra information such as the asset amount for an order that has already been executed.

SecuritybearerAuth

Request

path Parameters

orderID

required

string <uuid>

A string parameter representing the unique identifier of the automated order. This ID should be included in the path of the request URL.

header Parameters

bp-user-id

required

string <uuid>

User ID

Error

Response Schema: application/json

Array of objects

503

Maintenance or Service unavailable

Response Schema: application/json

Array of objects

get/v1/orders/{orderID}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"status": "finished",
"target_price": "40743.41527688",
"amount": "1.89",
"asset_amount": "0.00004884",
"type": "buy",
"user_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"asset_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
"created_at": "2024-06-13T13:30:32Z"
}
}

Cancel an automated order

This endpoint allows partners to cancel an automated order for a user, if the order was not executed yet.

SecuritybearerAuth

Request

path Parameters

orderID

required

string <uuid>

A string parameter representing the unique identifier of the automated order to be cancelled. This ID should be included in the path of the request URL.

header Parameters

bp-user-id

required

string <uuid>

User ID

Responses

204

Success Response (order has been cancelled)

400

Error

Response Schema: application/json

Array of objects

401

Unauthorized

Response Schema: application/json

Array of objects

403

Account is inactive

Response Schema: application/json

Array of objects

404

Not Found

Response Schema: application/json

Array of objects

405

Not Allowed

500

Error

Response Schema: application/json

Array of objects

503

Maintenance or Service unavailable

Response Schema: application/json

Array of objects

delete/v1/orders/{orderID}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"errors": [{"code": "http.bad.request",
"title": "bp-user-id Header is missing."
}
]
}

Corporate onboarding

Get risk questions

The endpoint returns the list of all possible risk questions and answers that the business needs to select during the onboarding process before starting investing.

You can pass the parameter Accept-Language with a string containing ISO 639-1 language code to get the list of risk questions and answers translated into the chosen language. Currently, Bitpanda supports translations for English and German. The default language is English (en). If you pass the parameter for a language that does not have an existing translation in our database, the response returns the risk questions and answers in English.

SecuritybearerAuth

Request

header Parameters

Accept-Language

string

ISO 639-1 language used for translation

Example: en

Array of objects

get/v1/risk

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": [{"slug": "risk_question_account_purpose",
"question": "What is the purpose of opening a Bitpanda account?",
"translation_key": "bts.risk.question.account.purpose",
"sort": 1,
"type": "multiple_choice",
"answers": [{"slug": "risk_answer_long_term_investment",
"answer": "Long-term investment (including staking of digital assets)",
"translation_key": "bts.risk.answer.long.term.investment",
"sort": 1
}
]
}
]
}

Get a list of available businesses

The endpoint returns a list of all businesses enabled globally for the Partner

SecuritybearerAuth

Request

query Parameters

external_id	string Query to search businesses by external ID Example: external_id=ext-id
name	string Query to search businesses by name Example: name=test
pid	string <uuid> Query to search businesses by PID Example: pid=550e8400-e29b-41d4-a716-446655440000
status	string Filter businesses by status Enum: "approved" "not_approved" Example: status=approved
page_size	integer Number of elements to be displayed on a page Example: page_size=1
page	integer Display page number Example: page=1
sort_by	string Sort businesses Enum: "name" "reviewed_at" "created_at" Example: sort_by=reviewed_at
sort_order	string Sort order Enum: "asc" "desc" Example: sort_order=desc

Responses

200

List businesses

Response Schema: application/json

	Array of objects (Business)
	object (PaginationMeta)
	object (PaginationLinks)

external_id	string External ID
full_legal_name required	string
business_name	string
email	string
website	string
required	object
legal_type required	string
registration_number required	string
lei_number	string
service	string
industry required	string
tax_number	string
vat_number	string
nace_code	string
account_purpose	string
ext_risk_level	string
ext_pep_status	string
last_kyc_update	string
next_kyc_update	string
us_tax_residency	boolean
entity_tax_classification	string (EntityTaxClassification) Entity tax classification Enum: "investment-entity-managed" "investment-entity-other" "financial-institution-other" "publicly-traded-entity" "government-central-bank" "international-organisation" "active-nfe" "passive-nfe"
acting_on_own_behalf required	boolean
terms	Array of integers The IDs of the accepted terms and conditions and privacy policy
	Array of objects (AmlQuestionAnswerRequest)
	Array of objects (AppropriatenessQuestionAnswerRequest) Appropriateness test answers shall be provided latest before the first trade with stocks or ETFs
	Array of objects (RiskQuestionAnswerRequest)
	Array of objects (UserMultipleTax)

Array of objects

post/v1/businesses

Request samples

application/json

{"external_id": "Ext-Id-1",
"full_legal_name": "Acme Inc",
"business_name": "Acme",
"email": "username@acme.com",
"website": "http://acme.com",
"address": {"street": "123 Main Street",
"city": "Evergreen",
"zip_code": "12345",
"country": "FR"
},
"legal_type": "GmbH",
"registration_number": "AB123CD",
"lei_number": "549300E00W82GZ93PU70",
"service": "Digital Services",
"industry": "IT Services",
"tax_number": "123-45-6789",
"vat_number": "FR987654321",
"nace_code": "62.010 - Computer programming activities",
"account_purpose": "Research and Development",
"ext_risk_level": "Moderate Risk",
"ext_pep_status": "PEP: Family Member",
"last_kyc_update": "2022-07-20T08:14:20+00:00",
"next_kyc_update": "2023-07-20T08:14:20+00:00",
"us_tax_residency": false,
"entity_tax_classification": "investment-entity-managed",
"acting_on_own_behalf": true,
"terms": [1,
2
],
"aml": [{"question_id": 1,
"answer_id": 2,
"answer_value": "Free text user answer"
}
],
"appropriateness": [{"question_id": 1,
"answer_id": 2,
"value": "BP 21321412421"
}
],
"risk": [{"question_slug": "risk_question_account_purpose",
"answer_slug": "risk_answer_long_term_investment"
}
],
"tax_identification_numbers": [{"id": "12345678",
"residence": "AT"
}
]
}

Response samples

application/json

{"data": {"business_id": "1ee6439d-efd5-6946-80c2-7312392495b8",
"user_id": "6d7653c6-8ea5-4096-a30e-c86d8eee7d9d"
}
}

Get business details

The endpoint returns the business’s details based on business ID

SecuritybearerAuth

Request

path Parameters

Business-ID

required

string <uuid>

Business-ID

query Parameters

user_journey

string (UserJourney)

Filters terms_not_accepted for a specific user journey. If not provided, all not accepted terms are included in the response.

Enum: "onboarding" "trading_stocks_buy" "trading_stocks_sell" "trading_etf_buy" "trading_etf_sell" "trading_metals_buy" "trading_metals_sell" "change_of_circumstances_dac8" "appropriateness_consent" "appropriateness_warning"

header Parameters

Accept-Language

string

ISO 639-1 2-letter code representing user's language

Example: en

Array of objects

get/v1/businesses/{Business-ID}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"id": "96f0c981-357e-4439-9bc1-05432326cca5",
"user_id": "cbc316b7-18ad-4c94-b472-d9408d0703d0",
"external_id": "Ext-Id-1",
"full_legal_name": "GmbH AB",
"business_name": "461 53",
"email": "business@bitpanda.com",
"website": "www.bitpanda.com",
"address": {"city": "Wien",
"street": "Stella-Klein-Löw Weg 17",
"zip_code": "1020",
"country": "AUT"
},
"industry": "Financial Services",
"legal_type": "Private company limited by shares",
"registration_number": "FN10084e",
"service": "Investments",
"tax_number": "559091-3127",
"acting_on_own_behalf": true,
"user_is_active": false,
"lei_number": "529900T8BM49AURSDO55",
"vat_number": "ATU12345678",
"nace_code": "6430",
"account_purpose": "test",
"ext_risk_level": "test",
"ext_pep_status": "Global",
"last_kyc_update": "2022-07-20T08:14:20+00:00",
"next_kyc_update": "2023-07-20T08:14:20+00:00",
"us_tax_residency": false,
"entity_tax_classification": "investment-entity-managed",
"business_approved": false,
"is_onboarded": true,
"trading_active": true,
"crypto_withdrawals_active": true,
"terms_not_accepted": [1,
2
]
}
}

Update an existing business

The endpoint allows to update the details for existing business.

SecuritybearerAuth

Request

path Parameters

Business-ID

required

string <uuid>

Business ID

Example: 1ee6439d-efd5-6946-80c2-7312392495b8

Request Body schema: application/json

Request details

external_id	string External ID
full_legal_name	string
business_name	string
email	string
website	string
	object
legal_type	string
registration_number	string
lei_number	string
service	string
industry	string
tax_number	string
vat_number	string
nace_code	string
account_purpose	string
ext_risk_level	string
ext_pep_status	string
last_kyc_update	string
next_kyc_update	string
us_tax_residency	boolean
entity_tax_classification	string (EntityTaxClassification) Entity tax classification Enum: "investment-entity-managed" "investment-entity-other" "financial-institution-other" "publicly-traded-entity" "government-central-bank" "international-organisation" "active-nfe" "passive-nfe"
acting_on_own_behalf	boolean
terms	Array of integers The IDs of the accepted terms and conditions and privacy policy
	Array of objects (AmlQuestionAnswerRequest)
	Array of objects (AppropriatenessQuestionAnswerRequest) Appropriateness test answers shall be provided latest before the first trade with stocks or ETFs
	Array of objects (RiskQuestionAnswerRequest)
	Array of objects (UserMultipleTax)

{"external_id": "Ext-Id-1",
"full_legal_name": "Acme Inc",
"business_name": "Acme",
"email": "username@acme.com",
"website": "http://acme.com",
"address": {"street": "123 Main Street",
"city": "Evergreen",
"zip_code": "12345",
"country": "FR"
},
"legal_type": "GmbH",
"registration_number": "AB123CD",
"lei_number": "549300E00W82GZ93PU70",
"service": "Digital Services",
"industry": "IT Services",
"tax_number": "123-45-6789",
"vat_number": "FR987654321",
"nace_code": "62.010 - Computer programming activities",
"account_purpose": "Research and Development",
"ext_risk_level": "Moderate Risk",
"ext_pep_status": "PEP: Family Member",
"last_kyc_update": "2022-07-20T08:14:20+00:00",
"next_kyc_update": "2023-07-20T08:14:20+00:00",
"us_tax_residency": false,
"entity_tax_classification": "investment-entity-managed",
"acting_on_own_behalf": true,
"terms": [1,
2
],
"aml": [{"question_id": 1,
"answer_id": 2,
"answer_value": "Free text user answer"
}
],
"appropriateness": [{"question_id": 1,
"answer_id": 2,
"value": "BP 21321412421"
}
],
"risk": [{"question_slug": "risk_question_account_purpose",
"answer_slug": "risk_answer_long_term_investment"
}
],
"tax_identification_numbers": [{"id": "12345678",
"residence": "AT"
}
]
}

Response samples

application/json

{"data": {"business_id": "1ee6439d-efd5-6946-80c2-7312392495b8",
"user_id": "6d7653c6-8ea5-4096-a30e-c86d8eee7d9d"
}
}

Create Authorized Individual

The endpoint allows to create a new Authorized Individual.

SecuritybearerAuth

Request

path Parameters

Business-ID

required

string <uuid>

Business-ID

Request Body schema: application/json

Request details

external_id	string External ID
first_name required	string First name
last_name required	string Last name
email	string Email address
phone	string Phone number
birth_place required	string Birth place
birth_date required	string Birth date in YYYY-MM-DD format. Authorized individual must be older than 18 years, but not older than 100 years.
citizenship required	string Citizenship country code in ISO 3166-1 alpha-2
required	object
required	object
ext_pep_status	string External PEP status

Array of objects

post/v1/businesses/{Business-ID}/authorized-individuals

Request samples

application/json

{"external_id": "Ext-Id-1",
"first_name": "FirstName",
"last_name": "LastName",
"email": "firstname.lastname@domain.tld",
"phone": "38712345678",
"birth_place": "Barcelona",
"birth_date": "1990-12-31",
"citizenship": "AT",
"address": {"street": "123 Main Street",
"city": "Vienna",
"zip_code": "12345",
"country": "AU"
},
"identification_document": {"type": "passport",
"number": "AB123456",
"issuing_country": "AT",
"issuing_authority": "AT Government",
"expiration_date": "2030-12-31",
"mrz_code": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<L898902C<3UTO6908061F9406236ZE184226B<<<<<14"
},
"ext_pep_status": "External PEP status value"
}

Response samples

application/json

{"data": {"id": "77606486-8ce8-11ee-bcac-bfa9d1985705"
}
}

Get a list of Authorized Individuals

The endpoint returns a list of all Authorized Individuals for a specific Business ID

SecuritybearerAuth

Request

path Parameters

Business-ID

required

string <uuid>

Business-ID

query Parameters

external_id	string Query to search authorized individuals by external ID Example: external_id=ext-id
page_size	integer Number of elements to be displayed on a page Example: page_size=1
page	integer Display page number Example: page=1
sort_by	string Sort authorized individuals Enum: "first_name" "last_name" "created_at" Example: sort_by=created_at
sort_order	string Sort order Enum: "asc" "desc" Example: sort_order=desc

Responses

200

Authorized Individuals list

Response Schema: application/json

	Array of objects (AuthorizedIndividual)
	object (PaginationMeta)
	object (PaginationLinks)

application/json

{"data": [{"id": "cc560924-8cf6-11ee-b6ca-e718b143a0ff",
"external_id": "Ext-Id-1",
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@domain.tld",
"phone": "+33204231487",
"birth_place": "Vienna",
"birth_date": "1984-12-31",
"citizenship": "AT",
"address": {"city": "Berlin",
"street": "2nd Street",
"zip_code": "012345",
"country": "DE"
},
"identification_document": {"type": "passport",
"number": "AB123456",
"issuing_authority": "AT Government",
"issuing_country": "string",
"expiration_date": "2030-12-31",
"mrz_code": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<L898902C<3UTO6908061F9406236ZE184226B<<<<<14"
},
"ext_pep_status": "External PEP status value"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Get Authorized Individual details

The endpoint returns the Authorized Individual’s details based on Business-ID and Authorized-Individual-ID

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Authorized-Individual-ID required	string <uuid> Authorized-Individual-ID

Array of objects

get/v1/businesses/{Business-ID}/authorized-individuals/{Authorized-Individual-ID}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"id": "cc560924-8cf6-11ee-b6ca-e718b143a0ff",
"external_id": "Ext-Id-1",
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@domain.tld",
"phone": "+33204231487",
"birth_place": "Vienna",
"birth_date": "1984-12-31",
"citizenship": "AT",
"address": {"city": "Berlin",
"street": "2nd Street",
"zip_code": "012345",
"country": "DE"
},
"identification_document": {"type": "passport",
"number": "AB123456",
"issuing_authority": "AT Government",
"issuing_country": "string",
"expiration_date": "2030-12-31",
"mrz_code": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<L898902C<3UTO6908061F9406236ZE184226B<<<<<14"
},
"ext_pep_status": "External PEP status value"
}
}

Update Authorized Individual

The endpoint allows to update an existing Authorized Individual.

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Authorized-Individual-ID required	string <uuid> Authorized-Individual-ID

Request Body schema: application/json

Request details

external_id	string External ID
first_name	string First name
last_name	string Last name
email	string Email address
phone	string Phone number
birth_place	string Birth place
birth_date	string Birth date in YYYY-MM-DD format
citizenship	string Citizenship country code in ISO 3166-1 alpha-2
	object
	object
ext_pep_status	string External PEP status

{"external_id": "Ext-Id-1",
"first_name": "FirstName",
"last_name": "LastName",
"email": "firstname.lastname@domain.tld",
"phone": "38712345678",
"birth_place": "Barcelona",
"birth_date": "1990-12-31",
"citizenship": "AT",
"address": {"street": "123 Main Street",
"city": "Vienna",
"zip_code": "12345",
"country": "AU"
},
"identification_document": {"type": "passport",
"number": "AB123456",
"issuing_country": "AT",
"issuing_authority": "AT Government",
"expiration_date": "2030-12-31",
"mrz_code": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<L898902C<3UTO6908061F9406236ZE184226B<<<<<14"
},
"ext_pep_status": "External PEP status value"
}

Response samples

application/json

{"data": {"id": "77606486-8ce8-11ee-bcac-bfa9d1985705"
}
}

Delete Authorized Individual

The endpoint allows to delete an existing Authorized Individual.

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Authorized-Individual-ID required	string <uuid> Authorized-Individual-ID

Responses

204

Response samples

401
403
404
500
503

application/json

{"errors": [{"code": "unauthorized",
"title": "Credentials / Access token wrong"
}
]
}

Create Shareholder

The endpoint allows to create a new Shareholder.

SecuritybearerAuth

Request

path Parameters

Business-ID

required

string <uuid>

Business-ID

Request Body schema: application/json

Request details

legal_name required	string Legal Name
person_type required	string Person type Enum: "legal_person" "natural_person"
birth_date required	string Birth date in YYYY-MM-DD format. Shareholder must be older than 18 years, but not older than 100 years.
residence required	string Residence country in ISO 3166-1 alpha-2
direct_ownership_percentage required	number <float> Direct ownership percentage

Array of objects

post/v1/businesses/{Business-ID}/shareholders

Request samples

application/json

{"legal_name": "John Smith",
"person_type": "legal_person",
"birth_date": "1990-12-31",
"residence": "AT",
"direct_ownership_percentage": 0.51
}

Response samples

application/json

{"data": {"id": "2964a7e6-9982-11ee-a325-072e160d82d3"
}
}

Get a list of Shareholders

The endpoint returns a list of all Shareholders for a specific Business ID

SecuritybearerAuth

Request

path Parameters

Business-ID

required

string <uuid>

Business-ID

query Parameters

page_size	integer Number of elements to be displayed on a page Example: page_size=1
page	integer Display page number Example: page=1
sort_by	string Sort shareholders Enum: "legal_name" "created_at" Example: sort_by=created_at
sort_order	string Sort order Enum: "asc" "desc" Example: sort_order=desc

Responses

200

Shareholder list

Response Schema: application/json

	Array of objects (Shareholder)
	object (PaginationMeta)
	object (PaginationLinks)

application/json

{"data": [{"id": "566bad6c-9986-11ee-bc1a-43c565de2296",
"legal_name": "FirstName LastName",
"person_type": "legal_person",
"birth_date": "1982-12-31",
"residence": "AT",
"direct_ownership_percentage": 0.51
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Get Shareholder details

The endpoint returns the Shareholder's details based on Business-ID and Shareholder-ID

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Shareholder-ID required	string <uuid> Shareholder-ID

Array of objects

get/v1/businesses/{Business-ID}/shareholders/{Shareholder-ID}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"id": "566bad6c-9986-11ee-bc1a-43c565de2296",
"legal_name": "FirstName LastName",
"person_type": "legal_person",
"birth_date": "1982-12-31",
"residence": "AT",
"direct_ownership_percentage": 0.51
}
}

Update Shareholder

The endpoint allows to update an existing Shareholder.

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Shareholder-ID required	string <uuid> Shareholder-ID

Request Body schema: application/json

Request details

legal_name	string Legal Name
person_type	string Person type Enum: "legal_person" "natural_person"
birth_date	string Birth date in YYYY-MM-DD format
residence	string Residence country in ISO 3166-1 alpha-2
direct_ownership_percentage	number <float> Direct ownership percentage

{"legal_name": "John Smith",
"person_type": "legal_person",
"birth_date": "1990-12-31",
"residence": "AT",
"direct_ownership_percentage": 0.51
}

Response samples

application/json

{"data": {"id": "3f2ac204-9987-11ee-b770-079bffac0a9f"
}
}

Delete Shareholder

The endpoint allows to delete an existing Shareholder.

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Shareholder-ID required	string <uuid> Shareholder-ID

Responses

204

Response samples

401
403
404
500
503

application/json

{"errors": [{"code": "unauthorized",
"title": "Credentials / Access token wrong"
}
]
}

Create Beneficial Owner

The endpoint allows to create a new Beneficial Owner.

SecuritybearerAuth

Request

path Parameters

Business-ID

required

string <uuid>

Business-ID

Request Body schema: application/json

Request details

ownership_percentage required	number <float> Ownership percentage (numeric value between 0 and 1)
first_name required	string First name
last_name required	string Last name
citizenship required	string Citizenship country code in ISO 3166-1 alpha-2
birth_date required	string Birth date in YYYY-MM-DD format. Beneficial owner must be older than 18 years, but not older than 100 years.
place_of_birth	string Place of birth
ext_pep_status	string External PEP status
required	object
	object
beneficial_owner_type	string (BeneficialOwnerType) Beneficial owner type Enum: "ownership" "control"
beneficial_owner_controlling_person_type	string (BeneficialOwnerControllingPersonType) Controlling person type (for beneficial_owner_type: control only!) Enum: "legal-person-ownership" "legal-person-other-means" "legal-person-senior-official" "trust-settlor" "trust-trustee" "trust-protector" "trust-beneficiary" "trust-other" "legal-arrangement-settlor-equivalent" "legal-arrangement-trustee-equivalent" "legal-arrangement-protector-equivalent" "legal-arrangement-beneficiary-equivalent" "legal-arrangement-other-equivalent"
	Array of objects (UserMultipleTax)

Array of objects

post/v1/businesses/{Business-ID}/beneficial-owners

Request samples

application/json

{"ownership_percentage": "0.75",
"first_name": "John",
"last_name": "Doe",
"citizenship": "AT",
"birth_date": "1990-12-31",
"place_of_birth": "Barcelona",
"ext_pep_status": "Not PEP",
"address": {"country": "AT",
"street": "123 Main Street",
"city": "Vienna",
"zip_code": "10001"
},
"identification_document": {"type": "passport",
"number": "AB123456",
"issuing_country": "AT",
"issuing_authority": "AT Government",
"expiration_date": "2030-12-31",
"mrz_code": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<L898902C<3UTO6908061F9406236ZE184226B<<<<<14"
},
"beneficial_owner_type": "ownership",
"beneficial_owner_controlling_person_type": "legal-person-ownership",
"tax_identification_numbers": [{"id": "12345678",
"residence": "AT"
}
]
}

Response samples

application/json

{"data": {"id": "77606486-8ce8-11ee-bcac-bfa9d1985705"
}
}

Get a list of Beneficial Owners

The endpoint returns a list of all Beneficial Owners for a specific Business ID

SecuritybearerAuth

Request

path Parameters

Business-ID

required

string <uuid>

Business-ID

query Parameters

page_size	integer Number of elements to be displayed on a page Example: page_size=1
page	integer Display page number Example: page=1
sort_by	string Sort beneficial owners Enum: "first_name" "last_name" "created_at" Example: sort_by=created_at
sort_order	string Sort order Enum: "asc" "desc" Example: sort_order=desc

Responses

200

Beneficial Owners list

Response Schema: application/json

	Array of objects (BeneficialOwner)
	object (PaginationMeta)
	object (PaginationLinks)

application/json

{"data": [{"id": "cc560924-8cf6-11ee-b6ca-e718b143a0ff",
"first_name": "John",
"last_name": "Smith",
"birth_date": "1984-12-31",
"place_of_birth": "Vienna",
"citizenship": "AT",
"ext_pep_status": "External PEP status value",
"ownership_percentage": "0.50",
"address": {"country": "AT",
"street": "123 Main Street",
"city": "New York",
"zip_code": "10001"
},
"identification_document": {"type": "passport",
"number": "AB123456",
"issuing_authority": "AT Government",
"issuing_country": "string",
"expiration_date": "2030-12-31",
"mrz_code": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<L898902C<3UTO6908061F9406236ZE184226B<<<<<14"
},
"beneficial_owner_type": "ownership",
"beneficial_owner_controlling_person_type": "legal-person-ownership",
"created_at": "2021-01-01T00:00:00Z"
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Get Beneficial Owner details

The endpoint returns the Beneficial Owner's details based on Business-ID and Beneficial-Owner-ID

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Beneficial-Owner-ID required	string <uuid> Beneficial-Owner-ID

Array of objects

get/v1/businesses/{Business-ID}/beneficial-owners/{Beneficial-Owner-ID}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"id": "cc560924-8cf6-11ee-b6ca-e718b143a0ff",
"first_name": "John",
"last_name": "Smith",
"birth_date": "1984-12-31",
"place_of_birth": "Vienna",
"citizenship": "AT",
"ext_pep_status": "External PEP status value",
"ownership_percentage": "0.50",
"address": {"country": "AT",
"street": "123 Main Street",
"city": "New York",
"zip_code": "10001"
},
"identification_document": {"type": "passport",
"number": "AB123456",
"issuing_authority": "AT Government",
"issuing_country": "string",
"expiration_date": "2030-12-31",
"mrz_code": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<L898902C<3UTO6908061F9406236ZE184226B<<<<<14"
},
"beneficial_owner_type": "ownership",
"beneficial_owner_controlling_person_type": "legal-person-ownership",
"created_at": "2021-01-01T00:00:00Z"
}
}

Update Beneficial Owner

The endpoint allows to update an existing Beneficial Owner.

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Beneficial-Owner-ID required	string <uuid> Beneficial-Owner-ID

Request Body schema: application/json

Request details

ownership_percentage	number <float> Ownership percentage (numeric value between 0 and 1)
first_name	string First name
last_name	string Last name
citizenship	string Citizenship country code in ISO 3166-1 alpha-2
birth_date	string Birth date in YYYY-MM-DD format
place_of_birth	string Place of birth
ext_pep_status	string External PEP status
	object
	object
beneficial_owner_type	string (BeneficialOwnerType) Beneficial owner type Enum: "ownership" "control"
beneficial_owner_controlling_person_type	string (BeneficialOwnerControllingPersonType) Controlling person type (for beneficial_owner_type: control only!) Enum: "legal-person-ownership" "legal-person-other-means" "legal-person-senior-official" "trust-settlor" "trust-trustee" "trust-protector" "trust-beneficiary" "trust-other" "legal-arrangement-settlor-equivalent" "legal-arrangement-trustee-equivalent" "legal-arrangement-protector-equivalent" "legal-arrangement-beneficiary-equivalent" "legal-arrangement-other-equivalent"
	Array of objects (UserMultipleTax)

{"ownership_percentage": "0.75",
"first_name": "John",
"last_name": "Doe",
"citizenship": "AT",
"birth_date": "1990-12-31",
"place_of_birth": "Barcelona",
"ext_pep_status": "Not PEP",
"address": {"country": "AT",
"street": "123 Main Street",
"city": "Vienna",
"zip_code": "10001"
},
"identification_document": {"type": "passport",
"number": "AB123456",
"issuing_country": "AT",
"issuing_authority": "AT Government",
"expiration_date": "2030-12-31",
"mrz_code": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<L898902C<3UTO6908061F9406236ZE184226B<<<<<14"
},
"beneficial_owner_type": "ownership",
"beneficial_owner_controlling_person_type": "legal-person-ownership",
"tax_identification_numbers": [{"id": "12345678",
"residence": "AT"
}
]
}

Response samples

application/json

{"data": {"id": "77606486-8ce8-11ee-bcac-bfa9d1985705"
}
}

Delete Beneficial Owner

The endpoint allows to delete an existing Beneficial Owner.

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Beneficial-Owner-ID required	string <uuid> Beneficial-Owner-ID

Responses

204

Response samples

401
403
404
500
503

application/json

{"errors": [{"code": "unauthorized",
"title": "Credentials / Access token wrong"
}
]
}

Create Managing Director

The endpoint allows to create a new Managing Director.

SecuritybearerAuth

Request

path Parameters

Business-ID

required

string <uuid>

Business-ID

Request Body schema: application/json

Request details

legal_name required	string Legal Name
person_type required	string Person type Enum: "legal_person" "natural_person"
legal_form	string Legal Form. Required when person_type is legal_person.
register_number	string Register Number. Required when person_type is legal_person.
	object

Array of objects

post/v1/businesses/{Business-ID}/managing-directors

Request samples

application/json

{"legal_name": "John Smith",
"person_type": "legal_person",
"legal_form": "some_legal_form",
"register_number": "AT 1441251007-2",
"address": {"street": "123 Main Street",
"city": "Vienna",
"zip_code": "12345",
"country": "AU"
}
}

Response samples

application/json

{"data": {"id": "d8617058-a08f-11ee-8d4f-67848daf62d9"
}
}

Get a list of Managing Directors

The endpoint returns a list of all Managing Directors for a specific Business ID

SecuritybearerAuth

Request

path Parameters

Business-ID

required

string <uuid>

Business-ID

query Parameters

page_size	integer Number of elements to be displayed on a page Example: page_size=1
page	integer Display page number Example: page=1
sort_by	string Sort managing directors Enum: "legal_name" "created_at" Example: sort_by=created_at
sort_order	string Sort order Enum: "asc" "desc" Example: sort_order=desc

Responses

200

Managing Director list

Response Schema: application/json

	Array of objects (ManagingDirector)
	object (PaginationMeta)
	object (PaginationLinks)

application/json

{"data": [{"id": "73423748-a08f-11ee-b238-e3a7c1f3336c",
"legal_name": "FirstName LastName",
"person_type": "legal_person",
"legal_form": "some_legal_form",
"register_number": "AT 1441251007-2",
"address": {"street": "2nd Street",
"city": "Berlin",
"zip_code": "012345",
"country": "DE"
}
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Get Managing Director details

The endpoint returns the Managing Director's details based on Business-ID and Managing-Director-ID

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Managing-Director-ID required	string <uuid> Managing-Director-ID

Array of objects

get/v1/businesses/{Business-ID}/managing-directors/{Managing-Director-ID}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"id": "73423748-a08f-11ee-b238-e3a7c1f3336c",
"legal_name": "FirstName LastName",
"person_type": "legal_person",
"legal_form": "some_legal_form",
"register_number": "AT 1441251007-2",
"address": {"street": "2nd Street",
"city": "Berlin",
"zip_code": "012345",
"country": "DE"
}
}
}

Update Managing Director

The endpoint allows to update an existing Managing Director.

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Managing-Director-ID required	string <uuid> Managing-Director-ID

Request Body schema: application/json

Request details

legal_name	string Legal Name
person_type	string Person type Enum: "legal_person" "natural_person"
legal_form	string Legal Form
register_number	string Register Number
	object

{"legal_name": "John Smith",
"person_type": "legal_person",
"legal_form": "some_legal_form",
"register_number": "AT 1441251007-2",
"address": {"street": "123 Main Street",
"city": "Vienna",
"zip_code": "12345",
"country": "AU"
}
}

Response samples

application/json

{"data": {"id": "018855c2-a091-11ee-8269-1f359b9f7b82"
}
}

Delete Managing Director

The endpoint allows to delete an existing Managing Director.

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Managing-Director-ID required	string <uuid> Managing-Director-ID

Responses

204

Response samples

401
403
404
500
503

application/json

{"errors": [{"code": "unauthorized",
"title": "Credentials / Access token wrong"
}
]
}

Create Individual

The endpoint allows to create a new Individual.

SecuritybearerAuth

Request

path Parameters

Business-ID

required

string <uuid>

Business-ID

Request Body schema: application/json

Request details

external_id	string External ID
first_name required	string First name
last_name required	string Last name
email	string Email address
phone	string Phone number
birth_place required	string Birth place
birth_date required	string Birth date in YYYY-MM-DD format. Individual must be older than 18 years, but not older than 100 years.
citizenship required	string Citizenship country code in ISO 3166-1 alpha-2
required	object
required	object

Array of objects

post/v1/businesses/{Business-ID}/individuals

Request samples

application/json

{"external_id": "Ext-Id-1",
"first_name": "FirstName",
"last_name": "LastName",
"email": "firstname.lastname@domain.tld",
"phone": "38712345678",
"birth_place": "Barcelona",
"birth_date": "1990-12-31",
"citizenship": "AT",
"address": {"street": "123 Main Street",
"city": "Vienna",
"zip_code": "12345",
"country": "AU"
},
"identification_document": {"type": "passport",
"number": "AB123456",
"issuing_country": "AT",
"issuing_authority": "AT Government",
"expiration_date": "2030-12-31",
"mrz_code": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<L898902C<3UTO6908061F9406236ZE184226B<<<<<14"
}
}

Response samples

application/json

{"data": {"id": "77606486-8ce8-11ee-bcac-bfa9d1985705"
}
}

Get a list of Individuals

The endpoint returns a list of all Individuals for a specific Business ID

SecuritybearerAuth

Request

path Parameters

Business-ID

required

string <uuid>

Business-ID

query Parameters

external_id	string Query to search individuals by external ID Example: external_id=ext-id
page_size	integer Number of elements to be displayed on a page Example: page_size=1
page	integer Display page number Example: page=1
sort_by	string Sort individuals Enum: "first_name" "last_name" "created_at" Example: sort_by=created_at
sort_order	string Sort order Enum: "asc" "desc" Example: sort_order=desc

Responses

200

Individuals list

Response Schema: application/json

	Array of objects (Individual)
	object (PaginationMeta)
	object (PaginationLinks)

application/json

{"data": [{"id": "cc560924-8cf6-11ee-b6ca-e718b143a0ff",
"external_id": "Ext-Id-1",
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@domain.tld",
"phone": "+33204231487",
"birth_place": "Vienna",
"birth_date": "1984-12-31",
"citizenship": "AT",
"address": {"city": "Berlin",
"street": "2nd Street",
"zip_code": "012345",
"country": "DE"
},
"identification_document": {"type": "passport",
"number": "AB123456",
"issuing_authority": "AT Government",
"issuing_country": "string",
"expiration_date": "2030-12-31",
"mrz_code": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<L898902C<3UTO6908061F9406236ZE184226B<<<<<14"
}
}
],
"meta": {"total_count": 48,
"page": 3,
"page_size": 10
},
"links": {"first": "?page=1&page_size=10",
"last": "?page=5&page_size=10",
"prev": "?page=2&page_size=10",
"next": "?page=4&page_size=10",
"self": "?page=3&page_size=10"
}
}

Get Individual details

The endpoint returns the Individual’s details based on Business-ID and Individual-ID

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Individual-ID required	string <uuid> Individual-ID

Array of objects

get/v1/businesses/{Business-ID}/individuals/{Individual-ID}

Request samples

curl
Node.js
JavaScript
Python
PHP

Response samples

application/json

{"data": {"id": "cc560924-8cf6-11ee-b6ca-e718b143a0ff",
"external_id": "Ext-Id-1",
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@domain.tld",
"phone": "+33204231487",
"birth_place": "Vienna",
"birth_date": "1984-12-31",
"citizenship": "AT",
"address": {"city": "Berlin",
"street": "2nd Street",
"zip_code": "012345",
"country": "DE"
},
"identification_document": {"type": "passport",
"number": "AB123456",
"issuing_authority": "AT Government",
"issuing_country": "string",
"expiration_date": "2030-12-31",
"mrz_code": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<L898902C<3UTO6908061F9406236ZE184226B<<<<<14"
}
}
}

Update Individual

The endpoint allows to update an existing Individual.

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Individual-ID required	string <uuid> Individual-ID

Request Body schema: application/json

Request details

external_id	string External ID
first_name	string First name
last_name	string Last name
email	string Email address
phone	string Phone number
birth_place	string Birth place
birth_date	string Birth date in YYYY-MM-DD format
citizenship	string Citizenship country code in ISO 3166-1 alpha-2
	object
	object

{"external_id": "Ext-Id-1",
"first_name": "FirstName",
"last_name": "LastName",
"email": "firstname.lastname@domain.tld",
"phone": "38712345678",
"birth_place": "Barcelona",
"birth_date": "1990-12-31",
"citizenship": "AT",
"address": {"street": "123 Main Street",
"city": "Vienna",
"zip_code": "12345",
"country": "AU"
},
"identification_document": {"type": "passport",
"number": "AB123456",
"issuing_country": "AT",
"issuing_authority": "AT Government",
"expiration_date": "2030-12-31",
"mrz_code": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<L898902C<3UTO6908061F9406236ZE184226B<<<<<14"
}
}

Response samples

application/json

{"data": {"id": "77606486-8ce8-11ee-bcac-bfa9d1985705"
}
}

Delete Individual

The endpoint allows to delete an existing Individual.

SecuritybearerAuth

Request

path Parameters

Business-ID required	string <uuid> Business-ID
Individual-ID required	string <uuid> Individual-ID

Responses

204

Response samples

401
403
404
500
503

application/json

{"errors": [{"code": "unauthorized",
"title": "Credentials / Access token wrong"
}
]
}