Sign in

v1

latestOpenAPI 3.0.02026-08-06202761.2 KB
Transactions

Claim a transaction on behalf of a Trustap user

This endpoint enables a client to claim a transaction on behalf of a Trustap user as a buyer or seller. This endpoint can only be accessed by clients.

post/v2/transactions/{transaction_id}/claim

Path parameters

transaction_idstring required

Headers

Trustap-Userstring

Required in client flows, where you make API calls on behalf of another Trustap user.

Request body

rolestring required

The role of the user claiming the transaction. Supported values are buyer and seller.

Response

OK

client_idstring required
contains_shippingboolean
descriptionstring required
idstring type_id required
join_codestring
metadataobject

Arbitrary key-value string pairs for adding extra information to transactions.

payment_linkstring

URL to the actions page where the buyer can pay the deposit.

status'created' | 'joined' | 'rejected' | 'cancelled' | 'paid' | 'review_flagged' | 'payment_accepted' | 'complaint_submitted' | 'complaint_period_ended' | 'refunded' | 'buyer_handover_confirmed' | 'seller_handover_confirmed' | 'tracked' | 'delivered' | 'funds_released' | 'claimed_by_buyer' | 'claimed_by_seller' required

Example response

{
  "buyer": {
    "id": "9097",
    "is_guest": false
  },
  "client_id": "1234",
  "deadlines": {
    "complaints": "2019-12-25T15:00:00Z"
  },
  "description": "Soccer ticket",
  "events": {
    "by_key": {
      "buyer_handover_confirmed": "2019-12-25T16:00:00Z",
      "created": "2019-12-25T09:00:00Z",
      "funds_released": "2019-12-25T17:00:00Z",
      "joined": "2019-12-25T10:00:00Z",
      "paid": "2019-12-25T11:00:00Z",
      "payment_accepted": "2019-12-25T12:00:00Z",
      "seller_handover_confirmed": "2019-12-25T15:00:00Z"
    },
    "by_time": []
  },
  "funds_release": {
    "refunds": [],
    "released_to_seller": false
  },
  "id": "tx_2106",
  "pricing": {
    "amount": 1000,
    "amount_extra": 0,
    "currency": "eur",
    "fees": {
      "buyer": 110,
      "buyer_client": 10,
      "international_payment": 20,
      "seller": 0,
      "seller_client": 5
    }
  },
  "review": {
    "approved": true,
    "outcome_reason": "Not fraudulent."
  },
  "seller": {
    "id": "9790",
    "is_guest": false
  },
  "status": "funds_released"
}