Refund an order - V1

Deprecated

PUT

/order/v1/refund

• Sandbox

Refund an order by the way only order with payment methods BINANCE_PAY, PIX and SPEI are allowed to refund. For other payment methods, we are implementing them.

NOTE: Please, to authenticate use the scope: “api://app-order-hml”

Authorizations

• Bearer

Parameters

Header Parameters

idempotency-key

required

string format: uuid

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request Body ^required

object

orderId

required

Order id

string

reason

required

Reason for Refund.

For orders of Mexico the reason must be one of the follwoing values bellow:

• DUPLICATE
• FRAUDULENT
• REQUESTED_BY_CUSTOMER
• OTHER

string

>= 5 characters <= 100 characters

requestedBy

required

Who requested the refund

object

name

required

Requester name

string

email

required

Requester email

string

Responses

200

The resource was returned successfully

object

id

required

Refund Id

string

orderId

required

Order Id

string

amount

required

Amount to be refunded

string

reason

required

Reason for refund

string

requestedBy

required

Who requested the refund

object

name

required

Requester name

string

email

required

Requester email

string

status

required

Refund status

string

createdAt

required

Refund create datetime

string

endToEndId

required

Refund end to end id

string

400

The request is not valid

Array<string>

401

Unauthorized Request

Array<string>

500

An unexpected error occurred inside the server

Array<string>