Estorno de Transação
Esta operação permite que parceiros realizem estorndo de transações previamente autorizadas ou capturadas, garantindo flexibilidade no gerenciamento de pagamentos.
Obs: A palavra urlServidor deve ser substituída pela url do servidor.
O estorno é realizados para transações do tipo crédito.
Parâmetros da Requisição
Headers
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
integration-key | string | Sim | Chave de integração. |
x-token | string | Sim | Token de autenticação. Pode ser encontrado em nosso portal na guia de integração. |
Authorization | Auth Type Bearer Token | Sim | Inserir o Bearer Token, gerado na rota Auth |
id | string | Sim | Id da transação que será estornda |
Exemplo de header da requisição
curl --location 'https://api.sandbox.paytime.com.br/v1/marketplace/transactions/68e3bbfbc780a4948ddb4d50/reversal' \
--header "integration-key: your_integration_key' \
--header 'x-token: your_x-token' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer GeradoNaRotaAuth' \
--data '{
"use_account": true
}'Body
O corpo da requisição deve ser enviado no formato JSON, conforme descrito abaixo:
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
use_account | Boolean | Sim | Indica se será utilizado saldo do estabelecimento como fonte para o estorno da transação, caso ela já tenha sido paga. |
Estrutura do body
{
"use_account": true
}Respostas da API:
| Código | Descrição |
|---|---|
200 | Retorna um objeto contendo detalhes da transação estornada. |
Modelo resposta:
{
"_id": "string",
"status": "CREATED",
"amount": 0,
"original_amount": 0,
"fees": 0,
"type": "CREDIT",
"gateway_authorization": "PAYTIME",
"card": {
"brand_name": "string",
"first4_digits": "string",
"last4_digits": "string",
"expiration_month": "string",
"expiration_year": "string",
"holder_name": "string"
},
"installments": 0,
"customer": {
"first_name": "string",
"last_name": "string",
"document": "string",
"phone": "string",
"email": "string"
},
"point_of_sale": {
"type": "ONLINE",
"identification_type": "CHIP",
"identification_number": "string"
},
"acquirer": {
"name": "string",
"nsu": 0,
"acquirer_nsu": 0,
"end_to_end": "string",
"key": "string",
"gateway_key": "string",
"authorization_number": "string"
},
"expected_on": [
{
"installment": 0,
"date": "2025-03-31T17:33:19.734Z",
"amount": 0,
"status": "PENDING"
}
],
"created_at": "2025-03-31T17:33:19.734Z",
"emv": "string",
"antifraud": [
{
"analyse_required": "THREEDS",
"analyse_status": "APPROVED"
}
],
"payment_response": {
"code": "string",
"message": "string",
"reference": "string",
"authorization_code": "string",
"nsu": "string",
"reason_code": "string"
}
}Regras para o Estorno
Geral:
- Transação não pode ser originada de split;
- Transação não pode ser estornada no dia do recebimento (liquidação);
- Transação só pode ser estornada durante 90 dias após sua efetivação;
- Transação não pode estar em processo de antecipação;
- Limites de estornos pode ser aplicados
Físico:
- Na máquina pode ser realizado no mesmo dia da transação
- Estorno via API, a transação não pode ser estornada no dia em que foi realizada.
Online:
- Bloqueios podem ser aplicados
- Transações feitas via API podem ser estornadas no mesmo dia, desde que não tenham sido liquidadas.
Códigos de Resposta
Consulte a página com os status: Status de respostas
Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.
Updated 4 months ago
Did this page help you?