Trustap API

https://docs.trustap.com/apis/openapi
Admin
Trustap API is a REST-based API for managing user data and transactions for online and face-to-face...
Tokens:11,750
Snippets:31
Trust Score:9.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET /v2/fees

Source: https://docs.trustap.com/apis/openapi/payment/v2_transactions.getfees.md

Returns the Trustap fee for a transaction involving goods with the supplied amount. The calculated fee is returned in the currency's smallest unit.

```APIDOC
## GET /v2/fees

### Description
This returns the Trustap fee, in the currency's smallest unit, for a transaction involving goods with the supplied amount.

### Method
GET

### Endpoint
/v2/fees

### Security
- APIKey
- OAuth2

### Parameters
#### Query Parameters
- **currency** (string) - Required - The currency that the amount is specified in.
- **amount** (integer) - Required - The price of the goods being sold in this transaction, in the currency's smallest unit.
- **amount_extra** (integer) - Optional - Represents an additional charge to be paid by the buyer added to the transaction total (defaults to 0).
- **amount_postage** (integer) - Optional - Represents an additional charge to be paid by the buyer, seller, or client (e.g., shipping surcharges).
- **payment_method** (string) - Optional - The payment method that will be used to pay for the transaction (`card` or `bank_transfer`, defaults to `card`).
- **fees_config** (integer) - Optional - The fee config for which the fees are computed.

### Response
#### Success Response (200)
- **buyer** (integer) - Required - Example: `78`
- **config** (integer) - Required - Example: `1`
- **seller** (integer) - Required

#### Response Example (200)
```json
{
  "buyer": 78,
  "config": 1,
  "seller": 0
}
```

#### Error Response (400)
- **code** (string) - Required - Enum: `"currency_missing"`, `"invalid_amount"`, `"negative_amount"`, `"amount_too_low"`, `"unsupported_currency"`, `"invalid_fee_config"`, `"unsupported_combination"`
- **message** (string) - Required - Example: `"`amount` cannot be negative"`
```

--------------------------------

### GET /v2/transactions/{transaction_id}/buyer_details

Source: https://docs.trustap.com/apis/openapi/transactions/v2_transactions.getbuyerdetailsfortransaction.md

Retrieves the buyer's contact details for a specified transaction. Requires authentication via APIKey or OAuth2.

```APIDOC
## GET /v2/transactions/{transaction_id}/buyer_details

### Description
Get the buyer's contact details for a transaction.

### Method
GET

### Endpoint
/v2/transactions/{transaction_id}/buyer_details

### Security
- APIKey
- OAuth2

### Parameters
#### Path Parameters
- **transaction_id** (string) - Required

### Response
#### Success Response (200 - application/json)
- **email** (string) - Required
- **name** (object)
  - **first** (string) - Required
  - **last** (string) - Required
- **phone** (string)
```

--------------------------------

### GET /v2/transactions/{transaction_id}/shipping_details

Source: https://docs.trustap.com/apis/openapi/shipping/v2_transactions.getshippingdetailsfortransaction.md

Retrieves the shipping details of the buyer associated with a specific transaction. Requires transaction ID as a path parameter and authentication via APIKey or OAuth2.

```APIDOC
## GET /v2/transactions/{transaction_id}/shipping_details\n\n### Description\nGet the shipping details of the buyer for a transaction.\n\n### Method\nGET\n\n### Endpoint\n/v2/transactions/{transaction_id}/shipping_details\n\n### Parameters\n#### Path Parameters\n- **transaction_id** (string) - Required\n\n### Response\n#### Success Response (200 application/json)\n- **address** (object) - Required\n- **address.city** (string) - Required\n- **address.country** (string) - Required\n- **address.line1** (string) - Required\n- **address.line2** (string) - Required\n- **address.postal_code** (string) - Required\n- **address.state** (string) - Required\n- **name** (string) - Required\n- **phone** (string) - Required
```

--------------------------------

### GET /v2/transactions/{transaction_id}

Source: https://docs.trustap.com/apis/openapi/transactions/v2_transactions.gettransaction.md

Retrieves the full details of an existing transaction using its unique identifier. Returns transaction lifecycle events, pricing breakdown, buyer info, and current dispute or cancellation statuses.

```APIDOC
## GET /v2/transactions/{transaction_id}

### Description
Retrieves the details of a specific transaction by its unique ID.

### Method
GET

### Endpoint
/v2/transactions/{transaction_id}

### Security
- APIKey
- OAuth2

### Parameters
#### Path Parameters
- **transaction_id** (string) - Required - The unique identifier of the transaction.

### Response
#### Success Response (200 OK)
- **id** (string) - Required - The unique identifier of the transaction.
- **client_id** (string) - Required - Client identifier.
- **description** (string) - Required - Description of the transaction item/service.
- **contains_shipping** (boolean) - Indicates if the transaction includes shipping.
- **join_code** (string) - Join code for transaction participants.
- **payment_link** (string) - URL to the actions page where the buyer can pay the deposit.
- **metadata** (object) - Arbitrary key-value string pairs for adding extra information to transactions.
- **buyer** (object) - Information about the buyer.
  - **buyer.id** (string) - Required - Buyer's identifier.
  - **buyer.is_guest** (boolean) - Required - Indicates whether the buyer is a guest.
- **cancellation** (object) - Cancellation details.
  - **cancellation.description** (string) - Required - Reason or details for cancellation.
- **complaint** (object) - Complaint details.
  - **complaint.accepted** (string) - Acceptance status/details of the complaint.
  - **complaint.category** (string) - Required - Enum: `item_not_received`, `item_not_as_described`, `other`.
  - **complaint.description** (string) - Required - Description of the complaint.
- **deadlines** (object) - Required - All possible actions with associated deadlines for completion. Actions with `null` have no pending deadlines.
  - **deadlines.complaints** (string, null) - Complaint deadline timestamp.
- **order_issue** (object) - Order issue details.
  - **order_issue.category** (string) - Required - Enum: `item_not_received`, `other`.
  - **order_issue.description** (string) - Required - Description of the order issue.
- **events** (object) - Required - Lifecycle event records for the transaction.
  - **events.by_key** (object) - Required - Timestamps indicating the first instance of each event.
    - **events.by_key.created** (string) - Required - Timestamp when transaction was created.
    - **events.by_key.buyer_handover_confirmed** (string)
    - **events.by_key.cancelled** (string)
    - **events.by_key.claimed_by_buyer** (string)
    - **events.by_key.claimed_by_seller** (string)
    - **events.by_key.complaint_period_ended** (string)
    - **events.by_key.complaint_submitted** (string)
    - **events.by_key.delivered** (string)
    - **events.by_key.funds_released** (string)
    - **events.by_key.joined** (string)
    - **events.by_key.order_issue_submitted** (string)
    - **events.by_key.paid** (string)
    - **events.by_key.payment_accepted** (string)
    - **events.by_key.refunded** (string)
    - **events.by_key.rejected** (string)
    - **events.by_key.review_flagged** (string)
    - **events.by_key.seller_handover_confirmed** (string)
    - **events.by_key.tracked** (string)
  - **events.by_time** (array) - Required - List of all chronological event records.
    - **events.by_time[].at** (string) - Required - Timestamp of the event.
    - **events.by_time[].by** (string) - ID of the user that triggered the event. Omitted for platform-triggered events.
    - **events.by_time[].code** (string) - Required - Event code.
- **funds_release** (object) - Funds release and refund details.
  - **funds_release.payout_id** (string) - Payout identifier.
  - **funds_release.released_to_seller** (boolean) - Required - Whether funds were released to the seller.
  - **funds_release.refunds** (array) - Required - List of refunds.
    - **funds_release.refunds[].id** (string) - Required - Refund ID.
    - **funds_release.refunds[].amount** (integer) - Required - Refund amount in smallest currency unit.
- **pricing** (object) - Required - Pricing and fee breakdown.
  - **pricing.amount** (integer) - Required - Base amount in smallest currency unit.
  - **pricing.amount_extra** (integer) - Required - Additional charge paid by buyer (e.g. processing fees, local taxes) in smallest currency unit.
  - **pricing.amount_postage** (integer) - Shipping surcharge in smallest currency unit.
  - **pricing.currency** (string) - Required - Currency code of the transaction.
  - **pricing.postage_bearer** (string) - Party responsible for postage. Enum: `buyer`, `seller`, `client`.
  - **pricing.fees** (object) - Required - Fee breakdown.
    - **pricing.fees.buyer** (integer) - Required - Buyer fee.
    - **pricing.fees.buyer_client** (integer) - Required - Buyer client fee.
    - **pricing.fees.seller** (integer) - Required - Seller fee.
    - **pricing.fees.seller_client** (integer) - Required - Seller client fee.
    - **pricing.fees.international_payment** (integer) - International payment fee.
- **review** (object) - Review and fraud evaluation information.
  - **review.approved** (boolean) - Whether the transaction review was approved.
  - **review.outcome_reason** (string) - Reason or explanation of the review outcome.
```

--------------------------------

### GET /v2/transactions/{transaction_id}/bank_transfer_details

Source: https://docs.trustap.com/apis/openapi/transactions/v2_transactions.getbanktransferdetails.md

Retrieves the bank transfer details for a transaction with payment method bank_transfer. Requires authentication via APIKey or OAuth2.

```APIDOC
## GET /v2/transactions/{transaction_id}/bank_transfer_details

### Description
Get the bank transfer details for a transaction with payment method bank_transfer.

### Method
GET

### Endpoint
/v2/transactions/{transaction_id}/bank_transfer_details

### Security
- APIKey
- OAuth2

### Parameters
#### Path Parameters
- **transaction_id** (string) - Required

### Response
#### Success Response (200)
- **processor** (string) - Required
- **stripe** (object) - Optional
- **stripe.amount** (integer) - Required
- **stripe.currency** (string) - Required
- **stripe.financial_address** (object) - Required
- **stripe.financial_address.aba** (object) - Optional
- **stripe.financial_address.aba.account_number** (string) - Required
- **stripe.financial_address.aba.bank_name** (string) - Required
- **stripe.financial_address.aba.routing_number** (string) - Required
- **stripe.financial_address.iban** (object) - Optional
- **stripe.financial_address.iban.account_holder_name** (string) - Required
- **stripe.financial_address.iban.bic** (string) - Required
- **stripe.financial_address.iban.country** (string) - Required
- **stripe.financial_address.iban.iban** (string) - Required
- **stripe.financial_address.sort_code** (object) - Optional
- **stripe.financial_address.sort_code.account_holder_name** (string) - Required
- **stripe.financial_address.sort_code.account_number** (string) - Required
- **stripe.financial_address.sort_code.sort_code** (string) - Required
- **stripe.financial_address.swift** (object) - Optional
- **stripe.financial_address.swift.account_number** (string) - Required
- **stripe.financial_address.swift.bank_name** (string) - Required
- **stripe.financial_address.swift.swift_code** (string) - Required
- **stripe.hosted_instructions_url** (string) - Required
- **stripe.reference** (string) - Required

#### Error Response (400)
- **code** (string) - Required - Enum: `"payment_method_not_bank_transfer"`, `"paid_with_balance"`
- **message** (string) - Required
```

--------------------------------

### GET /v2/carriers

Source: https://docs.trustap.com/apis/openapi/shipping/v2_transactions.getsupportedcarriers.md

Retrieves the list of carriers currently supported for automated tracking. Carrier names are meant to be displayed to users, while carrier codes are submitted when providing tracking details.

```APIDOC
## GET /v2/carriers

### Description
This returns the carriers that are currently supported for automated tracking. 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.

### Method
GET

### Endpoint
/v2/carriers

### Response
#### Success Response (200)
- **code** (string) - Required
- **name** (string) - Required
```

--------------------------------

### acceptpaymentfortransaction

Source: https://docs.trustap.com/apis/openapi/payment/v2_transactions.acceptpaymentfortransaction.md

Returns details about the transaction after payment is accepted, including pricing, review status, seller information, and tracking codes.

```APIDOC
### Response
#### Success Response (200)
- **pricing.postage_bearer** (string) - Indicates who is responsible for paying the postage amount. Only present if amount_postage is provided. Enum: `"buyer"`, `"seller"`, `"client"`
- **review** (object) - Example: `{"approved":true,"outcome_reason":"Not fraudulent."}`
  - **review.approved** (boolean, required) - Example: `true`
  - **review.outcome_reason** (string, required) - Example: `"Not fraudulent."`
- **seller** (object) - Example: `{"id":"9097","is_guest":false}`
- **status** (string, required) - Enum: `"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"`
- **tracking** (object)
  - **tracking.carrier** (string, required)
  - **tracking.tracking_code** (string, required)
```

--------------------------------

### confirmhandoverfortransaction

Source: https://docs.trustap.com/apis/openapi/handover/v2_transactions.confirmhandoverfortransaction.md

Returns the updated transaction state following a handover confirmation. The response includes review status, seller information, overall transaction status, and tracking details.

```APIDOC
### Response

#### Success Response (200)

- **pricing.postage_bearer** (string) - Indicates who is responsible for paying the postage amount. Only present if amount_postage is provided. Enum: `"buyer"`, `"seller"`, `"client"`
- **review** (object) - Review details. Example: `{"approved":true,"outcome_reason":"Not fraudulent."}`
- **review.approved** (boolean, required) - Whether the review is approved. Example: `true`
- **review.outcome_reason** (string, required) - Reason for review outcome. Example: `"Not fraudulent."`
- **seller** (object) - Seller details. Example: `{"id":"9097","is_guest":false}`
- **status** (string, required) - Transaction status. Enum: `"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"`
- **tracking** (object) - Tracking information
- **tracking.carrier** (string, required) - Tracking carrier name
- **tracking.tracking_code** (string, required) - Tracking code identifier
```

--------------------------------

### createtransaction (Response 201)

Source: https://docs.trustap.com/apis/openapi/transactions/v2_transactions.createtransaction.md

Schema definition and fields returned upon successful creation of a transaction (HTTP 201).

```APIDOC
### Response

#### Success Response (201)

- **buyer** (object) - Buyer information. Example: `{"id":"9097","is_guest":false}`
- **buyer.id** (string, required) - Unique ID of the buyer. Example: `"9097"`
- **buyer.is_guest** (boolean, required) - Whether the buyer is a guest user.
- **cancellation** (object) - Details regarding cancellation if applicable.
- **cancellation.description** (string, required) - Description of the cancellation.
- **client_id** (string, required) - ID of the client application. Example: `"1234"`
- **complaint** (object) - Complaint details if filed.
- **complaint.accepted** (string) - Timestamp or acceptance status.
- **complaint.category** (string, required) - Enum: `"item_not_received"`, `"item_not_as_described"`, `"other"`
- **complaint.description** (string, required) - Complaint description.
- **contains_shipping** (boolean) - Indicates if shipping is included in the transaction.
- **deadlines** (object, required) - Contains all possible actions that have associated deadlines for completion. Actions with null do not have deadlines currently pending. Example: `{"complaints":"2019-12-25T15:00:00Z"}`
- **deadlines.complaints** (string, null) - Deadline timestamp for complaints. Example: `"2019-12-25T15:00:00Z"`
- **description** (string, required) - Description of the transaction. Example: `"Soccer ticket"`
- **events** (object, required) - Historical and keyed event timestamps.
- **events.by_key** (object, required) - The time that the first instance of the given event occurred.
- **events.by_key.buyer_handover_confirmed** (string) - Handover confirmed by buyer timestamp.
- **events.by_key.cancelled** (string) - Cancellation timestamp.
- **events.by_key.claimed_by_buyer** (string) - Claimed by buyer timestamp.
- **events.by_key.claimed_by_seller** (string) - Claimed by seller timestamp.
- **events.by_key.complaint_period_ended** (string) - Complaint period ended timestamp.
- **events.by_key.complaint_submitted** (string) - Complaint submission timestamp.
- **events.by_key.created** (string, required) - Creation timestamp.
- **events.by_key.delivered** (string) - Delivery timestamp.
- **events.by_key.funds_released** (string) - Funds release timestamp.
- **events.by_key.joined** (string) - Join timestamp.
- **events.by_key.order_issue_submitted** (string) - Order issue submission timestamp.
- **events.by_key.paid** (string) - Payment timestamp.
- **events.by_key.payment_accepted** (string) - Payment accepted timestamp.
- **events.by_key.refunded** (string) - Refund timestamp.
- **events.by_key.rejected** (string) - Rejection timestamp.
- **events.by_key.review_flagged** (string) - Review flagged timestamp.
- **events.by_key.seller_handover_confirmed** (string) - Handover confirmed by seller timestamp.
- **events.by_key.tracked** (string) - Tracking added timestamp.
- **events.by_time** (array, required) - Sequential list of events.
- **events.by_time.at** (string, required) - Event occurrence timestamp.
- **events.by_time.by** (string) - ID of the user that triggered this event. Not present for platform-triggered automated events.
- **events.by_time.code** (string, required) - Event code.
- **funds_release** (object) - Payout and refund status. Example: `{"refunds":[],"released_to_seller":false}`
- **funds_release.payout_id** (string) - ID of the payout.
- **funds_release.refunds** (array, required) - List of refunds. Example: `[]`
- **funds_release.refunds.amount** (integer, required) - Refund amount in currency subunits.
- **funds_release.refunds.id** (string, required) - Unique refund ID.
- **funds_release.released_to_seller** (boolean, required) - Whether funds were released to the seller.
- **id** (string, required) - Unique transaction ID. Example: `"tx_21066"`
- **join_code** (string) - Transaction join code.
- **metadata** (object) - Arbitrary key-value string pairs for adding extra information to transactions.
- **order_issue** (object) - Order issue details.
- **order_issue.category** (string, required) - Enum: `"item_not_received"`, `"other"`
- **order_issue.description** (string, required) - Description of the order issue.
- **payment_link** (string) - URL to the actions page where the buyer can pay the deposit.
- **pricing** (object, required) - Pricing breakdown.
- **pricing.amount** (integer, required) - Base transaction amount in currency subunits.
- **pricing.amount_extra** (integer, required) - Additional charge paid by buyer (e.g. processing fees, local taxes) in smallest currency units. Defaults to 0.
- **pricing.amount_postage** (integer) - Shipping/postage surcharge in smallest currency units.
- **pricing.currency** (string, required) - Currency code for the transaction.
- **pricing.fees** (object, required) - Breakdown of platform fees.
- **pricing.fees.buyer** (integer, required) - Buyer fee.
- **pricing.fees.buyer_client** (integer, required) - Buyer client fee.
- **pricing.fees.international_payment** (integer) - Fee for international payment.
- **pricing.fees.seller** (integer, required) - Seller fee.
- **pricing.fees.seller_client** (integer, required) - Seller client fee.
- **pricing.postage_bearer** (string) - Party responsible for postage. Enum: `"buyer"`, `"seller"`, `"client"`
- **review** (object) - Fraud review status. Example: `{"approved":true,"outcome_reason":"Not fraudulent."}`
- **review.approved** (boolean, required) - Whether transaction was approved.
- **review.outcome_reason** (string, required) - Reason for review outcome.
- **seller** (object) - Seller information. Example: `{"id":"9097","is_guest":false}`
```

--------------------------------

### POST /v2/transactions/{transaction_id}/submit_complaint

Source: https://docs.trustap.com/apis/openapi

Submits a complaint for issues with transactions after the order has been shipped or handover has been confirmed.

```APIDOC
## POST /v2/transactions/{transaction_id}/submit_complaint

### Description
A complaint is submitted for problems with transactions after the order has been shipped or handover has been confirmed. Before that an order issue should be submitted instead.

### Method
POST

### Endpoint
/v2/transactions/{transaction_id}/submit_complaint

### Parameters
#### Path Parameters
- **transaction_id** (string) - Required - The unique identifier of the transaction
```

--------------------------------

### POST /v2/transactions

Source: https://docs.trustap.com/apis/openapi/transactions

Create a new transaction. Offline access is allowed for this endpoint.

```APIDOC
## POST /v2/transactions

### Description
Create a new transaction. Offline access is allowed for this endpoint.

### Method
POST

### Endpoint
/v2/transactions
```

--------------------------------

### POST /v2/transactions/{transaction_id}/shipping_details

Source: https://docs.trustap.com/apis/openapi

Submits or updates the buyer's shipping details for a specified transaction.

```APIDOC
## POST /v2/transactions/{transaction_id}/shipping_details

### Description
Post the shipping details of the buyer for a transaction.

### Method
POST

### Endpoint
/v2/transactions/{transaction_id}/shipping_details

### Parameters
#### Path Parameters
- **transaction_id** (string) - Required - The unique identifier of the transaction
```

--------------------------------

### v2_transactions.gettransaction

Source: https://docs.trustap.com/apis/openapi/transactions/v2_transactions.gettransaction.md

Retrieves transaction details, current status, review decisions, and tracking information.

```APIDOC
## v2_transactions.gettransaction

### Response
#### Success Response (200 application/json)
- **review.approved** (boolean) - Required. Example: `true`
- **review.outcome_reason** (string) - Required. Example: `"Not fraudulent."`
- **seller** (object) - Example: `{"id":"9097","is_guest":false}`
- **status** (string) - Required. Enum: `"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"`
- **tracking** (object)
- **tracking.carrier** (string) - Required.
- **tracking.tracking_code** (string) - Required.
```

--------------------------------

### POST /v2/transactions/{transaction_id}/claim

Source: https://docs.trustap.com/apis/openapi/transactions

Enables a client to claim a transaction on behalf of a Trustap user as a buyer or seller. Can only be accessed by clients.

```APIDOC
## POST /v2/transactions/{transaction_id}/claim

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

### Method
POST

### Endpoint
/v2/transactions/{transaction_id}/claim

### Parameters
#### Path Parameters
- **transaction_id** (string) - Required - The unique identifier of the transaction.
```

--------------------------------

### POST /v2/transactions/{transaction_id}/accept_payment

Source: https://docs.trustap.com/apis/openapi/payment/v2_transactions.acceptpaymentfortransaction.md

Accepts the payment for a specified transaction. Returns the detailed transaction object including pricing, events, deadlines, and release status.

```APIDOC
## POST /v2/transactions/{transaction_id}/accept_payment

### Description
Accept the payment for a transaction.

### Method
POST

### Endpoint
/v2/transactions/{transaction_id}/accept_payment

### Security
- APIKey
- OAuth2

### Parameters
#### Header Parameters
- **Trustap-User** (string) - Optional - Required in client flows, where you make API calls on behalf of another Trustap user.

#### Path Parameters
- **transaction_id** (string) - Required - The unique identifier of the transaction.

### Response
#### Success Response (200 application/json)
- **id** (string) - Required - Unique identifier for the transaction.
- **client_id** (string) - Required - ID of the client.
- **description** (string) - Required - Description of the transaction.
- **buyer** (object) - Details of the buyer.
  - **id** (string) - Required - ID of the buyer.
  - **is_guest** (boolean) - Required - Whether the buyer is a guest user.
- **cancellation** (object) - Cancellation details if cancelled.
  - **description** (string) - Required - Description of cancellation.
- **complaint** (object) - Details of any active complaint.
  - **accepted** (string) - Date/time complaint accepted.
  - **category** (string) - Required - Category enum: `item_not_received`, `item_not_as_described`, `other`.
  - **description** (string) - Required - Description of the complaint.
- **contains_shipping** (boolean) - Whether the transaction involves shipping.
- **deadlines** (object) - Required - Deadlines for completion of pending actions.
  - **complaints** (string, null) - Deadline timestamp for complaints.
- **events** (object) - Required - Event tracking information.
  - **by_key** (object) - Required - First instance timestamp for events.
    - **created** (string) - Required - Timestamp when created.
    - **buyer_handover_confirmed** (string) - Timestamp for buyer handover confirmation.
    - **cancelled** (string) - Timestamp when cancelled.
    - **claimed_by_buyer** (string) - Timestamp when claimed by buyer.
    - **claimed_by_seller** (string) - Timestamp when claimed by seller.
    - **complaint_period_ended** (string) - Timestamp when complaint period ended.
    - **complaint_submitted** (string) - Timestamp when complaint was submitted.
    - **delivered** (string) - Timestamp when delivered.
    - **funds_released** (string) - Timestamp when funds were released.
    - **joined** (string) - Timestamp when joined.
    - **order_issue_submitted** (string) - Timestamp when order issue was submitted.
    - **paid** (string) - Timestamp when paid.
    - **payment_accepted** (string) - Timestamp when payment was accepted.
    - **refunded** (string) - Timestamp when refunded.
    - **rejected** (string) - Timestamp when rejected.
    - **review_flagged** (string) - Timestamp when review was flagged.
    - **seller_handover_confirmed** (string) - Timestamp for seller handover confirmation.
    - **tracked** (string) - Timestamp when tracked.
  - **by_time** (array) - Required - List of all events ordered by time.
    - **at** (string) - Required - Timestamp of event.
    - **by** (string) - User ID that triggered the event.
    - **code** (string) - Required - Event code identifier.
- **funds_release** (object) - Information regarding release of funds.
  - **payout_id** (string) - Payout identifier.
  - **refunds** (array) - Required - List of refunds.
    - **amount** (integer) - Required - Amount of refund in smallest currency unit.
    - **id** (string) - Required - Refund ID.
  - **released_to_seller** (boolean) - Required - Whether funds have been released to the seller.
- **join_code** (string) - Join code for the transaction.
- **metadata** (object) - Arbitrary key-value string pairs for adding extra information to transactions.
- **order_issue** (object) - Order issue details.
  - **category** (string) - Required - Enum: `item_not_received`, `other`.
  - **description** (string) - Required - Description of the issue.
- **payment_link** (string) - URL to the actions page where the buyer can pay the deposit.
- **pricing** (object) - Required - Pricing and fee breakdown.
  - **amount** (integer) - Required - Base amount in smallest currency unit.
  - **amount_extra** (integer) - Required - Additional charge added to total.
  - **amount_postage** (integer) - Postage/shipping charge.
  - **currency** (string) - Required - Transaction currency code.
  - **fees** (object) - Required - Fee breakdown.
    - **buyer** (integer) - Required - Buyer fee.
    - **buyer_client** (integer) - Required - Buyer client fee.
    - **international_payment** (integer) - International payment fee.
    - **seller** (integer) - Required - Seller fee.
    - **seller_client** (integer) - Required - Seller client fee.
```

--------------------------------

### POST /v2/transactions/{transaction_id}/confirm_handover

Source: https://docs.trustap.com/apis/openapi/handover/v2_transactions.confirmhandoverfortransaction.md

Confirm the handover of goods for a transaction. This endpoint updates the transaction state when items have been handed over.

```APIDOC
## POST /v2/transactions/{transaction_id}/confirm_handover

### Description
Confirm the handover of goods for a transaction.

### Method
POST

### Endpoint
/v2/transactions/{transaction_id}/confirm_handover

### Headers
- **Trustap-User** (string) - Optional - Required in client flows, where you make API calls on behalf of another Trustap user.

### Parameters
#### Path Parameters
- **transaction_id** (string) - Required - The unique identifier of the transaction.

### Response
#### Success Response (200)
- **buyer** (object) - Information about the buyer.
  - **id** (string) - Required - The buyer's ID.
  - **is_guest** (boolean) - Required - Indicates if the buyer is a guest user.
- **cancellation** (object) - Cancellation details if applicable.
  - **description** (string) - Required - Description of the cancellation.
- **client_id** (string) - Required - The client ID associated with the transaction.
- **complaint** (object) - Details of any active complaint.
  - **accepted** (string) - Acceptance status/timestamp of the complaint.
  - **category** (string) - Required - Complaint category ("item_not_received", "item_not_as_described", "other").
  - **description** (string) - Required - Description of the complaint.
- **contains_shipping** (boolean) - Indicates if the transaction contains shipping.
- **deadlines** (object) - Required - Actions that have associated deadlines for completion. Actions with null do not have pending deadlines.
  - **complaints** (string, null) - Deadline for filing complaints.
- **description** (string) - Required - Description of the transaction.
- **events** (object) - Required - Event tracking for the transaction.
  - **by_key** (object) - Required - Indicates the time the first instance of each event occurred.
    - **buyer_handover_confirmed** (string)
    - **cancelled** (string)
    - **claimed_by_buyer** (string)
    - **claimed_by_seller** (string)
    - **complaint_period_ended** (string)
    - **complaint_submitted** (string)
    - **created** (string) - Required
    - **delivered** (string)
    - **funds_released** (string)
    - **joined** (string)
    - **order_issue_submitted** (string)
    - **paid** (string)
    - **payment_accepted** (string)
    - **refunded** (string)
    - **rejected** (string)
    - **review_flagged** (string)
    - **seller_handover_confirmed** (string)
    - **tracked** (string)
  - **by_time** (array) - Required - Chronological list of events.
    - **at** (string) - Required - Timestamp of the event.
    - **by** (string) - ID of the user that triggered this event.
    - **code** (string) - Required - Code identifying the event.
- **funds_release** (object) - Details regarding the release of transaction funds.
  - **payout_id** (string) - Identifier for the payout.
  - **refunds** (array) - Required - List of refunds.
    - **amount** (integer) - Required - Refund amount in the smallest currency unit.
    - **id** (string) - Required - Refund identifier.
  - **released_to_seller** (boolean) - Required - Whether funds were released to the seller.
- **id** (string) - Required - The transaction identifier.
- **join_code** (string) - Code used to join the transaction.
- **metadata** (object) - Arbitrary key-value string pairs for adding extra information to transactions.
- **order_issue** (object) - Details of any order issue.
  - **category** (string) - Required - Category of the order issue ("item_not_received", "other").
  - **description** (string) - Required - Description of the order issue.
- **payment_link** (string) - URL to the actions page where the buyer can pay the deposit.
- **pricing** (object) - Required - Pricing details for the transaction.
  - **amount** (integer) - Required - Base amount in the smallest currency unit.
  - **amount_extra** (integer) - Required - Additional charge paid by the buyer added to transaction total.
  - **amount_postage** (integer) - Additional charge for postage.
  - **currency** (string) - Required - Currency of the transaction.
  - **fees** (object) - Required - Fee breakdown.
    - **buyer** (integer) - Required - Fee paid by buyer.
    - **buyer_client** (integer) - Required - Fee paid by buyer client.
    - **international_payment** (integer) - International payment fee.
    - **seller** (integer) - Required - Fee paid by seller.
    - **seller_client** (integer) - Required - Fee paid by seller client.
```

--------------------------------

### POST /v2/transactions/{transaction_id}/confirm_delivery

Source: https://docs.trustap.com/apis/openapi

Allows the buyer to manually confirm delivery of the item if transaction state is not updated asynchronously.

```APIDOC
## POST /v2/transactions/{transaction_id}/confirm_delivery

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

### Method
POST

### Endpoint
/v2/transactions/{transaction_id}/confirm_delivery

### Parameters
#### Path Parameters
- **transaction_id** (string) - Required - The unique identifier of the transaction
```

--------------------------------

### POST /v2/transactions/{transaction_id}/submit_order_issue

Source: https://docs.trustap.com/apis/openapi

Submits an order issue for problems with transactions after payment confirmation and before the order is shipped or handover is confirmed.

```APIDOC
## POST /v2/transactions/{transaction_id}/submit_order_issue

### Description
An order issue is submitted for problems with transactions after payment confirmation and before the order has been shipped or handover has been confirmed. After that a complaint should be submitted instead.

### Method
POST

### Endpoint
/v2/transactions/{transaction_id}/submit_order_issue

### Parameters
#### Path Parameters
- **transaction_id** (string) - Required - The unique identifier of the transaction
```

--------------------------------

### POST /v2/transactions/{transaction_id}/metadata

Source: https://docs.trustap.com/apis/openapi/transactions

Set metadata for a specified transaction.

```APIDOC
## POST /v2/transactions/{transaction_id}/metadata

### Description
Set metadata for a transaction.

### Method
POST

### Endpoint
/v2/transactions/{transaction_id}/metadata

### Parameters
#### Path Parameters
- **transaction_id** (string) - Required - The unique identifier of the transaction.
```

--------------------------------

### POST /v2/transactions/{transaction_id}/track

Source: https://docs.trustap.com/apis/openapi/shipping/v2_transactions.tracktransaction.md

Sets postal tracking details for a transaction. After submitting tracking information, Trustap asynchronously updates the transaction state once delivery is confirmed.

```APIDOC
## POST /v2/transactions/{transaction_id}/track

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

### Method
POST

### Endpoint
/v2/transactions/{transaction_id}/track

### Headers
- **Trustap-User** (string) - Optional - Required in client flows, where you make API calls on behalf of another Trustap user.

### Parameters
#### Path Parameters
- **transaction_id** (string) - Required - The unique identifier of the transaction.

#### Request Body (application/json)
- **carrier** (string) - Required - The shipping carrier (e.g., "ups").
- **tracking_code** (string) - Required - The tracking code for the shipment.

### Request Example
```json
{
  "carrier": "ups",
  "tracking_code": "***"
}
```

### Response
#### Success Response (200 application/json)
- **id** (string) - Required - Transaction identifier.
- **description** (string) - Required - Description of the transaction item.
- **client_id** (string) - Required - Identifier of the client application.
- **contains_shipping** (boolean) - Indicates if the transaction involves shipping.
- **join_code** (string) - Join code for the transaction.
- **payment_link** (string) - URL to the actions page where the buyer can pay the deposit.
- **buyer** (object) - Details of the buyer.
  - **id** (string) - Required - Buyer user identifier.
  - **is_guest** (boolean) - Required - Indicates if the buyer is a guest.
- **cancellation** (object) - Cancellation details.
  - **description** (string) - Required - Description for cancellation.
- **complaint** (object) - Complaint details.
  - **accepted** (string) - Complaint accepted status/timestamp.
  - **category** (string) - Required - Category of complaint ("item_not_received", "item_not_as_described", "other").
  - **description** (string) - Required - Description of the complaint.
- **deadlines** (object) - Required - Deadlines for completion of possible actions.
  - **complaints** (string, null) - Deadline timestamp for submitting complaints.
- **events** (object) - Required - Lifecycle event history.
  - **by_key** (object) - Required - Map of event names to timestamps for first occurrence.
    - **created** (string) - Required - Creation timestamp.
    - **buyer_handover_confirmed** (string) - Handover confirmed by buyer timestamp.
    - **cancelled** (string) - Cancellation timestamp.
    - **claimed_by_buyer** (string) - Claimed by buyer timestamp.
    - **claimed_by_seller** (string) - Claimed by seller timestamp.
    - **complaint_period_ended** (string) - Complaint period end timestamp.
    - **complaint_submitted** (string) - Complaint submission timestamp.
    - **delivered** (string) - Delivery timestamp.
    - **funds_released** (string) - Funds release timestamp.
    - **joined** (string) - Join timestamp.
    - **order_issue_submitted** (string) - Order issue submission timestamp.
    - **paid** (string) - Payment timestamp.
    - **payment_accepted** (string) - Payment accepted timestamp.
    - **refunded** (string) - Refund timestamp.
    - **rejected** (string) - Rejection timestamp.
    - **review_flagged** (string) - Review flagged timestamp.
    - **seller_handover_confirmed** (string) - Handover confirmed by seller timestamp.
    - **tracked** (string) - Tracking submitted timestamp.
  - **by_time** (array) - Required - Chronological list of events.
    - **at** (string) - Required - Timestamp of event.
    - **by** (string) - ID of the user that triggered the event.
    - **code** (string) - Required - Event code.
- **funds_release** (object) - Funds release details.
  - **payout_id** (string) - Payout identifier.
  - **refunds** (array) - Required - List of refunds.
    - **amount** (integer) - Required - Refund amount.
    - **id** (string) - Required - Refund identifier.
  - **released_to_seller** (boolean) - Required - Whether funds are released to seller.
- **metadata** (object) - Arbitrary key-value string pairs.
- **order_issue** (object) - Order issue information.
  - **category** (string) - Required - Category ("item_not_received", "other").
  - **description** (string) - Required - Description of the issue.
- **pricing** (object) - Required - Pricing details.
  - **amount** (integer) - Required - Base amount in smallest currency unit.
  - **amount_extra** (integer) - Required - Additional charge amount.
  - **amount_postage** (integer) - Postage fee amount.
  - **currency** (string) - Required - Currency code.
  - **fees** (object) - Required - Breakdown of fees.
```
Tokens:
Raw