Skip to main content
PUT
Set payment status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payment
string
required

The unique identifier of the payment.

Example:

"zrj3pok3ikbx"

store
string
required

The unique identifier of the store.

Example:

"waxhsjr47zsl"

Body

application/json
status
enum<string>
required

The status to set for the payment

Available options:
DELIVERING,
UNDER_REVIEW
Example:

"DELIVERING"

courier
string

Name of the courier service used for delivery (optional). Only allowed when status is 'DELIVERING'. Replaces the value set when the payment was created; omit it to keep the current value.

Required string length: 1 - 64
Example:

"Coordinadora"

trackingNumber
string

Courier tracking number for delivery (optional, digits only, up to 64 digits). Only allowed when status is 'DELIVERING'. Replaces the value set when the payment was created; omit it to keep the current value.

Pattern: ^\d{1,64}$
Example:

"453265"

Response

204

Successfully set payment status.