v4

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-04-277127123.7 KB

Orders

Update order

Updates an order's details. After payment, only metadata, fee_value, and fee_percent can be changed.

put/orders/{id}

Path parameters

idinteger required

Order ID.

Request body

buyer_idinteger

Customer ID of the buyer.

namestring

valuenumber

fee_valuenumber

fee_percentnumber

tagstring

metadataobject

imagesstring[]

Example request

{
  "name": "Demo Order",
  "value": 15
}

Response

Updated order

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.

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 €"
}