Trustap API (0.1.0)

The Trustap API is a REST-based API for managing user data and transactions for Trustap users.

Note that, like Stripe, all API price and charge fields expect amounts to be provided in a currency's smallest unit. See the Stripe documentation for more details.

API Keys


Some endpoints such as /charge endpoints can be accessed directly using an API key. API keys are provided as the "username" portion of a basic auth authentication. For example, the Trustap fee for a new online transaction can be determined using the following cURL request with an API key:

curl -u '<api_key>': 'https://dev.stage.trustap.com/api/v1/charge?currency=eur&price=1234'

Deprecation


Deprecated endpoints are tagged with the word DEPRECATED at the start of their description. The deprecation message will describe what endpoints/approach should be used instead.

Note that deprecated endpoints will not be removed from the current version of the API, but their use is discouraged. Furthermore, migrating to later major versions of the API will be made easier by avoiding deprecated endpoints.

Production


This documentation references the staging environment of the Trustap API, which is available at https://dev.stage.trustap.com and uses the trustap-stage realm during authentication. This environment can be used for implementing and testing features using test credit cards, bank accounts, etc.

When all features using Trustap have been implemented and tested sufficiently, the production environment of the Trustap API can be used to process actual currency. This environment is available at https://dev.trustap.com and uses the trustap realm during authentication.

Note that only your client ID will be the same in the staging and production Trustap API environments; your client secret and API key will be different in the two environments.

Download OpenAPI description
Overview
Languages
Servers
https://dev.stage.trustap.com/api/v1/

Buyers and Sellers

Users represent users of the platform.

Operations

Clients

Clients represent partner applications.

Operations

Personal

Personal endpoints are used for managing personal details for users, for "Know Your Customer" requirements.

Operations

Get instant payout balance

Request

curl -i -X GET \
  https://dev.stage.trustap.com/api/v1/me/instant_payout_balance \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
amountinteger(int64)required
currencystringrequired
Response
application/json
{ "amount": 0, "currency": "string" }

Get the payout attempts that have occurred for this account

Request

Payout attempts are returned in reverse chronological order - the first attempt in the returned array will be the most recent payout attempt.

curl -i -X GET \
  https://dev.stage.trustap.com/api/v1/me/payout_attempts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/jsonArray [
amountinteger(int64)required
arrival_dateinteger(int64)required
created_dateinteger(int64)required
failure_codestring
Enum"account_closed""account_frozen""bank_account_restricted""bank_ownership_changed""could_not_process""debit_not_authorized""declined""insufficient_funds""invalid_account_number""incorrect_account_holder_name"
statusstringrequired
Enum"paid""pending""in_transit""canceled""failed"
]
Response
application/json
[ { "amount": 0, "arrival_date": 0, "created_date": 0, "failure_code": "account_closed", "status": "paid" } ]

Get verification status for the front side of the secondary identity document

Request

curl -i -X GET \
  https://dev.stage.trustap.com/api/v1/me/personal/additional_identity_document/verification_status \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
previously_submittedbooleanrequired
Example: true
statusstringrequired

Verification status of the document could be one of the following: due, not_due, verifying, verified

Example: "verifying"
Response
application/json
{ "previously_submitted": true, "status": "verifying" }

Online Transactions

Online transactions are used when the goods are delivered using registered mail.

Operations

Online Payment

Operations

Online Shipping

Operations

Online Complaint

Operations

Online Cancel

Operations

Online Buyer/Seller Details

Operations

F2F Transactions

F2F2 transactions are used when the goods are delivered in person.

Operations

F2F Payment

Payment endpoints for face-to-face transactions.

Operations

F2F Handover

Handover endpoints for face-to-face transactions.

Operations

F2F Complaint

Complaint endpoints for face-to-face transactions.

Operations

F2F Cancel

Cancel endpoints for face-to-face transactions.

Operations

F2F Buyer/Seller Details

User details endpoints for face-to-face transactions.

Operations

Notifications

Notifications log updates for users.

Operations

Online Multi-use Listings

These endpoints are no longer supported. We do not recommend using these endpoints.

Operations

Online Single-use Listings

These endpoints are no longer supported. We do not recommend using these endpoints.

Operations

F2F Multi-use Listings

These endpoints are no longer supported. We do not recommend using these endpoints.

Operations

F2F Single-use Listings

These endpoints are no longer supported. We do not recommend using these endpoints.

Operations