# Estorno total (sem informar valor)
curl -X POST 'https://app.plowf.com/api/v1/payments/770e8400-e29b-41d4-a716-446655440000/refund' \
-H 'Authorization: Bearer seu_token_aqui' \
-H 'Content-Type: application/json'
# Estorno parcial (informando valor)
curl -X POST 'https://app.plowf.com/api/v1/payments/770e8400-e29b-41d4-a716-446655440000/refund' \
-H 'Authorization: Bearer seu_token_aqui' \
-H 'Content-Type: application/json' \
-d '{
"value": 100.00
}'
{
"message": "Reembolso iniciado",
"data": {
"uuid": "770e8400-e29b-41d4-a716-446655440000",
"status": "PROCESSING",
"value": 247.99,
"fees": 0.5,
"refund": {
"status": "PROCESSING",
"value": 247.99,
"fees": 0.5,
"pix_original": {
"uuid": "880e8400-e29b-41d4-a716-446655440001",
"initiation": {
"sender": {
"name": "João Silva",
"document": "12345678901",
"account_number": "00123456",
"account_agency": "0001",
"bank": {
"code": "341",
"name": "ITAÚ UNIBANCO S.A.",
"ispb": "60701190"
},
"account_type": "CHECKING"
},
"receiver": {
"name": "Empresa Demo LTDA",
"document": "12345678000190",
"account_number": "9876543",
"account_agency": "0001",
"bank": {
"code": "",
"name": "PLOWF IP LTDA.",
"ispb": "00000000"
},
"account_type": "CHECKING"
},
"txid": "770e8400e29b41d4a716446655440000",
"value": "247.99",
"type": "QR_DYNAMIC",
"pix_key": "550e8400-e29b-41d4-a716-446655440000",
"additional_info": [
{
"name": "ID do pagamento",
"value": "990e8400-e29b-41d4-a716-446655440002"
}
],
"status": "COMPLETED",
"expires_at": "2024-01-02T10:00:00.000000Z",
"created_at": "2024-01-01T10:00:00.000000Z",
"updated_at": "2024-01-01T10:05:00.000000Z"
},
"value": "247.99",
"movement_type": "IN",
"type": "EXTERNAL_TRANSFER",
"status": "SETTLED",
"end_to_end": "E6070119020240101100500000000001",
"settled_at": "2024-01-01T10:05:00.000000Z",
"created_at": "2024-01-01T10:05:00.000000Z",
"updated_at": "2024-01-01T10:05:00.000000Z"
},
"pix_refund": {
"uuid": "990e8400-e29b-41d4-a716-446655440002",
"initiation": {
"sender": {
"name": "Empresa Demo LTDA",
"document": "12345678000190",
"account_number": "9876543",
"account_agency": "0001",
"bank": {
"code": "",
"name": "PLOWF IP LTDA.",
"ispb": "00000000"
},
"account_type": "CHECKING"
},
"receiver": {
"name": "João Silva",
"document": "12345678901",
"account_number": "00123456",
"account_agency": "0001",
"bank": {
"code": "341",
"name": "ITAÚ UNIBANCO S.A.",
"ispb": "60701190"
},
"account_type": "CHECKING"
},
"txid": null,
"value": 247.99,
"type": "REFUND",
"status": "COMPLETED",
"expires_at": null,
"created_at": "2024-01-02T10:00:00.000000Z",
"updated_at": "2024-01-02T10:00:00.000000Z"
},
"value": 247.99,
"movement_type": "OUT",
"type": "EXTERNAL_REFUND",
"status": "PENDING",
"end_to_end": "D0000000020240102100000000000001",
"settled_at": null,
"created_at": "2024-01-02T10:00:00.000000Z",
"updated_at": "2024-01-02T10:00:00.000000Z"
},
"created_at": "2024-01-02T10:00:00.000000Z",
"updated_at": "2024-01-02T10:00:00.000000Z"
},
"history": [
{
"status": "PENDING",
"created_at": "2024-01-01T10:00:00Z"
},
{
"status": "PAID",
"created_at": "2024-01-01T10:05:00Z"
}
],
"created_at": "2024-01-02T10:00:00.000000Z",
"updated_at": "2024-01-02T10:00:00.000000Z"
}
}
Cobranças (PIX In)
Estornar Cobrança
POST
/
api
/
v1
/
payments
/
{paymentUuid}
/
refund
# Estorno total (sem informar valor)
curl -X POST 'https://app.plowf.com/api/v1/payments/770e8400-e29b-41d4-a716-446655440000/refund' \
-H 'Authorization: Bearer seu_token_aqui' \
-H 'Content-Type: application/json'
# Estorno parcial (informando valor)
curl -X POST 'https://app.plowf.com/api/v1/payments/770e8400-e29b-41d4-a716-446655440000/refund' \
-H 'Authorization: Bearer seu_token_aqui' \
-H 'Content-Type: application/json' \
-d '{
"value": 100.00
}'
{
"message": "Reembolso iniciado",
"data": {
"uuid": "770e8400-e29b-41d4-a716-446655440000",
"status": "PROCESSING",
"value": 247.99,
"fees": 0.5,
"refund": {
"status": "PROCESSING",
"value": 247.99,
"fees": 0.5,
"pix_original": {
"uuid": "880e8400-e29b-41d4-a716-446655440001",
"initiation": {
"sender": {
"name": "João Silva",
"document": "12345678901",
"account_number": "00123456",
"account_agency": "0001",
"bank": {
"code": "341",
"name": "ITAÚ UNIBANCO S.A.",
"ispb": "60701190"
},
"account_type": "CHECKING"
},
"receiver": {
"name": "Empresa Demo LTDA",
"document": "12345678000190",
"account_number": "9876543",
"account_agency": "0001",
"bank": {
"code": "",
"name": "PLOWF IP LTDA.",
"ispb": "00000000"
},
"account_type": "CHECKING"
},
"txid": "770e8400e29b41d4a716446655440000",
"value": "247.99",
"type": "QR_DYNAMIC",
"pix_key": "550e8400-e29b-41d4-a716-446655440000",
"additional_info": [
{
"name": "ID do pagamento",
"value": "990e8400-e29b-41d4-a716-446655440002"
}
],
"status": "COMPLETED",
"expires_at": "2024-01-02T10:00:00.000000Z",
"created_at": "2024-01-01T10:00:00.000000Z",
"updated_at": "2024-01-01T10:05:00.000000Z"
},
"value": "247.99",
"movement_type": "IN",
"type": "EXTERNAL_TRANSFER",
"status": "SETTLED",
"end_to_end": "E6070119020240101100500000000001",
"settled_at": "2024-01-01T10:05:00.000000Z",
"created_at": "2024-01-01T10:05:00.000000Z",
"updated_at": "2024-01-01T10:05:00.000000Z"
},
"pix_refund": {
"uuid": "990e8400-e29b-41d4-a716-446655440002",
"initiation": {
"sender": {
"name": "Empresa Demo LTDA",
"document": "12345678000190",
"account_number": "9876543",
"account_agency": "0001",
"bank": {
"code": "",
"name": "PLOWF IP LTDA.",
"ispb": "00000000"
},
"account_type": "CHECKING"
},
"receiver": {
"name": "João Silva",
"document": "12345678901",
"account_number": "00123456",
"account_agency": "0001",
"bank": {
"code": "341",
"name": "ITAÚ UNIBANCO S.A.",
"ispb": "60701190"
},
"account_type": "CHECKING"
},
"txid": null,
"value": 247.99,
"type": "REFUND",
"status": "COMPLETED",
"expires_at": null,
"created_at": "2024-01-02T10:00:00.000000Z",
"updated_at": "2024-01-02T10:00:00.000000Z"
},
"value": 247.99,
"movement_type": "OUT",
"type": "EXTERNAL_REFUND",
"status": "PENDING",
"end_to_end": "D0000000020240102100000000000001",
"settled_at": null,
"created_at": "2024-01-02T10:00:00.000000Z",
"updated_at": "2024-01-02T10:00:00.000000Z"
},
"created_at": "2024-01-02T10:00:00.000000Z",
"updated_at": "2024-01-02T10:00:00.000000Z"
},
"history": [
{
"status": "PENDING",
"created_at": "2024-01-01T10:00:00Z"
},
{
"status": "PAID",
"created_at": "2024-01-01T10:05:00Z"
}
],
"created_at": "2024-01-02T10:00:00.000000Z",
"updated_at": "2024-01-02T10:00:00.000000Z"
}
}
Estorna uma cobrança (total ou parcial). Se o valor não for informado, estorna o valor total da cobrança.
# Estorno total (sem informar valor)
curl -X POST 'https://app.plowf.com/api/v1/payments/770e8400-e29b-41d4-a716-446655440000/refund' \
-H 'Authorization: Bearer seu_token_aqui' \
-H 'Content-Type: application/json'
# Estorno parcial (informando valor)
curl -X POST 'https://app.plowf.com/api/v1/payments/770e8400-e29b-41d4-a716-446655440000/refund' \
-H 'Authorization: Bearer seu_token_aqui' \
-H 'Content-Type: application/json' \
-d '{
"value": 100.00
}'
Path Parameters
UUID da cobrança a ser estornado
Body Parameters
Valor a ser estornado. Se não informado, estorna o valor total da cobrança. Deve ser entre 0 e o
total_value da cobrança.Validações
- Se
valuenão for enviado, estorna o valor total da cobrança - Se
valuefor enviado, deve ser entre 0 e ototal_valueda cobrança - O cobrança deve estar em um status que permita estorno (geralmente
PAID)
Resposta de Sucesso
{
"message": "Reembolso iniciado",
"data": {
"uuid": "770e8400-e29b-41d4-a716-446655440000",
"status": "PROCESSING",
"value": 247.99,
"fees": 0.5,
"refund": {
"status": "PROCESSING",
"value": 247.99,
"fees": 0.5,
"pix_original": {
"uuid": "880e8400-e29b-41d4-a716-446655440001",
"initiation": {
"sender": {
"name": "João Silva",
"document": "12345678901",
"account_number": "00123456",
"account_agency": "0001",
"bank": {
"code": "341",
"name": "ITAÚ UNIBANCO S.A.",
"ispb": "60701190"
},
"account_type": "CHECKING"
},
"receiver": {
"name": "Empresa Demo LTDA",
"document": "12345678000190",
"account_number": "9876543",
"account_agency": "0001",
"bank": {
"code": "",
"name": "PLOWF IP LTDA.",
"ispb": "00000000"
},
"account_type": "CHECKING"
},
"txid": "770e8400e29b41d4a716446655440000",
"value": "247.99",
"type": "QR_DYNAMIC",
"pix_key": "550e8400-e29b-41d4-a716-446655440000",
"additional_info": [
{
"name": "ID do pagamento",
"value": "990e8400-e29b-41d4-a716-446655440002"
}
],
"status": "COMPLETED",
"expires_at": "2024-01-02T10:00:00.000000Z",
"created_at": "2024-01-01T10:00:00.000000Z",
"updated_at": "2024-01-01T10:05:00.000000Z"
},
"value": "247.99",
"movement_type": "IN",
"type": "EXTERNAL_TRANSFER",
"status": "SETTLED",
"end_to_end": "E6070119020240101100500000000001",
"settled_at": "2024-01-01T10:05:00.000000Z",
"created_at": "2024-01-01T10:05:00.000000Z",
"updated_at": "2024-01-01T10:05:00.000000Z"
},
"pix_refund": {
"uuid": "990e8400-e29b-41d4-a716-446655440002",
"initiation": {
"sender": {
"name": "Empresa Demo LTDA",
"document": "12345678000190",
"account_number": "9876543",
"account_agency": "0001",
"bank": {
"code": "",
"name": "PLOWF IP LTDA.",
"ispb": "00000000"
},
"account_type": "CHECKING"
},
"receiver": {
"name": "João Silva",
"document": "12345678901",
"account_number": "00123456",
"account_agency": "0001",
"bank": {
"code": "341",
"name": "ITAÚ UNIBANCO S.A.",
"ispb": "60701190"
},
"account_type": "CHECKING"
},
"txid": null,
"value": 247.99,
"type": "REFUND",
"status": "COMPLETED",
"expires_at": null,
"created_at": "2024-01-02T10:00:00.000000Z",
"updated_at": "2024-01-02T10:00:00.000000Z"
},
"value": 247.99,
"movement_type": "OUT",
"type": "EXTERNAL_REFUND",
"status": "PENDING",
"end_to_end": "D0000000020240102100000000000001",
"settled_at": null,
"created_at": "2024-01-02T10:00:00.000000Z",
"updated_at": "2024-01-02T10:00:00.000000Z"
},
"created_at": "2024-01-02T10:00:00.000000Z",
"updated_at": "2024-01-02T10:00:00.000000Z"
},
"history": [
{
"status": "PENDING",
"created_at": "2024-01-01T10:00:00Z"
},
{
"status": "PAID",
"created_at": "2024-01-01T10:05:00Z"
}
],
"created_at": "2024-01-02T10:00:00.000000Z",
"updated_at": "2024-01-02T10:00:00.000000Z"
}
}
Dados do estorno realizado
Show atributos
Show atributos
UUID do estorno realizado
Status do estorno (PENDING, PROCESSING, SUCCESS, FAILED)
Valor estornado
Taxas aplicadas
Data e hora de criação da cobrança original
Data e hora da última atualização (após o estorno)
Erros Comuns
Após um estorno parcial, o status da cobrança será
PARTIALLY_REFUNDED. Após um estorno total, o status será REFUNDED.⌘I