F2F Transactions
/
Create a new face-to-face transaction with both users

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 support@trustap.com
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

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

Create a new face-to-face transaction with both users

Request

This endpoint is an optimised call that allows a transaction to be created and joined in a single request. It requires the user identified by join_user_id to have granted the p2p_tx:offline_create_join scope to the client that is performing the request.

Note that this endpoint is similar to POST /me/transactions but takes deposit_price and deposit_charge fields instead of the price and charge fields.

Bodyapplication/jsonrequired
charge_calculator_versioninteger(int64)required
Example: 2
creator_rolestring(basic.Role)required
Enum"buyer""seller"
Example: "buyer"
currencystring(Currency)required
Enum"aud""eur""gbp""myr""pln""sek""usd""huf"
Example: "eur"
deposit_chargeinteger(int64)required
Example: 78
deposit_priceinteger(int64)required
Example: 1234
descriptionstringrequired

A description of the goods being sold.

Example: "Soccer ticket"
join_user_idstringrequired

The user that will be joined to the new transaction when it is created. It cannot be the ID of the user making the request.

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

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/transactions/create_and_join \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "charge_calculator_version": 2,
    "creator_role": "seller",
    "currency": "eur",
    "deposit_charge": 78,
    "deposit_price": 1234,
    "description": "Soccer ticket",
    "join_user_id": "feb33a87-3917-4538-9260-127c8a6b5232"
  }'

Responses

Created

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"
}

Create a new face-to-face transaction with both users

Request

This endpoint is an optimised call that allows a transaction to be created and joined in a single request. It requires the online user to have granted the p2p_tx:offline_create_join scope to the client that is performing the request. This endpoint allows creating a transaction with both buyer and seller as guest users, or one party to be guest user and the other full user.

Bodyapplication/jsonrequired
buyer_idstringrequired

The id of the buyer for this transaction (it can be full user id or guest user id).

charge_calculator_versioninteger(int64)required
Example: 2
creator_rolestring(basic.Role)required
Enum"buyer""seller"
Example: "buyer"
currencystring(Currency)required
Enum"aud""eur""gbp""myr""pln""sek""usd""huf"
Example: "eur"
deposit_chargeinteger(int64)required
Example: 78
deposit_charge_sellerinteger(int64)
deposit_priceinteger(int64)required
Example: 1234
descriptionstringrequired

A description of the goods being sold.

Example: "Soccer ticket"
fee_multipliernumber(double)

The fee_multiplier parameter is used to apply a higher percentage fee based on the total price of the transaction. The percentage fee is calculated multiplying the percentage fee by the fee_multiplier.

seller_idstringrequired

The id of the seller for this transaction (it can be full user id or guest user id).

skip_remainderbooleanrequired

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/transactions/create_with_guest_user \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "charge_calculator_version": 2,
    "creator_role": "seller",
    "currency": "eur",
    "deposit_charge": 78,
    "deposit_charge_seller": 0,
    "deposit_price": 1234,
    "description": "Soccer ticket",
    "join_user_id": "feb33a87-3917-4538-9260-127c8a6b5232"
  }'

Responses

Created

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"
}

Get a transaction by its ID

Request

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

Responses

OK

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"
}

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