Refund an order - V1
Deprecated
PUT /order/v1/refund
PUT
/order/v1/refund
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
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “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
Section titled “Request Body required ”object
orderId
required
Order id
string
Example
60bd66c4-9a50-4f0c-8d49-35a849d59539 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
Example
Customer requested or order was not delivered requestedBy
required
Who requested the refund
object
name
required
Requester name
string
Example
Jhon Doe email
required
Example
{ "name": "Jhon Doe",}Responses
Section titled “ Responses ”The resource was returned successfully
object
id
required
Refund Id
string
Example
5c39e312-4de7-40a1-a8e0-165fa4f5f3f3 orderId
required
Order Id
string
Example
7d418d7d-b926-42a3-b6e2-864f76020fc6 amount
required
Amount to be refunded
string
Example
100 reason
required
Reason for refund
string
Example
Customer requested or order was not delivered requestedBy
required
Who requested the refund
object
name
required
Requester name
string
Example
Jhon Doe email
required
Example
status
required
Refund status
string
Example
INITIAL createdAt
required
Refund create datetime
string
Example
2021-01-01T00:00:00.000Z endToEndId
required
Refund end to end id
string
The request is not valid
Array<string>
Unauthorized Request
Array<string>
An unexpected error occurred inside the server
Array<string>