Refund Order

post

https://api.digitalfemsa.io/orders/{id}/refunds

Creates a refund for an order. This operation is used to refund a previously paid order (fully or partially, depending on the request body). The API will validate the order and its related charges before processing the refund. If the refund cannot be created due to business rules or state, an error response is returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Identifier of the resource

Body Params

requested field for a refund

amount

integer

required

Amount to refund. If not provided, the API refunds the refundable amount of the selected charge.

charge_id

string | null

Charge ID to refund. If not provided, the API selects a refundable charge from the order.

reason

string

enum

required

Refund reason. If not provided, the API uses a default reason.

Allowed:

expires_at

int64 | null

Expiration timestamp for cash refunds (must be within the allowed range configured by the API).

Headers

Accept-Language

string

enum

Defaults to es

Use for knowing which language to use

Allowed:

X-Child-Company-Id

string

In the case of a holding company, the company id of the child company to which will process the request.

Responses

200successful operation

401authentication error

402payment required error

404not found entity

422parameter validation error

500internal server error