TRtruust-io
Orders

Cancel order

Cancels an order and refunds the buyer if a payin was made.

post/orders/{id}/cancel

Request

  • Base URL
    https://your-subdomain.truust.io/2.0
  • URL
    https://your-subdomain.truust.io/2.0/orders/{id}/cancel
  • Auth
    HTTP bearer

Path parameters

idinteger required

Order ID.

Request body

tagstring

Optional tag to record the cancellation reason.

metadataobject
bankaccount_idinteger

Required when the payin was made via bank wire, to specify the refund account.

Response

Order cancelled

idinteger
selfstring
public_idstring nullable
namestring
descriptionstring nullable
valuenumber

Order amount.

fee_valuenumber nullable
fee_percentnumber nullable
currencystring
amountstring

Formatted amount with currency symbol.

payin_amountstring nullable
payout_amountstring nullable
fee_amountstring nullable
shipping_amountstring nullable
buyer_linkstring uri

Payment URL to share with the buyer.

seller_linkstring uri

Acceptance URL to share with the seller.

qr_linkstring uri

QR code image URL for the order.

status'DRAFT' | 'PENDING_DETAILS' | 'PENDING_PUBLISH' | 'PUBLISHED' | 'ACCEPTED' | 'REJECTED' | 'CANCELLED' | 'RELEASED'
sandboxboolean
status_nicenamestring

Human-readable status label.

imagesstring[]
tagstring nullable
payin_intentsinteger nullable
payin_typesstring[] nullable
payin_fallbackstring[] nullable
metadataobject nullable
templateobject nullable
published_unitsinteger nullable
created_atstring date-time nullable
published_atstring date-time nullable

When the order was paid.

accepted_atstring date-time nullable
shipping_atstring date-time nullable
cancelled_atstring date-time nullable
validated_atstring date-time nullable
released_atstring date-time nullable
connectionsConnections

Hypermedia links to related resources.

Example response

{
  "self": "/2.0/orders/1234",
  "currency": "EUR",
  "amount": "150.00 €"
}

Changes

No recorded changes to this operation across all 8 revisions of this API.