Trustap API API Reference
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.
API Endpoint
https://dev.stage.trustap.com/api/v1Contact: help@trustap.com
Schemes: https
Version: 0.1.0
Authentication
APIKey
OAuth2
Online Transactions
Get the supported carriers
This returns the carriers that are currently supported for automated tracking in the online model. The carrier name should be shown to users but the code should be submitted to the /track endpoint when submitting tracking details. Likewise, when showing a transaction to the user, the carrier field stored with the transaction should be used to index these carriers and show the human-readable name of the carrier to the user, if this index is found.
OK
Response Content-Types: application/json
Response Example (200 OK)
[
{
"code": "an-post",
"name": "An Post"
},
{
"code": "fedex",
"name": "FedEx"
},
{
"code": "ups",
"name": "UPS"
},
{
"code": "usps",
"name": "USPS"
}
]
Get the Trustap fee for a transaction
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.
The currency that the price is specified in.
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 /charge?price=1234¤cy=usd.
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 /multi_use_listings/{listingId}/create_transaction for more details.
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.
OK
Bad Request
code can be one of the following:
currency_missinginvalid_pricenegative_priceprice_too_lowunsupported_currency
Response Content-Types: application/json
Response Example (200 OK)
{
"currency": "eur",
"charge": 78,
"charge_calculator_version": 5
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Create a new transaction
A request to this endpoint must be preceded by a call to /charge with the price of the goods specified in price.
- role: Role
- currency: Currency
- price: integer (int64)
-
The price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - description: string
-
A description of the goods being sold.
- charge: integer (int64)
-
The
chargevalue returned from a request to/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/charge. - client_id: string
Request Content-Types: application/json
Request Example
{
"role": "seller",
"currency": "eur",
"price": 1234,
"description": "Soccer ticket",
"charge": 78,
"charge_calculator_version": 5
}
Created
Bad Request
code can be one of the following:
incorrect_calc_versionincorrect_chargeinvalid_calc_versionnegative_priceprice_too_low
Response Content-Types: application/json
Response Example (201 Created)
{
"id": 1309,
"status": "created",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"join_code": "54c5bb89-a5ea-4be7-ad7a-e740c2eebab4"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Get online transactions for the logged-in user
Transactions are currently sorted by ID.
Only return transactions that were created chronologically before the transaction with this ID
Only return transactions that were created chronologically after the transaction with this ID (i.e. with smaller IDs)
The maximum number of transactions to return
OK
Bad Request
code can be one of the following:
invalid_before_idinvalid_after_idinvalid_limit
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": 1309,
"status": "created",
"currency": "eur",
"price": 1234,
"charge": 78,
"charge_seller": 0,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"join_code": "54c5bb89-a5ea-4be7-ad7a-e740c2eebab4"
},
{
"id": 609,
"status": "created",
"currency": "eur",
"price": 1234,
"charge": 78,
"charge_seller": 0,
"description": "Soccer ticket",
"created": "2018-12-25T09:00:00.000Z",
"buyer_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"join_code": "c9cd6a9d-1096-4d38-b4aa-2c354beac845"
}
]
Response Example (400 Bad Request)
{
"code": "invalid_after_id",
"error": "invalid after id"
}
Create a new basic transaction with both users
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 basic:offline_create_join scope to the client that is performing the request.
- join_user_id: string
-
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.
- creator_role: Role
-
This is the role that will be given to the user making the request; the user specified by
join_user_idwill be given the complementary role. - currency: Currency
- price: integer (int64)
-
The price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - description: string
-
A description of the goods being sold.
- charge: integer (int64)
-
The
chargevalue returned from a request to/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/charge.
Request Content-Types: application/json
Request Example
{
"join_user_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"creator_role": "seller",
"role": "seller",
"currency": "eur",
"price": 1234,
"description": "Soccer ticket",
"charge": 78,
"charge_calculator_version": 5
}
Created
Bad Request
code can be one of the following:
invalid_join_user_idduplicate_user_id: The user specified byjoin_user_idis the user making the request.incorrect_calc_versionincorrect_chargeunsupported_currencyinvalid_calc_versionnegative_priceprice_too_lowuser_already_joinedalready_cancelledfeature_not_found
Response Content-Types: application/json
Response Example (201 Created)
{
"id": 1309,
"status": "joined",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Get a transaction using a join code
(no description)
OK
Bad Request
code can be one of the following:
join_code_missing
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "created",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"join_code": "54c5bb89-a5ea-4be7-ad7a-e740c2eebab4"
}
Response Example (400 Bad Request)
{
"code": "join_code_missing",
"error": "`join_code` query parameter is required"
}
Join a transaction using a join code
A transaction can't be joined using its ID, because only the buyer and seller of a transaction can access a transaction using its ID.
(no description)
OK
Bad Request
code can be one of the following:
join_code_missing
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "joined",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "join_code_missing",
"error": "`join_code` query parameter is required"
}
Reject a transaction by its join code
A transaction can't be rejected using its ID, because only the buyer and seller of a transaction can access a transaction using its ID.
(no description)
OK
Bad Request
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "rejected",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"denied": "2019-12-25T10:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Get a transaction by its ID
(no description)
OK
Bad Request
code can be one of the following:
invalid_id
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "joined",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Updates description, currency, price and/or charge of transaction
- currency: Currency
- price: integer (int64)
-
The price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - description: string
-
A description of the goods being sold.
- charge: integer (int64)
-
The
chargevalue returned from a request to/charge.
(no description)
Request Content-Types: application/json
Request Example
{
"currency": "eur",
"price": 1234,
"description": "Soccer ticket",
"charge": 78
}
OK
Bad Request
code can be one of the following:
invalid_idsecond_party_already_joinedvalues_not_changed
Forbidden
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "created",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Get multiple transactions by their IDs
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, 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/batch/transactions?ids=1309,609,1990,609
A comma-separated list of transaction IDs
OK
Bad Request
code can be one of the following:
ids_missinginvalid_idtoo_many_ids
Response Content-Types: application/json
Response Example (200 OK)
[
[
{
"id": 1309,
"status": "created",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"join_code": "54c5bb89-a5ea-4be7-ad7a-e740c2eebab4"
},
{
"id": 609,
"status": "created",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2018-12-25T09:00:00.000Z",
"buyer_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"join_code": "c9cd6a9d-1096-4d38-b4aa-2c354beac845"
},
null,
{
"id": 609,
"status": "created",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2018-12-25T09:00:00.000Z",
"buyer_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"join_code": "c9cd6a9d-1096-4d38-b4aa-2c354beac845"
}
]
]
Response Example (400 Bad Request)
{
"code": "ids_missing",
"error": "`ids` query parameter is required"
}
Get the Stripe client secret for this transaction
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.
(no description)
OK
Bad Request
code can be one of the following:
already_paidinvalid_idnot_accepted: This transaction was created from a listing but the listing's creator has not yet accepted this transaction.
Forbidden
code can be one of the following:
not_buyer
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"client_secret": "string"
}
Response Example (400 Bad Request)
{
"code": "already_paid",
"error": "payment already made"
}
Response Example (403 Forbidden)
{
"code": "not_buyer",
"error": "current user is not buyer"
}
Get the details for the Stripe publishable key that is in use for this transaction
Returns the Publishable Key for the Stripe Platform which is hosting this transaction.
(no description)
OK
Bad Request
code can be one of the following:
invalid_id
Forbidden
code can be one of the following:
not_buyernot_seller
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"publishable_key": "pk_xXxXxXxXxXx"
}
Response Example (400 Bad Request)
{
"code": "invalid_id",
"error": "couldn't parse transaction id: abc"
}
Response Example (403 Forbidden)
{
"code": "not_buyer",
"error": "current user is not buyer"
}
Set payment details and process payment for this transaction
DEPRECATED
Payment should be processed using the asynchronous payment flow (see /transactions/{transaction_id}/stripe_client_secret).
- stripe_token: string
-
stripe_tokenis a card token ID received from Stripe. It is generated using a publishable Stripe key from Trustap. See https://stripe.com/docs/stripe-js and https://stripe.com/docs/checkout for methods for generating this token.
(no description)
Request Content-Types: application/json
Request Example
{
"stripe_token": "string"
}
OK
Bad Request
code can be one of the following:
already_paidcard_declinedexpired_cardincorrect_cvcinsufficient_fundsinvalid_idnot_accepted: This transaction was created from a listing but the listing's creator has not yet accepted this transaction.
Forbidden
code can be one of the following:
not_buyer
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "paid",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"paid": "2019-12-25T11:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "already_paid",
"error": "payment already made"
}
Response Example (403 Forbidden)
{
"code": "not_buyer",
"error": "current user is not buyer"
}
This endpoint lets the seller accept payment and is accessible only if the seller has granted a feature require_seller_acceptance
(no description)
OK
Bad Request
code can be one of the following:
missing_required_featurepayment_already_acceptedtransaction_not_paid_yet
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "payment_accepted",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"paid": "2019-12-25T11:00:00.000Z",
"payment_accepted": "2019-12-26T11:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "transaction_not_paid_yet",
"error": "this transaction is not paid yet"
}
Extend tracking details submission deadline for this transaction
This endpoint allows the buyer to extend the tracking details submission deadline for the seller.
(no description)
OK
Bad Request
code can be one of the following:
invalid_idtracking_already_addedpayment_details_not_added
Forbidden
code can be one of the following:
not_buyer
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "paid",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"paid": "2019-12-25T11:00:00.000Z",
"tracking_details_window_start": "2019-12-25T12:00:00.000Z"
}
Response Example (403 Forbidden)
{
"code": "not_buyer",
"error": "current user is not buyer"
}
Set postal tracking details for this transaction
After the tracking information has been submitted then the state of the transaction will be updated asynchronously by Trustap once the delivery of the item has been confirmed, at which point the delivered field of the transaction will be set.
- carrier: CarrierName
- tracking_code: string
(no description)
Request Content-Types: application/json
Request Example
{
"carrier": "ups",
"tracking_code": "***"
}
OK
Bad Request
code can be one of the following:
empty_carrierempty_tracking_codeinvalid_idtracking_details_deadline_expired
Forbidden
code can be one of the following:
not_seller
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "tracked",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"paid": "2019-12-25T11:00:00.000Z",
"tracked": "2019-12-25T12:00:00.000Z",
"tracking": {
"carrier": "ups",
"tracking_code": "***"
}
}
Response Example (400 Bad Request)
{
"code": "empty_carrier",
"error": "`carrier` parameter is required"
}
Response Example (403 Forbidden)
{
"code": "not_seller",
"error": "current user is not seller"
}
Confirm delivery for this transaction
This endpoint allows the buyer to manually confirm the delivery of the item in the case that the state of the transaction was not updated asynchronously by Trustap.
(no description)
OK
Bad Request
code can be one of the following:
tracking_not_addeddelivery_already_setinvalid_id
Forbidden
code can be one of the following:
not_buyer
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "delivered",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"paid": "2019-12-25T11:00:00.000Z",
"tracked": "2019-12-25T12:00:00.000Z",
"delivered": "2019-12-26T12:00:00.000Z",
"tracking": {
"carrier": "ups",
"tracking_code": "***"
}
}
Response Example (400 Bad Request)
{
"code": "delivery_already_set",
"error": "delivery details already added"
}
Response Example (403 Forbidden)
{
"code": "not_buyer",
"error": "current user is not buyer"
}
Submit a detailed complaint for this transaction
- description: string
(no description)
Request Content-Types: application/json
Request Example
{
"description": "Item was fake"
}
OK
Bad Request
code can be one of the following:
complaint_period_ended_prematurely: The buyer has already ended the complaint period.complaint_period_expiredinvalid_idunconfirmed_delivery: The complaint period for this transaction has not yet started.
Forbidden
code can be one of the following:
not_buyer
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "complained",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"paid": "2019-12-25T11:00:00.000Z",
"tracked": "2019-12-25T12:00:00.000Z",
"tracking": {
"carrier": "ups",
"tracking_code": "***"
},
"delivered": "2019-12-25T13:00:00.000Z",
"complained": "2019-12-25T14:00:00.000Z",
"complaint": {
"description": "Item was fake"
}
}
Response Example (400 Bad Request)
{
"code": "complaint_period_expired",
"error": "complaint period has expired"
}
Response Example (403 Forbidden)
{
"code": "not_buyer",
"error": "current user is not buyer"
}
Flag a complaint for this transaction
DEPRECATED
Complaints should be submitted using /transactions/{transactionId}/complain_with_description.
(no description)
OK
Bad Request
code can be one of the following:
complaint_period_ended_prematurely: The buyer has already ended the complaint period.complaint_period_expiredinvalid_idunconfirmed_delivery: The complaint period for this transaction has not yet started.
Forbidden
code can be one of the following:
not_buyer
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "complained",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"paid": "2019-12-25T11:00:00.000Z",
"tracked": "2019-12-25T12:00:00.000Z",
"tracking": {
"carrier": "ups",
"tracking_code": "***"
},
"delivered": "2019-12-25T13:00:00.000Z",
"complained": "2019-12-25T14:00:00.000Z",
"complaint": {
"description": ""
}
}
Response Example (400 Bad Request)
{
"code": "complaint_period_expired",
"error": "complaint period has expired"
}
Response Example (403 Forbidden)
{
"code": "not_buyer",
"error": "current user is not buyer"
}
End the complaint period for this transaction
(no description)
OK
Bad Request
code can be one of the following:
complaint_period_expiredinvalid_idunconfirmed_delivery: The complaint period for this transaction has not yet started.
Forbidden
code can be one of the following:
not_buyer
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "complaint_period_ended",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"paid": "2019-12-25T11:00:00.000Z",
"tracked": "2019-12-25T12:00:00.000Z",
"tracking": {
"carrier": "ups",
"tracking_code": "***"
},
"delivered": "2019-12-25T13:00:00.000Z",
"complaint_period_ended": "2019-12-25T14:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "complaint_period_expired",
"error": "complaint period has expired"
}
Response Example (403 Forbidden)
{
"code": "not_buyer",
"error": "current user is not buyer"
}
Get details of the buyer from this transaction
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"email": "string",
"phone": "string"
}
Get details of the seller from this transaction
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"email": "string",
"phone": "string"
}
Get shipping details of the buyer from this transaction
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"address": {
"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postal_code": "string",
"state": "string"
}
}
Allow this listing-based transaction to proceed
"Listing transactions" are transactions created from listings (using the /create_transaction endpoints for listings). Listings transactions for online transactions must be accepted by the creator of the listing using /accept_listing_transaction in order to proceed.
(no description)
OK
Bad Request
code can be one of the following:
no_listing: This transaction wasn't created from a listingalready_acceptedalready_rejected
Forbidden
code can be one of the following:
not_creator
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"listing_id": 1990,
"listing_type": "single_use",
"status": "paid",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"accepted_by_listing_creator": "2019-12-25T11:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "already_accepted",
"error": "transaction already accepted"
}
Response Example (403 Forbidden)
{
"code": "not_creator",
"error": "current user is not the creator for the source listing"
}
Cancel this listing-based transaction
"Listing transactions" are transactions created from listings (using the /create_transaction endpoints for listings). Listings transactions for online transactions must be accepted by the creator of the listing using /accept_listing_transaction in order to proceed. This endpoint instead rejects the listing transaction.
(no description)
OK
Bad Request
code can be one of the following:
no_listing: This transaction wasn't created from a listingalready_acceptedalready_rejected
Forbidden
code can be one of the following:
not_creator
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"listing_id": 1990,
"listing_type": "single_use",
"status": "paid",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"rejected_by_listing_creator": "2019-12-25T11:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "already_accepted",
"error": "transaction already accepted"
}
Response Example (403 Forbidden)
{
"code": "not_creator",
"error": "current user is not the creator for the source listing"
}
Cancel this transaction
Transaction can be cancelled until it's joined by another user or if the feature RequireSellerAcceptance is present, it can be cancelled until it's tracked.
(no description)
OK
Bad Request
code can be one of the following:
invalid_idsecond_party_already_joinedalready_cancelledtracking_already_added
Forbidden
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "cancelled",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2022-04-26T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"cancelled": "2022-04-26T11:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Online Single-use Listings
Create a new single-use listing for the logged-in user
Single-use listings are disabled once payment has been submitted for a transaction created from it.
- role: Role
- description: string
-
A description of the goods being sold.
- currency: Currency
- price: integer (int64)
-
The price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - charge: integer (int64)
-
The
chargevalue returned from a request to/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/charge.
Request Content-Types: application/json
Request Example
{
"role": "seller",
"description": "Soccer ticket",
"currency": "eur",
"price": 1234,
"charge": 78,
"charge_calculator_version": 5
}
Created
Bad Request
code can be one of the following:
* `invalid_role`: '' is not a valid role
Response Content-Types: application/json
Response Example (201 Created)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"description": "Soccer ticket",
"currency": "eur",
"pricing": {
"price": 1234,
"charge": 78
},
"created": "2019-12-25T09:00:00.000Z"
}
Create a new single-use listing for the logged-in user
DEPRECATED
Single-use-listings for online transactions should be created using /me/single_use_listings/create.
Single-use listings are disabled once payment has been submitted for a transaction created from it.
Created
Response Content-Types: application/json
Response Example (201 Created)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"created": "2019-12-25T09:00:00.000Z"
}
Get a listing by its ID
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"created": "2019-12-25T09:00:00.000Z"
}
Patch listing properties
- currency: Currency
- price: integer (int64)
-
The price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - charge: integer (int64)
-
The
chargevalue returned from a request to/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/charge. - description: string
(no description)
Request Content-Types: application/json
Request Example
{
"currency": "eur",
"price": 1234,
"charge": 78,
"charge_calculator_version": 5,
"description": "Soccer ticket"
}
OK
Bad Request
code can be one of the following:
empty_body: The request body is empty.
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z"
}
Delete this listing
(no description)
No Content
Not Found
Response Content-Types: application/json
Set description for this listing
- description: string
(no description)
Request Content-Types: application/json
Request Example
{
"description": "Soccer ticket"
}
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z"
}
Set pricing for this listing
- currency: Currency
- price: integer (int64)
-
The price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - charge: integer (int64)
-
The
chargevalue returned from a request to/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/charge.
(no description)
Request Content-Types: application/json
Request Example
{
"currency": "eur",
"price": 1234,
"charge": 78,
"charge_calculator_version": 5
}
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z"
}
Create a transaction from this listing
(no description)
OK
Bad Request
code can be one of the following:
listing_is_disabledno_listing_currency: The source listing doesn't have a currency.no_listing_price: The source listing doesn't have pricing.no_listing_descr: The source listing doesn't have a description.is_listing_creator: The current user created this listing.
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"listing_id": 1990,
"listing_type": "single_use",
"status": "joined",
"currency": "eur",
"price": 1234,
"charge": 78,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Disable this listing
Calling /create_transaction on a disabled listing will return a 400 response.
(no description)
OK
Not found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"disabled": "2019-12-25T10:00:00.000Z"
}
Enable this listing
(no description)
OK
Not found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z"
}
Online Multi-use Listings
Create a new multi-use listing for the logged-in user
Multi-use listings are disabled once payment has been submitted for a transaction created from it.
- role: Role
- description: string
-
A description of the goods being sold.
- currency: Currency
- price: integer (int64)
-
The price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - charge: integer (int64)
-
The
chargevalue returned from a request to/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/charge.
Request Content-Types: application/json
Request Example
{
"role": "seller",
"description": "Soccer ticket",
"currency": "eur",
"price": 1234,
"charge": 78,
"charge_calculator_version": 5
}
Created
Bad Request
code can be one of the following:
* `invalid_role`: '' is not a valid role
Response Content-Types: application/json
Response Example (201 Created)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"description": "Soccer ticket",
"currency": "eur",
"pricing": {
"price": 1234,
"charge": 78
},
"created": "2019-12-25T09:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Get a listing by its ID
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"created": "2019-12-25T09:00:00.000Z"
}
Patch listing properties
- currency: Currency
- price: integer (int64)
-
The price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - charge: integer (int64)
-
The
chargevalue returned from a request to/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/charge. - description: string
(no description)
Request Content-Types: application/json
Request Example
{
"currency": "eur",
"price": 1234,
"charge": 78,
"charge_calculator_version": 5,
"description": "Soccer ticket"
}
OK
Bad Request
code can be one of the following:
empty_body: The request body is empty.
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"skip_remainder": true,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z"
}
Delete this listing
(no description)
No Content
Not Found
Response Content-Types: application/json
Set description for this listing
- description: string
(no description)
Request Content-Types: application/json
Request Example
{
"description": "Soccer ticket"
}
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z"
}
Set pricing for this listing
- currency: Currency
- price: integer (int64)
-
The price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - charge: integer (int64)
-
The
chargevalue returned from a request to/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/charge.
(no description)
Request Content-Types: application/json
Request Example
{
"currency": "eur",
"price": 1234,
"charge": 78,
"charge_calculator_version": 5
}
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z"
}
Create a transaction from this listing
Calling /create_transaction with no parameters will create a new transaction with the details provided by the listing.
The optional quantity parameter can be passed to create a transaction for a multiple of the original listing. In this case, the price and charge for the new transaction will also need to be passed.
As an example, consider a listing for a chair with a price of 1234 EUR. If a user wants to buy 10 of these in a single transaction then the charge for the total can be retrieved using GET /charge?price=1234¤cy=usd&quantity=10 (note the addition of the optional quantity parameter at the end). This will return a price of 12340 and an associated charge. These new values must then be passed to /create_transaction with quantity=10, which will create a new transaction with the new pricing information. The new transaction will also include a quantity field, which doesn't have a functional effect on the transaction, but is included for informational purposes.
Note that this functionality is not available for single-use listings, from which only singular transactions may be created.
(no description)
(no description)
(no description)
(no description)
OK
Bad Request
code can be one of the following:
listing_is_disabledno_listing_currency: The source listing doesn't have a currency.no_listing_price: The source listing doesn't have pricing.no_listing_descr: The source listing doesn't have a description.is_listing_creator: The current user created this listing.
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"listing_id": 1990,
"listing_type": "multi_use",
"status": "joined",
"currency": "eur",
"price": 1234,
"charge": 78,
"charge_seller": 0,
"quantity": 10,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Disable this listing
Calling /create_transaction on a disabled listing will return a 400 response.
(no description)
OK
Not found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"disabled": "2019-12-25T10:00:00.000Z"
}
Enable this listing
(no description)
OK
Not found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z"
}
F2F Transactions
Get the Trustap fee for a face-to-face transaction
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.
The currency that the price is specified in.
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¤cy=usd.
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.
OK
Bad Request
code can be one of the following:
currency_missinginvalid_pricenegative_priceprice_too_lowunsupported_currency
Response Content-Types: application/json
Response Example (200 OK)
{
"currency": "eur",
"charge": 78,
"charge_calculator_version": 2
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Create a new face-to-face transaction
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.
- role: Role
- currency: Currency
- description: string
-
A description of the goods being sold.
- deposit_price: integer (int64)
- deposit_charge: integer (int64)
- charge_calculator_version: integer (int64)
- skip_remainder: boolean
-
If
skip_remainderistruethen this transaction will move to the "confirm handover" step after the deposit has been accepted.
Request Content-Types: application/json
Request Example
{
"role": "seller",
"currency": "eur",
"description": "Soccer ticket",
"deposit_price": 1234,
"deposit_charge": 78,
"charge_calculator_version": 2
}
Created
Bad Request
code can be one of the following:
incorrect_calc_versionincorrect_chargeinvalid_calc_versionnegative_priceprice_too_low
Response Content-Types: application/json
Response Example (201 Created)
{
"id": 1309,
"status": "created",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"join_code": "54c5bb89-a5ea-4be7-ad7a-e740c2eebab4"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Get face-to-face transactions for the logged-in user
Transactions are currently sorted by ID.
Only return transactions that were created chronologically before the transaction with this ID
Only return transactions that were created chronologically after the transaction with this ID (i.e. with smaller IDs)
The maximum number of transactions to return
OK
Bad Request
code can be one of the following:
invalid_before_idinvalid_after_idinvalid_limit
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": 1309,
"status": "funds_released",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"deposit_paid": "2019-12-25T11:00:00.000Z",
"deposit_accepted": "2019-12-25T12:00:00.000Z",
"pricing": {
"price": 5000,
"charge": 190
},
"priced": "2019-12-25T13:00:00.000Z",
"remainder_paid": "2019-12-25T14:00:00.000Z",
"seller_handover_confirmed": "2019-12-25T15:00:00.000Z",
"buyer_handover_confirmed": "2019-12-25T16:00:00.000Z",
"funds_released": "2019-12-25T17:00:00.000Z"
},
{
"id": 609,
"status": "created",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2018-12-25T09:00:00.000Z",
"buyer_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"join_code": "c9cd6a9d-1096-4d38-b4aa-2c354beac845"
}
]
Response Example (400 Bad Request)
{
"code": "invalid_after_id",
"error": "invalid after id"
}
Get a transaction by its join code
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "created",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"join_code": "54c5bb89-a5ea-4be7-ad7a-e740c2eebab4"
}
Join a transaction by its join code
(no description)
OK
Bad Request
code can be one of the following:
cannot_join_own_transaction- `already_cancelled``
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "joined",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Reject a transaction by its join code
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "joined",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"rejected": "2019-12-25T10:00:00.000Z"
}
Get a transaction by its ID
(no description)
OK
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "joined",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z"
}
Updates description, currency, price and/or charge of F2F transaction
- currency: Currency
- description: string
-
A description of the goods being sold.
- deposit_price: integer (int64)
- deposit_charge: integer (int64)
(no description)
Request Content-Types: application/json
Request Example
{
"currency": "eur",
"description": "Soccer ticket",
"deposit_price": 1234,
"deposit_charge": 78
}
OK
Bad Request
code can be one of the following:
invalid_idsecond_party_already_joinedvalues_not_changed
Forbidden
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "created",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Get multiple transactions by their IDs
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
A comma-separated list of transaction IDs
OK
Bad Request
code can be one of the following:
ids_missinginvalid_idtoo_many_ids
Response Content-Types: application/json
Response Example (200 OK)
[
[
{
"id": 1309,
"status": "funds_released",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"deposit_paid": "2019-12-25T11:00:00.000Z",
"deposit_accepted": "2019-12-25T12:00:00.000Z",
"pricing": {
"price": 5000,
"charge": 190
},
"priced": "2019-12-25T13:00:00.000Z",
"remainder_paid": "2019-12-25T14:00:00.000Z",
"seller_handover_confirmed": "2019-12-25T15:00:00.000Z",
"buyer_handover_confirmed": "2019-12-25T16:00:00.000Z",
"funds_released": "2019-12-25T17:00:00.000Z"
},
{
"id": 609,
"status": "created",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2018-12-25T09:00:00.000Z",
"buyer_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"join_code": "c9cd6a9d-1096-4d38-b4aa-2c354beac845"
},
null,
{
"id": 609,
"status": "created",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2018-12-25T09:00:00.000Z",
"buyer_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"join_code": "c9cd6a9d-1096-4d38-b4aa-2c354beac845"
}
]
]
Response Example (400 Bad Request)
{
"code": "ids_missing",
"error": "`ids` query parameter is required"
}
Cancel this transaction with a description
If a transaction is cancelled after the deposit has been paid then the deposit (excluding the Trustap fee) will be returned to the buyer.
- description: string
(no description)
Request Content-Types: application/json
Request Example
{
"description": "Found another buyer"
}
OK
Bad Request
code can be one of the following:
second_party_not_joinedalready_cancelledremainder_already_paidhandover_already_confirmed
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "cancelled",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"cancelled": "2019-12-25T11:00:00.000Z",
"cancellation": {
"reason": "Found another buyer"
}
}
Response Example (400 Bad Request)
{
"code": "already_cancelled",
"error": "transaction already cancelled"
}
Cancel this transaction with a description with guest user
If a transaction is cancelled after the deposit has been paid then the deposit (excluding the Trustap fee) will be returned to the buyer.
- description: string
(no description)
Request Content-Types: application/json
Request Example
{
"description": "Found another buyer"
}
OK
Bad Request
code can be one of the following:
description_missingalready_cancelledremainder_already_paidhandover_already_confirmed
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "cancelled",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"cancelled": "2019-12-25T11:00:00.000Z",
"cancellation": {
"reason": "Found another buyer"
}
}
Response Example (400 Bad Request)
{
"code": "already_cancelled",
"error": "transaction already cancelled"
}
Cancel this transaction
DEPRECATED
Transactions should be cancelled using /transactions/{transactionId}/cancel_with_description.
(no description)
OK
Bad Request
code can be one of the following:
second_party_not_joinedalready_cancelledremainder_already_paidhandover_already_confirmed
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "cancelled",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"cancelled": "2019-12-25T11:00:00.000Z",
"cancellation": {
"reason": ""
}
}
Response Example (400 Bad Request)
{
"code": "already_cancelled",
"error": "transaction already cancelled"
}
Get the Stripe client secret for this transaction
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.
(no description)
OK
Bad Request
code can be one of the following:
deposit_already_paid
Forbidden
code can be one of the following:
not_buyer
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"client_secret": "***"
}
Response Example (400 Bad Request)
{
"code": "deposit_already_paid",
"error": "deposit payment already made"
}
Response Example (403 Forbidden)
{
"code": "not_buyer",
"error": "current user is not buyer"
}
Get the details for the Stripe publishable key that is in use for this transaction
Returns the Publishable Key for the Stripe Platform which is hosting this transaction.
(no description)
OK
Bad Request
code can be one of the following:
invalid_id
Forbidden
code can be one of the following:
not_buyernot_seller
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"publishable_key": "pk_xXxXxXxXxXx"
}
Response Example (400 Bad Request)
{
"code": "invalid_id",
"error": "couldn't parse transaction id: abc"
}
Response Example (403 Forbidden)
{
"code": "not_buyer",
"error": "current user is not buyer"
}
Set payment details and process payment for the deposit of this transaction
DEPRECATED
This endpoint will be removed in v2 of this API.
Payment should instead be processed using the asynchronous payment flow (see /p2p/transactions/{transactionId}/deposit_stripe_client_secret).
- stripe_charge_token: string
(no description)
Request Content-Types: application/json
Request Example
{
"stripe_token": "***"
}
OK
Bad Request
code can be one of the following:
card_declineddeposit_already_paidexpired_cardincorrect_cvcinsufficient_funds
Forbidden
code can be one of the following:
not_buyer
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "deposit_paid",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"deposit_paid": "2019-12-25T11:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "deposit_already_paid",
"error": "deposit payment already made"
}
Response Example (403 Forbidden)
{
"code": "not_buyer",
"error": "current user is not buyer"
}
Accept the deposit for this transaction
(no description)
OK
Forbidden
code can be one of the following:
not_seller
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "deposit_accepted",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"deposit_paid": "2019-12-25T11:00:00.000Z",
"deposit_accepted": "2019-12-25T12:00:00.000Z"
}
Response Example (403 Forbidden)
{
"code": "not_seller",
"error": "current user is not seller"
}
Accept the deposit for this transaction as a guest seller
(no description)
OK
Forbidden
code can be one of the following:
not_sellersubject_is_not_guest_userdeposit_not_paiddeposit_already_accepted
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "deposit_accepted",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"deposit_paid": "2019-12-25T11:00:00.000Z",
"deposit_accepted": "2019-12-25T12:00:00.000Z"
}
Response Example (403 Forbidden)
{
"code": "not_seller",
"error": "current user is not seller"
}
Skip the remainder for this transaction
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.
(no description)
OK
Bad Request
code can be one of the following:
price_already_set
Forbidden
code can be one of the following:
not_seller
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "remainder_skipped",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"deposit_paid": "2019-12-25T11:00:00.000Z",
"deposit_accepted": "2019-12-25T12:00:00.000Z",
"remainder_skipped": "2019-12-25T13:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Response Example (403 Forbidden)
{
"code": "not_seller",
"error": "current user is not seller"
}
Set the total price for this transaction
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.
- currency: Currency
- price: integer (int64)
-
The price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - charge: integer (int64)
-
The
chargevalue returned from a request to/p2p/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/p2p/charge.
(no description)
Request Content-Types: application/json
Request Example
{
"currency": "eur",
"price": 5000,
"charge": 190,
"charge_calculator_version": 2
}
OK
Bad Request
code can be one of the following:
currency_mismatch: Pricing currency is different to the transaction's currency.remainder_already_skippedremainder_too_low: The difference between the total price of this transaction isn't larger than the deposit price.
Forbidden
code can be one of the following:
not_seller
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "deposit_accepted",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"deposit_paid": "2019-12-25T11:00:00.000Z",
"deposit_accepted": "2019-12-25T12:00:00.000Z",
"pricing": {
"price": 5000,
"charge": 190
},
"priced": "2019-12-25T13:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Response Example (403 Forbidden)
{
"code": "not_seller",
"error": "current user is not seller"
}
Get the Stripe client secret for this transaction
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.
(no description)
OK
Bad Request
code can be one of the following:
missing_pricing: Pricing details have not yet been added to this transaction.remainder_already_paid
Forbidden
code can be one of the following:
not_buyer
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"client_secret": "***"
}
Response Example (400 Bad Request)
{
"code": "remainder_already_paid",
"error": "remainder payment already made"
}
Response Example (403 Forbidden)
{
"code": "not_buyer",
"error": "current user is not buyer"
}
Set payment details and process payment for the remainder of this transaction
DEPRECATED
This endpoint will be removed in v2 of this API.
Payment should instead be processed using the asynchronous payment flow (see /p2p/transactions/{transactionId}/deposit_stripe_client_secret).
- stripe_charge_token: string
(no description)
Request Content-Types: application/json
Request Example
{
"stripe_token": "***"
}
OK
Bad Request
code can be one of the following:
card_declinedexpired_cardincorrect_cvcinsufficient_fundsinvalid_idmissing_pricing: Pricing details have not yet been added to this transaction.remainder_already_paid
Forbidden
code can be one of the following:
not_buyer
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "deposit_accepted",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"deposit_paid": "2019-12-25T11:00:00.000Z",
"deposit_accepted": "2019-12-25T12:00:00.000Z",
"pricing": {
"price": 5000,
"charge": 190
},
"priced": "2019-12-25T13:00:00.000Z",
"remainder_paid": "2019-12-25T14:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "remainder_already_paid",
"error": "remainder payment already made"
}
Response Example (403 Forbidden)
{
"code": "not_buyer",
"error": "current user is not buyer"
}
Get details of the buyer from this transaction
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"email": "string",
"phone": "string"
}
Get details of the seller from this transaction
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"email": "string",
"phone": "string"
}
Submit a complaint for this transaction
- description: string
(no description)
Request Content-Types: application/json
Request Example
{
"description": "Item was fake"
}
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "deposit_accepted",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"deposit_paid": "2019-12-25T11:00:00.000Z",
"deposit_accepted": "2019-12-25T12:00:00.000Z",
"pricing": {
"price": 5000,
"charge": 190
},
"priced": "2019-12-25T13:00:00.000Z",
"remainder_paid": "2019-12-25T14:00:00.000Z",
"complaint": {
"description": "Item was fake"
},
"complained": "2019-12-25T15:00:00.000Z"
}
Confirm handover for this transaction
Both parties should confirm the handover for a face-to-face transaction. The complaints period begins when the seller confirms the handover.
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"status": "seller_handover_confirmed",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"deposit_paid": "2019-12-25T11:00:00.000Z",
"deposit_accepted": "2019-12-25T12:00:00.000Z",
"pricing": {
"price": 5000,
"charge": 190
},
"priced": "2019-12-25T13:00:00.000Z",
"remainder_paid": "2019-12-25T14:00:00.000Z",
"seller_handover_confirmed": "2019-12-25T15:00:00.000Z"
}
Create a new face-to-face transaction with both users
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.
- join_user_id: string
-
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.
- creator_role: Role
-
This is the role that will be given to the user making the request; the user specified by
join_user_idwill be given the complementary role. - currency: Currency
- description: string
-
A description of the goods being sold.
- deposit_price: integer (int64)
- deposit_charge: integer (int64)
- charge_calculator_version: integer (int64)
- skip_remainder: boolean
-
If
skip_remainderistruethen the transaction will move to the "confirm handover" step after the deposit has been accepted.
Request Content-Types: application/json
Request Example
{
"join_user_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"creator_role": "seller",
"currency": "eur",
"description": "Soccer ticket",
"deposit_price": 1234,
"deposit_charge": 78,
"charge_calculator_version": 2
}
Created
Bad Request
code can be one of the following:
duplicate_user_id: The user specified byjoin_user_idis the user making the request.incorrect_calc_versionincorrect_chargeinvalid_calc_versionnegative_priceprice_too_low
Response Content-Types: application/json
Response Example (201 Created)
{
"id": 1309,
"status": "joined",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Create a new face-to-face transaction with both users
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.
- seller_id: string
-
The id of the seller for this transaction (it can be full user id or guest user id).
- buyer_id: string
-
The id of the buyer for this transaction (it can be full user id or guest user id).
- creator_role: Role
-
This is the role that will be given to the user making the request; the user specified by
join_user_idwill be given the complementary role. - currency: Currency
- description: string
-
A description of the goods being sold.
- deposit_price: integer (int64)
- deposit_charge: integer (int64)
- charge_calculator_version: integer (int64)
- skip_remainder: boolean
-
If
skip_remainderistruethen the transaction will move to the "confirm handover" step after the deposit has been accepted.
Request Content-Types: application/json
Request Example
{
"join_user_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"creator_role": "seller",
"currency": "eur",
"description": "Soccer ticket",
"deposit_price": 1234,
"deposit_charge": 78,
"charge_calculator_version": 2
}
Created
Bad Request
code can be one of the following:
duplicate_user_id: The user specified byjoin_user_idis the user making the request.incorrect_calc_versionincorrect_chargeinvalid_calc_versionnegative_priceprice_too_lowno_guest_userincompatible_countriesunsupported_currency
Response Content-Types: application/json
Response Example (201 Created)
{
"id": 1309,
"status": "joined",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
F2F Single-use Listings
Create a new single-use, face-to-face listing for the logged-in user
Single-use listings are disabled once the remainder has been paid for a transaction created from it.
- role: Role
- description: string
-
A description of the goods being sold.
- currency: Currency
- deposit_price: integer (int64)
-
The deposit price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - deposit_charge: integer (int64)
-
The
chargevalue returned from a request to/p2p/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/p2p/charge. - skip_remainder: boolean
-
If
skip_remainderistruethen the transaction will move to the "confirm handover" step after the deposit has been accepted.
Request Content-Types: application/json
Request Example
{
"role": "seller",
"currency": "eur",
"description": "Soccer ticket",
"deposit_price": 1234,
"deposit_charge": 78,
"charge_calculator_version": 5
}
Created
Bad Request
code can be one of the following:
* `invalid_role`: '' is not a valid role
Response Content-Types: application/json
Response Example (201 Created)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"description": "Soccer ticket",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"skip_remainder": false,
"allows_multi_use": false,
"created": "2019-12-25T09:00:00.000Z"
}
Create a new single-use, face-to-face listing for the logged-in user
DEPRECATED
Single-use-listings for F2F transactions should be created using /p2p/me/single_use_listings/create.
Single-use listings are disabled once the remainder has been paid for a transaction created from it.
Created
Response Content-Types: application/json
Response Example (201 Created)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"description": "",
"skip_remainder": false,
"allows_multi_use": false,
"created": "2019-12-25T09:00:00.000Z"
}
Get a listing by its ID
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"description": "",
"skip_remainder": false,
"allows_multi_use": false,
"created": "2019-12-25T09:00:00.000Z"
}
Patch listing properties
- currency: Currency
- deposit_price: integer (int64)
-
The deposit price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - deposit_charge: integer (int64)
-
The
chargevalue returned from a request to/p2p/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/p2p/charge. - description: string
- skip_remainder: boolean
(no description)
Request Content-Types: application/json
Request Example
{
"currency": "eur",
"deposit_price": 1234,
"deposit_charge": 78,
"charge_calculator_version": 5,
"description": "Soccer ticket",
"skip_remainder": false
}
OK
Bad Request
code can be one of the following:
empty_body: The request body is empty.
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"skip_remainder": false,
"allows_multi_use": false,
"created": "2019-12-25T09:00:00.000Z"
}
Delete this listing
(no description)
OK
Not Found
Response Content-Types: application/json
Set the description for this listing
- description: string
(no description)
Request Content-Types: application/json
Request Example
{
"description": "Soccer ticket"
}
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"description": "Soccer ticket",
"skip_remainder": false,
"allows_multi_use": false,
"created": "2019-12-25T09:00:00.000Z"
}
Set pricing for this listing
- currency: Currency
- deposit_price: integer (int64)
-
The deposit price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - deposit_charge: integer (int64)
-
The
chargevalue returned from a request to/p2p/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/p2p/charge.
(no description)
Request Content-Types: application/json
Request Example
{
"currency": "eur",
"deposit_price": 1234,
"deposit_charge": 78,
"charge_calculator_version": 5
}
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"skip_remainder": false,
"allows_multi_use": false,
"created": "2019-12-25T09:00:00.000Z"
}
Create a transaction from this listing
(no description)
OK
Bad Request
code can be one of the following:
listing_is_disabledis_listing_creator: The current user created this listing.
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"listing_id": 1990,
"listing_type": "single_use",
"status": "joined",
"currency": "eur",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Disable this listing
Calling /create_transaction on a disabled listing will return a 400 response.
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"description": "Soccer ticket",
"skip_remainder": false,
"allows_multi_use": false,
"created": "2019-12-25T09:00:00.000Z",
"disabled": "2019-12-25T10:00:00.000Z"
}
Enable this listing
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"description": "Soccer ticket",
"skip_remainder": false,
"allows_multi_use": false,
"created": "2019-12-25T09:00:00.000Z"
}
F2F Multi-use Listings
Create a new multi-use, face-to-face listing for the logged-in user
Multi-use listings can be used to create transactions.
- role: Role
- description: string
-
A description of the goods being sold.
- currency: Currency
- deposit_price: integer (int64)
-
The price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - deposit_charge: integer (int64)
-
The
chargevalue returned from a request to/p2p/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/p2p/charge. - skip_remainder: boolean
-
If
skip_remainderistruethen the transaction will move to the "confirm handover" step after the deposit has been accepted.
Request Content-Types: application/json
Request Example
{
"role": "seller",
"currency": "eur",
"description": "Soccer ticket",
"deposit_price": 1234,
"deposit_charge": 78,
"charge_calculator_version": 5
}
Created
Bad Request
code can be one of the following:
* `invalid_role`: '' is not a valid role
Response Content-Types: application/json
Response Example (201 Created)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"description": "Soccer ticket",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"skip_remainder": false,
"allows_multi_use": true,
"created": "2019-12-25T09:00:00.000Z"
}
Create a new multi-use, face-to-face listing for the logged-in user
DEPRECATED
Multi-use-listings for online transactions should be created using /p2p/me/multi_use_listings/create.
Multi-use listings can be used to create transactions.
Created
Response Content-Types: application/json
Response Example (201 Created)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"description": "",
"skip_remainder": false,
"allows_multi_use": true,
"created": "2019-12-25T09:00:00.000Z"
}
Get a listing by its ID
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"description": "",
"skip_remainder": false,
"allows_multi_use": true,
"created": "2019-12-25T09:00:00.000Z"
}
Patch listing properties
- currency: Currency
- deposit_price: integer (int64)
-
The deposit price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - deposit_charge: integer (int64)
-
The
chargevalue returned from a request to/p2p/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/p2p/charge. - description: string
- skip_remainder: boolean
(no description)
Request Content-Types: application/json
Request Example
{
"currency": "eur",
"deposit_price": 1234,
"deposit_charge": 78,
"charge_calculator_version": 5,
"description": "Soccer ticket",
"skip_remainder": false
}
OK
Bad Request
code can be one of the following:
empty_body: The request body is empty.
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"pricing": {
"price": 1234,
"charge": 78
},
"skip_remainder": false,
"allows_multi_use": true,
"created": "2019-12-25T09:00:00.000Z"
}
Delete this listing
(no description)
OK
Not Found
Response Content-Types: application/json
Set the description for this listing
- description: string
(no description)
Request Content-Types: application/json
Request Example
{
"description": "Soccer ticket"
}
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"description": "Soccer ticket",
"skip_remainder": false,
"allows_multi_use": true,
"created": "2019-12-25T09:00:00.000Z"
}
Set pricing for this listing
- currency: Currency
- deposit_price: integer (int64)
-
The deposit price of the goods being sold, in the
currency's smallest unit. Thechargevalue should correspond to the Trustap charge created with this price, otherwise this request will fail with a400error. - deposit_charge: integer (int64)
-
The
chargevalue returned from a request to/p2p/charge. - charge_calculator_version: integer (int64)
-
The
charge_calculator_versionvalue returned from a request to/p2p/charge.
(no description)
Request Content-Types: application/json
Request Example
{
"currency": "eur",
"deposit_price": 1234,
"deposit_charge": 78,
"charge_calculator_version": 5
}
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"pricing": {
"price": 1234,
"charge": 78
},
"skip_remainder": false,
"allows_multi_use": true,
"created": "2019-12-25T09:00:00.000Z"
}
Set skip remainder for this listing
- skip_remainder: boolean
(no description)
Request Content-Types: application/json
Request Example
{
"skip_remainder": "boolean"
}
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"description": "Soccer ticket",
"skip_remainder": false,
"allows_multi_use": true,
"created": "2019-12-25T09:00:00.000Z"
}
Create a transaction from this listing
Calling /create_transaction with no parameters will create a new transaction with the details provided by the listing.
The optional quantity parameter can be passed to create a transaction for a multiple of the original listing. In this case, the price and charge for the new transaction will also need to be passed.
As an example, consider a listing for a chair with a price of 1234 EUR. If a user wants to buy 10 of these in a single transaction then the charge for the total can be retrieved using GET /p2p/charge?price=1234¤cy=usd&quantity=10 (note the addition of the optional quantity parameter at the end). This will return a price of 12340 and an associated charge. These new values must then be passed to /create_transaction with quantity=10, which will create a new transaction with the new pricing information. The new transaction will also include a quantity field, which doesn't have a functional effect on the transaction, but is included for informational purposes.
Note that this functionality is not available for single-use listings, from which only singular transactions may be created.
(no description)
(no description)
(no description)
(no description)
OK
Bad Request
code can be one of the following:
listing_is_disabledis_listing_creator: The current user created this listing.
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1309,
"listing_id": 1990,
"listing_type": "multi_use",
"status": "joined",
"currency": "eur",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"quantity": 10,
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z"
}
Response Example (400 Bad Request)
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Disable this listing
Calling /create_transaction on a disabled listing will return a 400 response.
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"description": "Soccer ticket",
"skip_remainder": false,
"allows_multi_use": true,
"created": "2019-12-25T09:00:00.000Z",
"disabled": "2019-12-25T10:00:00.000Z"
}
Enable this listing
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"currency": "eur",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"description": "Soccer ticket",
"skip_remainder": false,
"allows_multi_use": true,
"created": "2019-12-25T09:00:00.000Z"
}
Notifications
Get notifications for the logged-in user
Only return transactions that were created chronologically before the transaction with this ID
Only return notifications that were created chronologically after the notification with this ID (i.e. with smaller IDs)
The maximum number of notifications to return
OK
Bad Request
code can be one of the following:
invalid_before_idinvalid_after_idinvalid_limit
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": 1990,
"created": "2019-12-25T10:00:00.000Z",
"user_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"description": "Buyer has joined transaction for 'Soccer ticket'",
"target": "basic/1309"
}
]
Response Example (400 Bad Request)
{
"code": "invalid_after_id",
"error": "invalid after id"
}
Get a notification by its ID
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1990,
"created": "2019-12-25T10:00:00.000Z",
"user_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"description": "Buyer has joined transaction for 'Soccer ticket'",
"target": "basic/1309"
}
Mark this notification as read
(no description)
OK
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"id": 1990,
"created": "2019-12-25T10:00:00.000Z",
"read": "2019-12-25T11:00:00.000Z",
"user_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"description": "Buyer has joined transaction for 'Soccer ticket'",
"target": "basic/1309"
}
Personal
Get verification status for the front side of the primary identity document
OK
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "verifying",
"previously_submitted": true
}
Get verification status for the back side of the primary identity document
OK
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "verifying",
"previously_submitted": true
}
Get verification status for the front side of the secondary identity document
OK
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "verifying",
"previously_submitted": true
}
Get verification status for the back side of the secondary identity document
OK
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "verifying",
"previously_submitted": true
}
Get the status of a user's ability to accept payouts. This endpoint requires the user identified by the Trustap-User header to have granted the profile scope to the client that is performing the request.
OK
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "verifying"
}
Get the details for the Stripe publishable key the user is linked to.
Returns the Publishable Key for the Stripe Platform which the user is linked to.
OK
Response Content-Types: application/json
Response Example (200 OK)
{
"publishable_key": "pk_xXxXxXxXxXx"
}
Schema Definitions
basic.Charge: object
- currency: string
- charge: integer (int64)
-
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. - charge_seller: integer (int64)
-
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. - charge_calculator_version: integer (int64)
-
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_versionproperty will be used to return anincorrect_calc_versionto the API client, which will indicate that the/chargeendpoint should be queried again to get the newest charge value. - price: integer (int64)
Example
{
"currency": "eur",
"charge": 78,
"charge_calculator_version": 5
}
P2pCharge: object
- currency: string
- charge: integer (int64)
-
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. - charge_seller: integer (int64)
-
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. - charge_calculator_version: integer (int64)
-
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_versionproperty will be used to return anincorrect_calc_versionto the API client, which will indicate that the/chargeendpoint should be queried again to get the newest charge value. - price: integer (int64)
Example
{
"currency": "eur",
"charge": 78,
"charge_calculator_version": 5
}
Error: object
- code: string
- error: string
-
A contextual description of the error that occurred. When handling errors the
codefield should be used to determine the type of error that occurred, as the text in theerrorfield may change unexpectedly.
Example
{
"code": "negative_price",
"error": "`price` cannot be negative"
}
Pricing: object
- price: integer (int64)
- charge: integer (int64)
Example
{
"price": 1234,
"charge": 78
}
BasicSingleUseListing: object
- id: integer (int64)
- creator_id: string
- creator_role: string
- currency: string
- pricing: Pricing
- description: string
- disabled: string
- created: string
Example
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"created": "2019-12-25T09:00:00.000Z"
}
BasicMultiUseListing: object
- id: integer (int64)
- creator_id: string
- creator_role: string
- currency: string
- pricing: Pricing
- description: string
- disabled: string
- created: string
Example
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"created": "2019-12-25T09:00:00.000Z"
}
P2PSingleUseListing: object
- id: integer (int64)
- creator_id: string
- creator_role: string
- currency: string
- deposit_pricing: Pricing
- description: string
- skip_remainder: boolean
- allows_multi_use: boolean
- created: string
- disabled: string
Example
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"description": "",
"skip_remainder": false,
"allows_multi_use": false,
"created": "2019-12-25T09:00:00.000Z"
}
P2PMultiUseListing: object
- id: integer (int64)
- creator_id: string
- creator_role: string
- currency: string
- deposit_pricing: Pricing
- description: string
- skip_remainder: boolean
- allows_multi_use: boolean
- created: string
Example
{
"id": "77f36253-7a43-4d47-897d-f73dd208e17a",
"creator_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"deposit_pricing": {
"price": 5000,
"charge": 150
},
"description": "",
"skip_remainder": false,
"allows_multi_use": true,
"created": "2019-12-25T09:00:00.000Z"
}
Notification: object
- id: integer (int64)
- created: string
- read: string
- user_id: string
- description: string
- target: string
Example
{
"id": 1990,
"created": "2019-12-25T10:00:00.000Z",
"user_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"description": "Buyer has joined transaction for 'Soccer ticket'",
"target": "basic/1309"
}
basic.Transaction: object
- status: string
- id: integer (int64)
- listing_id: string
-
If the transaction is created from a listing then this is the ID of that listing; otherwise this property is omitted.
- listing_type: ListingType
-
If the transaction is created from a listing then this is the type of that listing; otherwise this property is omitted.
- currency: string
-
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.
- price: integer (int64)
- charge: integer (int64)
- charge_seller: integer (int64)
- description: string
- quantity: integer (int64)
- created: string (date-time)
- buyer_id: string
- seller_id: string
- joined: string (date-time)
- listing_creator_accepted: string (date-time)
- listing_creator_rejected: string (date-time)
- denied: string (date-time)
- is_payment_in_progress: boolean
-
If the transaction is paid via a delayed payment method, such as SEPA debit, this field will be
trueuntil the payment has fully succeeded or failed. - paid: string (date-time)
- payment_accepted: string (date-time)
- payment_refunded: string (date-time)
- tracked: string (date-time)
- tracking: Tracking
- tracking_details_window_started: string (date-time)
- tracking_details_deadline: string (date-time)
- delivered: string (date-time)
- complained: string (date-time)
- complaint: Complaint
- complaint_period_ended: string (date-time)
- complaint_period_deadline: string (date-time)
- funds_released: string (date-time)
- released_to_seller: boolean
- join_code: string
Example
{
"id": 1309,
"status": "funds_released",
"currency": "eur",
"price": 1234,
"charge": 78,
"charge_seller": 0,
"quantity": 1,
"description": "Soccer ticket",
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"is_payment_in_progress": false,
"paid": "2019-12-25T11:00:00.000Z",
"tracked": "2019-12-25T12:00:00.000Z",
"tracking": {
"carrier": "ups",
"tracking_code": "***"
},
"delivered": "2019-12-25T13:00:00.000Z",
"funds_released": "2019-12-26T14:00:00.000Z"
}
P2PTransaction: object
- id: integer (int64)
- listing_id: string
-
If the transaction is created from a listing then this is the ID of that listing; otherwise this property is omitted.
- listing_type: ListingType
-
If the transaction is created from a listing then this is the type of that listing; otherwise this property is omitted.
- currency: string
-
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.
- deposit_pricing: Pricing
- description: string
- skip_remainder: boolean
-
If
skip_remainderistruethen this transaction will move to the "confirm handover" step after the deposit has been accepted. - created: string
- buyer_id: integer (int64)
- seller_id: integer (int64)
- joined: string
- rejected: string
- cancelled: string
- is_deposit_payment_in_progress: boolean
-
If the deposit is paid via a delayed payment method, such as SEPA debit, this field will be
trueuntil the payment has fully succeeded or failed. - deposit_paid: string
- deposit_accepted: string
- priced: string
- pricing: Pricing
- is_remainder_payment_in_progress: boolean
-
If the remainder is paid via a delayed payment method, such as SEPA debit, this field will be
trueuntil the payment has fully succeeded or failed. - remainder_paid: string
- buyer_handover_confirmed: string
- seller_handover_confirmed: string
- funds_released: string
- complaint: string
- complained: string
Example
{
"id": 1309,
"status": "funds_released",
"currency": "eur",
"deposit_pricing": {
"price": 1234,
"charge": 78
},
"description": "Soccer ticket",
"skip_remainder": false,
"created": "2019-12-25T09:00:00.000Z",
"seller_id": "ad5bb99f-85bf-47e1-be0d-15e7541c6ad7",
"buyer_id": "feb33a87-3917-4538-9260-127c8a6b5232",
"joined": "2019-12-25T10:00:00.000Z",
"is_deposit_payment_in_progress": false,
"deposit_paid": "2019-12-25T11:00:00.000Z",
"deposit_accepted": "2019-12-25T12:00:00.000Z",
"pricing": {
"price": 5000,
"charge": 190
},
"priced": "2019-12-25T13:00:00.000Z",
"is_remainder_payment_in_progress": false,
"remainder_paid": "2019-12-25T14:00:00.000Z",
"seller_handover_confirmed": "2019-12-25T15:00:00.000Z",
"buyer_handover_confirmed": "2019-12-25T16:00:00.000Z",
"funds_released": "2019-12-25T17:00:00.000Z"
}
Tracking: object
- carrier: string
- tracking_code: string
Example
{
"carrier": "ups",
"tracking_code": "***"
}
DocumentVerification: object
- status: string
-
Verification status of the document could be one of the following:
due,not_due,verifying,verified - previously_submitted: boolean
Example
{
"status": "string",
"previously_submitted": "boolean"
}
ProfilePayoutStatus: object
- status: string
-
Payout status will be one of the following:
complete: The user has completed their profile and payment information, and can accept payouts.verifying: The user has submitted profile and payment information, which is currently being verified.due: The user has not adequately filled out their payment information, or may need to update or ammend the provided information before they can accept payouts.
Example
{
"status": "string"
}
ShippingDetails: object
- name: string
- address: ShippingDetailsAddress
Example
{
"name": "string",
"address": {
"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postal_code": "string",
"state": "string"
}
}