TRtrustap
Shipping

Set postal tracking details for a transaction

Changed on

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.

post/v2/transactions/{transaction_id}/track

Request

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

carrierstring required
tracking_codestring required

Example request

{
  "carrier": "ups",
  "tracking_code": "***"
}

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' | '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": {
      "created": "2019-12-25T09:00:00Z",
      "delivered": "2019-12-25T16: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"
    },
    "by_time": []
  },
  "funds_release": {
    "refunds": [],
    "released_to_seller": false
  },
  "id": "tx_21066",
  "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"
}

Changes

  • ee7f9f13c513Revision changes
    • warning

      added the new deposit_not_accepted enum value to the response property for the response status

    • info

      added the optional property to the response with the status

  • 7cd924622f3aRevision changes
    • info

      removed the buyer_handover_confirmed enum value from the response property for the response status

    • info

      removed the seller_handover_confirmed enum value from the response property for the response status