Generate new complete refund
POST/api/transaction/generate_refund
Generates a new complete refund when the transaction does not have any orders.
Request
- application/json
Body
required
description description (string)required
Description of the return
merchant_id merchant_id (string)required
Reference of the store that solicitate the return
transaction_uuid transaction_uuid (string)required
Reference of the transaction that should be returned
client_document client_document (string)required
Client's document (CPF or CNPJ)
Responses
- 201
- 400
- 401
- 403
- 408
- 500
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
code code (integer)
Possible values: [201
, 422
, 404
, 408
, 500
]
Response code
status status (string)
Possible values: [pending
, failed
]
Transaction status
message message (string)
Message about the request
transaction_uuid transaction_uuid (string)
Reference of the transaction that should be returned
merchant_id merchant_id (string)
Reference of the store that solicitate the return
{
"code": "201",
"status": "pending",
"message": "Refund transaction created successfully",
"transaction_uuid": "c808c55d-0110-4070-97ef-4459d9e2c595",
"merchant_id": "7da0c9af-215e-4625-b484-b8cfc87aaa09"
}
Bad Request
Unauthenticated
- application/json
- Schema
- Example (from schema)
Schema
message message (integer)
Response 401
{
"message": "Invalid x-api-key"
}
Forbidden
Request timeout
Error
Loading...