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/

Online Transactions

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

Operations

Get Shippo shipping rates based on sender's and recipient's address and parcel details.

Request

Path
transaction_idinteger(int64)required
curl -i -X GET \
  'https://dev.stage.trustap.com/api/v1/transactions/{transaction_id}/shippo_shipping_rates' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/jsonArray [
amountstringrequired
amount_localstringrequired
arrives_bystring
attributesArray of stringsrequired
currencystringrequired
currency_localstringrequired
duration_termsstringrequired
estimated_daysinteger(int64)required
idstringrequired
providerstringrequired
provider_imagestringrequired
]
Response
application/json
[ { "amount": "string", "amount_local": "string", "arrives_by": "string", "attributes": [], "currency": "string", "currency_local": "string", "duration_terms": "string", "estimated_days": 0, "id": "string", "provider": "string", "provider_image": "string" } ]

Get the Stripe client secret for this transaction

Request

This endpoint is used for the asynchronous payment flow using Stripe. The client_secret returned from this endpoint should be passed to stripe.confirmCardPayment to start the payment process.

Path
transaction_idinteger(int64)required
curl -i -X GET \
  'https://dev.stage.trustap.com/api/v1/transactions/{transaction_id}/stripe_client_secret' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
client_secretstringrequired
Response
application/json
{ "client_secret": "string" }

Get the details for the Stripe publishable key that is in use for this transaction

Request

Returns the Publishable Key for the Stripe Platform which is hosting this transaction.

Path
transaction_idinteger(int64)required
curl -i -X GET \
  'https://dev.stage.trustap.com/api/v1/transactions/{transaction_id}/stripe_publishable_key' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
publishable_keystringrequired
Example: "pk_xXxXxXxXxXx"
Response
application/json
{ "publishable_key": "pk_xXxXxXxXxXx" }

Clients

Clients represent partner applications.

Operations

Users

Users represent users of the platform.

Operations

Personal

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

Operations

Notifications

Notifications log updates for users.

Operations

F2F Transactions

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

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