Reference Guide Overview
Use this guide to find information on a specific component like a request.
Requests
Requests are operations that are sent to the API and that return information from it. The information is attached in the JSON format.
Requests are sent to URLs called endpoints. The endpoints of this API are listed in the following table:
Endpoint | Requests |
---|---|
Tax (/api/v2/tax ) | Calculate tax Validate VAT number |
Transactions (/api/v2/transactions ) | Confirm transaction Un-confirm transaction Retrieve full transaction Store transaction Browse transactions Retrieve transaction Cancel transaction |
Refunds (/api/v2/transactions/{key}/refunds ) | Cancel refund by subnumber Create a refund Get transaction refunds Cancel refund |
Events (/api/v2/webhook_events/{event-id} ) | Get event data |
Fields
Fields can be specified in the JSON that is attached to your requests and in the responses to those requests.
The following table lists the topics in this section:
Topic | Description |
---|---|
Transaction Schema | The fields for modelling transactions such as amount, addresses, buyer information and more. |
Vertex Validator Schema | The fields for Tax ID validation that are used by Vertex Validator. |
Address Schema | Fields for modelling addresses. |
Location Evidence Schema | Fields for capturing location evidence for digital goods. |
Countries Schema (For Location Evidence) | Fields for modelling location evidence per country. |
Additional Interactions Schema | Fields for capturing additional user interactions for CAPTCHAs. |
Additional Currency Schema | Fields for capturing additional currencies used on invoices. |
Refunds Schema | Fields for modelling refunds. |
US Tax Exemption Certificate Schema | Fields for managing exemption certificates for US transactions. |
US Tax ID Schema | Fields for managing Tax IDs for US exemption certificates. |
Updated 7 months ago