Join a transaction by its join code

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

Get multiple transactions by their IDs

Request

This endpoint takes a required ids parameter that contains a comma-separated list of transaction IDs, and returns the transactions corresponding to those IDs. A maximum of 50 IDs may be provided, and results are returned in the order specified in ids, and duplicates are preserved. Transactions that couldn't be found will be returned as null values in the result array. The following example request results in the 200 OK response described below, assuming that the transaction with ID 1990 couldn't be found:

https://dev.stage.trustap.com/api/v1/p2p/batch/transactions?ids=1309,609,1990,609

Query

idsstringrequired

A comma-separated list of transaction IDs

curl -i -X GET \
  'https://dev.stage.trustap.com/api/v1/p2p/batch/transactions?ids=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [

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": { … },
    "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": { … },
    "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 the Trustap fee for a face-to-face transaction

Request

This returns the Trustap fee, in the currency's smallest unit, for a transaction involving goods with the supplied price. See the Stripe documentation for more details.

Query

currencystringrequired

The currency that the price is specified in.

priceinteger(int64)required

The price of the goods being sold in this transaction, in the currency's smallest unit. For example, if a trading card is being sold for $12.34 (with currency as usd), then the request for the charge for this transaction would be /p2p/charge?price=1234&currency=usd.

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.

quantityinteger(int64)

When creating transactions from a multi-use listing, the quantity parameter can be provided in order to generate a charge for the given price multiplied by the given quantity. See /p2p/multi_use_listings/{listingId}/create_transaction for more details.

payment_methodstring

The payment method that will be used to pay for the transaction. This is necessary because different payment methods may result in different fees.

The default value is card.

curl -i -X GET \
  'https://dev.stage.trustap.com/api/v1/p2p/charge?currency=string&fee_multiplier=0.1&payment_method=string&price=0&quantity=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

chargeinteger(int64)required

The Trustap fee that the buyer will pay, in the currency's smallest unit, for a queried amount. See the Stripe documentation for more details.

Example: 78

charge_calculator_versioninteger(int64)required

The version of the Trustap charge calculator that was used to calculate this charge.

This property is present for error-handling purposes. The Trustap API allows apps and users to query how much Trustap will charge for a transaction before creating a transaction. Trustap then requires the queried charge to be provided when creating a transaction or listing. At this point the charge is calculated again and checked against the provided charge, to ensure that the charge calculated for the new resource is the same as the one shown to the user. In the unlikely event that the Trustap charge calculator used to calculate the charge has been updated, then the charge_calculator_version property will be used to return an incorrect_calc_version to the API client, which will indicate that the /charge endpoint should be queried again to get the newest charge value.

Example: 5

charge_sellerinteger(int64)required

The Trustap fee that the seller will pay, in the currency's smallest unit, for a queried amount. See the Stripe documentation for more details.

currencystringrequired

Example: "eur"

priceinteger(int64)required

Response

application/json

{
  "charge": 78,
  "charge_calculator_version": 5,
  "currency": "eur"
}

Get face-to-face transactions for the logged-in user

Request

Transactions are currently sorted by ID.

Query

before_idinteger(int64)>= 0

Only return transactions that were created chronologically before the transaction with this ID

after_idinteger(int64)>= 0

Only return transactions that were created chronologically after the transaction with this ID (i.e. with smaller IDs)

limitinteger(int64)[ 1 .. 50 ]

The maximum number of transactions to return

Default 25

curl -i -X GET \
  'https://dev.stage.trustap.com/api/v1/p2p/me/transactions?after_id=0&before_id=0&limit=25' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [

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",
    "created": "2019-12-25T09:00:00Z",
    "currency": "eur",
    "deposit_accepted": "2019-12-25T12:00:00Z",
    "deposit_paid": "2019-12-25T11:00:00Z",
    "deposit_pricing": { … },
    "description": "Soccer ticket",
    "funds_released": "2019-12-25T17:00:00Z",
    "id": 1309,
    "joined": "2019-12-25T10:00:00Z",
    "priced": "2019-12-25T13:00:00Z",
    "pricing": { … },
    "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"
  },
  {
    "buyer_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
    "created": "2018-12-25T09:00:00Z",
    "currency": "eur",
    "deposit_pricing": { … },
    "description": "Soccer ticket",
    "id": 609,
    "join_code": "c9cd6a9d-1096-4d38-b4aa-2c354beac845",
    "skip_remainder": false,
    "status": "created"
  }
]

Create a new face-to-face transaction

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. 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.

Bodyapplication/jsonrequired

charge_calculator_versioninteger(int64)required

Example: 2

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"

rolestring(basic.Role)required

Enum"buyer""seller"

Example: "buyer"

skip_remainderboolean

If skip_remainder is true then this 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 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "charge_calculator_version": 2,
    "currency": "eur",
    "deposit_charge": 78,
    "deposit_price": 1234,
    "description": "Soccer ticket",
    "role": "seller"
  }'

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 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)

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

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

Updates description, currency, price and/or charge of F2F transaction

Request

Path

transaction_idinteger(int64)required

Bodyapplication/jsonrequired

currencystring(Currency)

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

Example: "eur"

deposit_chargeinteger(int64)

Example: 78

deposit_priceinteger(int64)

Example: 1234

descriptionstring

A description of the goods being sold.

Example: "Soccer ticket"

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

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

Accept a complaint for this transaction

Request

Path

transaction_idinteger(int64)required

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transaction_id}/accept_complaint' \
  -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"
}

Get bank transfer details for transaction which payment method is `bank_transfer`

Request

Path

transaction_idinteger(int64)required

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

Responses

Bodyapplication/json

amountinteger(int64)required

currencystringrequired

financial_addressobject(p2p.FinancialAddress)required

financial_address.abaobject(p2p.Aba)

financial_address.ibanobject(p2p.Iban)

financial_address.sort_codeobject(p2p.SortCode)

financial_address.swiftobject(p2p.Swift)

hosted_instructions_urlstringrequired

referencestringrequired

Response

application/json

{
  "amount": 0,
  "currency": "string",
  "financial_address": {
    "aba": { … },
    "iban": { … },
    "sort_code": { … },
    "swift": { … }
  },
  "hosted_instructions_url": "string",
  "reference": "string"
}

End complaint period for this transaction with a guest buyer

Request

Path

transaction_idinteger(int64)required

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transaction_id}/end_complaint_period_with_guest_buyer' \
  -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"
}

Set payment details and process payment for this transaction with this user's balance

Request

Path

transaction_idinteger(int64)required

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transaction_id}/pay_deposit_with_balance' \
  -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"
}

Set payment details and process payment for this transaction with this user's balance

Request

Path

transaction_idinteger(int64)required

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transaction_id}/pay_remainder_with_balance' \
  -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"
}

Set deposit payment method for F2F transaction, values can be `card`, `bank_transfer`, `p24`, `sepa` and `fpx`.

Request

Path

transaction_idinteger(int64)required

Bodyapplication/jsonrequired

currencystringrequired

Example: "eur"

deposit_chargeinteger(int64)required

Example: 2000

deposit_charge_sellerinteger(int64)required

deposit_priceinteger(int64)required

Example: 200000

payment_methodstringrequired

Example: "bank_transfer"

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transaction_id}/set_deposit_payment_method' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "currency": "eur",
    "deposit_charge": 2000,
    "deposit_charge_seller": 0,
    "deposit_price": 200000,
    "payment_method": "bank_transfer"
  }'

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

Accept the deposit for this transaction

Request

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

Path

transactionIdinteger(int64)required

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transactionId}/accept_deposit' \
  -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"
}

Accept the deposit for this transaction as a guest seller

Request

Path

transactionIdinteger(int64)required

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transactionId}/accept_deposit_with_guest_seller' \
  -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"
}

Get details of the buyer from this transaction

Request

Path

transactionIdinteger(int64)required

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

Responses

Bodyapplication/json

emailstringrequired

nameobject(basic.UserDetailsName)

Example: {"first":"John","last":"Doe"}

phonestring

Response

application/json

{
  "email": "string",
  "name": {
    "first": "John",
    "last": "Doe"
  },
  "phone": "string"
}

Cancel this transaction with a description

Request

If a transaction is cancelled after the deposit has been paid then the deposit (excluding the Trustap fee) will be returned to the buyer. Offline access is allowed for this endpoint when the user has granted the p2p_tx:offline_cancel scope to the client that is performing the request.

Path

transactionIdinteger(int64)required

Bodyapplication/jsonrequired

descriptionstringrequired

Example: "Found another buyer"

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transactionId}/cancel_with_description' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Found another buyer"
  }'

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

Cancel this transaction with a description with guest user

Request

If a transaction is cancelled after the deposit has been paid then the deposit (excluding the Trustap fee) will be returned to the buyer.

Path

transactionIdinteger(int64)required

Bodyapplication/jsonrequired

descriptionstringrequired

Example: "Found another buyer"

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transactionId}/cancel_with_description_with_guest_user' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Found another buyer"
  }'

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

Submit a complaint for this transaction

Request

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

Path

transactionIdinteger(int64)required

Bodyapplication/jsonrequired

descriptionstringrequired

Example: "Item was fake"

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transactionId}/complain' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Item was fake"
  }'

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

Submit a complaint for this transaction with a guest buyer

Request

Path

transactionIdinteger(int64)required

Bodyapplication/jsonrequired

descriptionstringrequired

Example: "Item was fake"

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transactionId}/complain_with_guest_buyer' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Item was fake"
  }'

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

Confirm handover for this transaction

Request

Both parties should confirm the handover for a face-to-face transaction. The complaints period begins when the seller confirms the handover. Offline access is allowed for this endpoint when the user has granted the p2p_tx:offline_confirm_handover scope to the client that is performing the request.

Path

transactionIdinteger(int64)required

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transactionId}/confirm_handover' \
  -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"
}

Confirm handover for this transaction with a guest user

Request

Both parties should confirm the handover for a face-to-face transaction. Full users don't have access to this endpoint.

Path

transactionIdinteger(int64)required

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transactionId}/confirm_handover_with_guest_user' \
  -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"
}

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

transactionIdinteger(int64)required

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

Responses

Bodyapplication/json

client_secretstringrequired

Example: "***"

Response

application/json

{
  "client_secret": "***"
}

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

transactionIdinteger(int64)required

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

Responses

Bodyapplication/json

client_secretstringrequired

Example: "***"

Response

application/json

{
  "client_secret": "***"
}

Get details of the seller from this transaction

Request

Path

transactionIdinteger(int64)required

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

Responses

Bodyapplication/json

emailstringrequired

nameobject(basic.UserDetailsName)

Example: {"first":"John","last":"Doe"}

phonestring

Response

application/json

{
  "email": "string",
  "name": {
    "first": "John",
    "last": "Doe"
  },
  "phone": "string"
}

Set the total price for this transaction

Request

price is the total price of the item, and thus includes the price already paid for the deposit.

Note that this endpoint will return a remainder_too_low response if the difference between the total price and the deposit price is too low. Offline access is allowed for this endpoint when the user has granted the p2p_tx:offline_set_price scope to the client that is performing the request.

Path

transactionIdinteger(int64)required

Bodyapplication/jsonrequired

chargeinteger(int64)required

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

Example: 190

charge_calculator_versioninteger(int64)required

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

Example: 2

currencystring(Currency)required

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

Example: "eur"

priceinteger(int64)required

The 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: 5000

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transactionId}/set_price' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "charge": 190,
    "charge_calculator_version": 2,
    "currency": "eur",
    "price": 5000
  }'

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

Skip the remainder for this transaction

Request

This will skip the remainder payment of this transaction, and the total price of the transaction will not need to be set. Note that this must be done before the total price of the transaction is set using /set_price.

Path

transactionIdinteger(int64)required

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions/{transactionId}/skip_remainder' \
  -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"
}

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

transactionIdinteger(int64)required

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

Responses

Bodyapplication/json

publishable_keystring

Example: "pk_xXxXxXxXxXx"

Response

application/json

{
  "publishable_key": "pk_xXxXxXxXxXx"
}

Get a transaction by its join code

Request

Path

joinCodestringrequired

curl -i -X GET \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions_by_join_code/{joinCode}' \
  -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"
}

Join a transaction by its join code

Request

This endpoint allows a user to join a transaction provided a join code. 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

joinCodestringrequired

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions_by_join_code/{joinCode}/join' \
  -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"
}

Reject a transaction by its join code

Request

Path

joinCodestringrequired

curl -i -X POST \
  'https://dev.stage.trustap.com/api/v1/p2p/transactions_by_join_code/{joinCode}/reject' \
  -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"
}

F2F Multi-use Listings

Operations

F2F Single-use Listings

Operations

Subscriptions

Operations

Trustap API (0.1.0)

Online Transactions

Clients

Users

Personal

Online Multi-use Listings

Notifications

Online Single-use Listings

F2F Transactions

Get multiple transactions by their IDs

Request

Responses

Was this helpful?

Get the Trustap fee for a face-to-face transaction

Request

Responses

Was this helpful?

Get face-to-face transactions for the logged-in user

Request

Responses

Was this helpful?

Create a new face-to-face transaction

Request

Responses

Was this helpful?

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

Request

Responses

Was this helpful?

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

Request

Responses

Was this helpful?

Get a transaction by its ID

Request

Responses

Was this helpful?

Updates description, currency, price and/or charge of F2F transaction

Request

Responses

Was this helpful?

Accept a complaint for this transaction

Request

Responses

Was this helpful?

Get bank transfer details for transaction which payment method is `bank_transfer`

Request

Responses

Was this helpful?

End complaint period for this transaction with a guest buyer

Request

Responses

Was this helpful?

Set payment details and process payment for this transaction with this user's balance

Request

Responses

Was this helpful?

Set payment details and process payment for this transaction with this user's balance

Request

Responses

Was this helpful?

Set deposit payment method for F2F transaction, values can be `card`, `bank_transfer`, `p24`, `sepa` and `fpx`.

Request

Responses

Was this helpful?

Accept the deposit for this transaction

Request

Responses

Was this helpful?

Accept the deposit for this transaction as a guest seller

Request

Responses

Was this helpful?

Get details of the buyer from this transaction

Request

Responses

Was this helpful?

Cancel this transaction with a description

Request

Responses