Delete this listing

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

openapi.json

openapi.yaml

Overview

E-mail help@trustap.com

Servers

https://dev.stage.trustap.com/api/v1/

Online Transactions

Operations

Clients

Operations

Users

Operations

Personal

Operations

Online Multi-use Listings

Operations

Notifications

Operations

Online Single-use Listings

Operations

F2F Transactions

Operations

F2F Multi-use Listings

Operations

F2F Single-use Listings

Operations

Create a new single-use, face-to-face listing for the logged-in user

Request

Single-use listings are disabled once the remainder has been paid for a transaction created from it. Offline access is allowed for this endpoint when the user has granted the p2p_ls:offline_create scope to the client that is performing the request.

Bodyapplication/jsonrequired

charge_calculator_versioninteger(int64)required

The charge_calculator_version value returned from a request to /p2p/charge.

Example: 5

charge_sellerinteger(int64)

The charge_seller value returned from a request to /p2p/charge.

currencystring(Currency)required

Enum"aud""eur""gbp""myr""pln""sek""usd""huf"

Example: "eur"

deposit_chargeinteger(int64)required

The charge value returned from a request to /p2p/charge.

Example: 78

deposit_priceinteger(int64)required

The deposit price of the goods being sold, in the currency's smallest unit. The charge value should correspond to the Trustap charge created with this price, otherwise this request will fail with a 400 error.

Example: 1234

descriptionstringrequired

A description of the goods being sold.

Example: "Soccer ticket"

rolestring(basic.Role)required

Enum"buyer""seller"

Example: "buyer"

skip_remainderboolean

If skip_remainder is true then the transaction will move to the "confirm handover" step after the deposit has been accepted.

curl -i -X POST \
  https://dev.stage.trustap.com/api/v1/p2p/me/single_use_listings/create \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "charge_calculator_version": 5,
    "currency": "eur",
    "deposit_charge": 78,
    "deposit_price": 1234,
    "description": "Soccer ticket",
    "role": "seller"
  }'

Responses

Created

Bodyapplication/json

allows_multi_useboolean

createdstring

Example: "2019-12-25T09:00:00Z"

creator_idstring

Example: "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7"

creator_rolestring

currencystring

deposit_pricingobject(basic.Pricing)

Example: {"charge":78,"price":1234}

descriptionstring

disabledstring

idinteger(int64)required

Example: "77f36253-7a43-4d47-897d-f73dd208e17a"

skip_remainderboolean

Response

application/json

{
  "allows_multi_use": false,
  "created": "2019-12-25T09:00:00Z",
  "creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
  "deposit_pricing": {
    "charge": 150,
    "price": 5000
  },
  "description": "",
  "id": "77f36253-7a43-4d47-897d-f73dd208e17a",
  "skip_remainder": false
}

Delete this listing

Request

Path

listingIdinteger(int64)required

curl -i -X DELETE \
  'https://dev.stage.trustap.com/api/v1/p2p/single_use_listings/{listingId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Get a listing by its ID

Request

Path

listingIdinteger(int64)required

curl -i -X GET \
  'https://dev.stage.trustap.com/api/v1/p2p/single_use_listings/{listingId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

allows_multi_useboolean

createdstring

Example: "2019-12-25T09:00:00Z"

creator_idstring

Example: "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7"

creator_rolestring

currencystring

deposit_pricingobject(basic.Pricing)

Example: {"charge":78,"price":1234}

descriptionstring

disabledstring

idinteger(int64)required

Example: "77f36253-7a43-4d47-897d-f73dd208e17a"

skip_remainderboolean

Response

application/json

{
  "allows_multi_use": false,
  "created": "2019-12-25T09:00:00Z",
  "creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
  "deposit_pricing": {
    "charge": 150,
    "price": 5000
  },
  "description": "",
  "id": "77f36253-7a43-4d47-897d-f73dd208e17a",
  "skip_remainder": false
}

Patch listing properties

Request

Path

listingIdinteger(int64)required

Bodyapplication/jsonrequired

charge_calculator_versioninteger(int64)

The charge_calculator_version value returned from a request to /p2p/charge.

Example: 5

currencystring(Currency)

Enum"aud""eur""gbp""myr""pln""sek""usd""huf"

Example: "eur"

deposit_chargeinteger(int64)

The charge value returned from a request to /p2p/charge.

Example: 78

deposit_priceinteger(int64)

Example: 1234

descriptionstring

Example: "Soccer ticket"

skip_remainderboolean

curl -i -X PATCH \
  'https://dev.stage.trustap.com/api/v1/p2p/single_use_listings/{listingId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "charge_calculator_version": 5,
    "currency": "eur",
    "deposit_charge": 78,
    "deposit_price": 1234,
    "description": "Soccer ticket",
    "skip_remainder": false
  }'

Responses

Bodyapplication/json

allows_multi_useboolean

createdstring

Example: "2019-12-25T09:00:00Z"

creator_idstring

Example: "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7"

creator_rolestring

currencystring

deposit_pricingobject(basic.Pricing)

Example: {"charge":78,"price":1234}

descriptionstring

disabledstring

idinteger(int64)required

Example: "77f36253-7a43-4d47-897d-f73dd208e17a"

skip_remainderboolean

Response

application/json

{
  "allows_multi_use": false,
  "created": "2019-12-25T09:00:00Z",
  "creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
  "deposit_pricing": {
    "charge": 150,
    "price": 5000
  },
  "description": "",
  "id": "77f36253-7a43-4d47-897d-f73dd208e17a",
  "skip_remainder": false
}

Create a transaction from this listing

Request

Offline access is allowed for this endpoint when the user has granted the p2p_tx:offline_create_join scope to the client that is performing the request.

Path

listingIdinteger(int64)required

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/single_use_listings/{listingId}/create_transaction' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

buyer_handover_confirmedstring(date-time)

Example: "2019-12-25T16:00:00Z"

buyer_idstring

Example: "feb33a87-3917-4538-9260-127c8a6b5232"

buyer_is_guestboolean

cancellationobject(p2p.Cancellation)

cancelledstring(date-time)

claimed_by_buyerstring(date-time)

claimed_by_sellerstring(date-time)

client_idstringrequired

Example: "trustap-app"

complainedstring(date-time)

complaintobject(p2p.Complaint)

Example: {"description":"Item was fake"}

complaint_period_deadlinestring(date-time)

complaint_period_endedstring(date-time)

createdstring(date-time)required

Example: "2019-12-25T09:00:00Z"

currencystringrequired

The currency of the transaction. Note that, at present, the buyer must pay using the transaction's currency and the seller will be paid in the transaction's currency.

Example: "eur"

deposit_acceptedstring(date-time)

Example: "2019-12-25T12:00:00Z"

deposit_paidstring(date-time)

Example: "2019-12-25T11:00:00Z"

deposit_pricingobject(p2p.Pricing)required

Example: {"charge":78,"price":1234}

deposit_pricing.chargeinteger(int64)required

Example: 78

deposit_pricing.charge_international_paymentinteger(int64)

deposit_pricing.charge_sellerinteger(int64)required

deposit_pricing.deposit_fee_multiplierobject(p2p.DepositFeeMultiplier)

deposit_pricing.priceinteger(int64)required

Example: 1234

deposit_refundedstring(date-time)

deposit_reviewobject(p2p.Review)

deposit_review_flaggedstring(date-time)

descriptionstringrequired

Example: "Soccer ticket"

funds_releasedstring(date-time)

Example: "2019-12-25T17:00:00Z"

idinteger(int64)required

Example: 1309

is_deposit_payment_in_progressbooleanrequired

If the deposit is paid via a delayed payment method, such as SEPA debit, this field will be true until the payment has fully succeeded or failed.

is_remainder_payment_in_progressbooleanrequired

If the remainder is paid via a delayed payment method, such as SEPA debit, this field will be true until the payment has fully succeeded or failed.

join_codestring

joinedstring(date-time)

Example: "2019-12-25T10:00:00Z"

listing_idstring

If the transaction is created from a listing then this is the ID of that listing; otherwise this property is omitted.

listing_typestring(p2p.ListingType)

Enum"single_use""multi_use""prepaid"

Example: "single_use"

pricedstring(date-time)

Example: "2019-12-25T13:00:00Z"

pricingobject(p2p.Pricing)

Example: {"charge":78,"price":1234}

quantityinteger(int64)required

refundedstring(date-time)

rejectedstring(date-time)

relased_to_sellerstring(date-time)

released_to_sellerboolean

remainder_paidstring(date-time)

Example: "2019-12-25T14:00:00Z"

remainder_reviewobject(p2p.Review)

remainder_review_flaggedstring(date-time)

remainder_skippedstring(date-time)

seller_handover_confirmedstring(date-time)

Example: "2019-12-25T15:00:00Z"

seller_idstring

Example: "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7"

seller_is_guestboolean

skip_remainderbooleanrequired

If skip_remainder is true then this transaction will move to the "confirm handover" step after the deposit has been accepted.

statusstringrequired

Example: "funds_released"

Response

application/json

{
  "buyer_handover_confirmed": "2019-12-25T16:00:00Z",
  "buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
  "client_id": "trustap-app",
  "created": "2019-12-25T09:00:00Z",
  "currency": "eur",
  "deposit_accepted": "2019-12-25T12:00:00Z",
  "deposit_paid": "2019-12-25T11:00:00Z",
  "deposit_pricing": {
    "charge": 78,
    "price": 1234
  },
  "description": "Soccer ticket",
  "funds_released": "2019-12-25T17:00:00Z",
  "id": 1309,
  "is_deposit_payment_in_progress": false,
  "is_remainder_payment_in_progress": false,
  "joined": "2019-12-25T10:00:00Z",
  "priced": "2019-12-25T13:00:00Z",
  "pricing": {
    "charge": 190,
    "price": 5000
  },
  "remainder_paid": "2019-12-25T14:00:00Z",
  "seller_handover_confirmed": "2019-12-25T15:00:00Z",
  "seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
  "skip_remainder": false,
  "status": "funds_released"
}

Disable this listing

Request

Calling /create_transaction on a disabled listing will return a 400 response. Offline access is allowed for this endpoint when the user has granted the p2p_ls:offline_update scope to the client that is performing the request.

Path

listingIdinteger(int64)required

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/single_use_listings/{listingId}/disable' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

allows_multi_useboolean

createdstring

Example: "2019-12-25T09:00:00Z"

creator_idstring

Example: "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7"

creator_rolestring

currencystring

deposit_pricingobject(basic.Pricing)

Example: {"charge":78,"price":1234}

descriptionstring

disabledstring

idinteger(int64)required

Example: "77f36253-7a43-4d47-897d-f73dd208e17a"

skip_remainderboolean

Response

application/json

{
  "allows_multi_use": false,
  "created": "2019-12-25T09:00:00Z",
  "creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
  "deposit_pricing": {
    "charge": 150,
    "price": 5000
  },
  "description": "",
  "id": "77f36253-7a43-4d47-897d-f73dd208e17a",
  "skip_remainder": false
}

Enable this listing

Request

Offline access is allowed for this endpoint when the user has granted the p2p_ls:offline_update scope to the client that is performing the request.

Path

listingIdinteger(int64)required

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/single_use_listings/{listingId}/enable' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

allows_multi_useboolean

createdstring

Example: "2019-12-25T09:00:00Z"

creator_idstring

Example: "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7"

creator_rolestring

currencystring

deposit_pricingobject(basic.Pricing)

Example: {"charge":78,"price":1234}

descriptionstring

disabledstring

idinteger(int64)required

Example: "77f36253-7a43-4d47-897d-f73dd208e17a"

skip_remainderboolean

Response

application/json

{
  "allows_multi_use": false,
  "created": "2019-12-25T09:00:00Z",
  "creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
  "deposit_pricing": {
    "charge": 150,
    "price": 5000
  },
  "description": "",
  "id": "77f36253-7a43-4d47-897d-f73dd208e17a",
  "skip_remainder": false
}

Set pricing for this listing

Request

Offline access is allowed for this endpoint when the user has granted the p2p_ls:offline_update scope to the client that is performing the request.

Path

listingIdinteger(int64)required

Bodyapplication/jsonrequired

charge_calculator_versioninteger(int64)required

The charge_calculator_version value returned from a request to /p2p/charge.

Example: 5

currencystring(Currency)required

Enum"aud""eur""gbp""myr""pln""sek""usd""huf"

Example: "eur"

deposit_chargeinteger(int64)required

The charge value returned from a request to /p2p/charge.

Example: 78

deposit_priceinteger(int64)required

Example: 1234

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/single_use_listings/{listingId}/set_deposit_pricing' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "charge_calculator_version": 5,
    "currency": "eur",
    "deposit_charge": 78,
    "deposit_price": 1234
  }'

Responses

Bodyapplication/json

allows_multi_useboolean

createdstring

Example: "2019-12-25T09:00:00Z"

creator_idstring

Example: "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7"

creator_rolestring

currencystring

deposit_pricingobject(basic.Pricing)

Example: {"charge":78,"price":1234}

descriptionstring

disabledstring

idinteger(int64)required

Example: "77f36253-7a43-4d47-897d-f73dd208e17a"

skip_remainderboolean

Response

application/json

{
  "allows_multi_use": false,
  "created": "2019-12-25T09:00:00Z",
  "creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
  "deposit_pricing": {
    "charge": 150,
    "price": 5000
  },
  "description": "",
  "id": "77f36253-7a43-4d47-897d-f73dd208e17a",
  "skip_remainder": false
}

Set the description for this listing

Request

Offline access is allowed for this endpoint when the user has granted the p2p_ls:offline_update scope to the client that is performing the request.

Path

listingIdinteger(int64)required

Bodyapplication/jsonrequired

descriptionstringrequired

Example: "Soccer ticket"

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/single_use_listings/{listingId}/set_description' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Soccer ticket"
  }'

Responses

Bodyapplication/json

allows_multi_useboolean

createdstring

Example: "2019-12-25T09:00:00Z"

creator_idstring

Example: "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7"

creator_rolestring

currencystring

deposit_pricingobject(basic.Pricing)

Example: {"charge":78,"price":1234}

descriptionstring

disabledstring

idinteger(int64)required

Example: "77f36253-7a43-4d47-897d-f73dd208e17a"

skip_remainderboolean

Response

application/json

{
  "allows_multi_use": false,
  "created": "2019-12-25T09:00:00Z",
  "creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
  "deposit_pricing": {
    "charge": 150,
    "price": 5000
  },
  "description": "",
  "id": "77f36253-7a43-4d47-897d-f73dd208e17a",
  "skip_remainder": false
}

Subscriptions

Operations

Trustap API (0.1.0)

Online Transactions

Clients

Users

Personal

Online Multi-use Listings

Notifications

Online Single-use Listings

F2F Transactions

F2F Multi-use Listings

F2F Single-use Listings

Create a new single-use, face-to-face listing for the logged-in user

Request

Responses

Was this helpful?

Delete this listing

Request

Responses

Was this helpful?

Get a listing by its ID

Request

Responses

Was this helpful?

Patch listing properties

Request

Responses

Was this helpful?

Create a transaction from this listing

Request

Responses

Was this helpful?

Disable this listing

Request

Responses

Was this helpful?

Enable this listing

Request

Responses

Was this helpful?

Set pricing for this listing

Request

Responses

Was this helpful?

Set the description for this listing

Request

Responses

Was this helpful?

Subscriptions