Cancelar Pagamento

Dados da API

API Gateway
Esta API é utilizada para operações do gateway de pagamento:

• Produção: https://api.sopague.com.br/gateway
• Homologação: https://api-hmg.sopague.com.br/gateway
• Arquitetura: Representational State Transfer (REST)

Introdução

Para cancelar uma venda, utilize o endpoint especificado abaixo fazendo uma requisição do tipo POST. O cancelamento de transações capturadas só pode ser efetuado no mesmo dia em que foram realizadas.

POST /v1/payments/{paymentId}/cancel

Via request Representational State Transfer (REST) com o body:

Requisição

  { 
    "amount": 1035 
  } 

Dicionário de dados - Parâmetros

PROPRIEDADE	DESCRIÇÃO	TIPO	LOCAL	OBRIGATÓRIO	TAMANHO
paymentId	Identificador da transação que será cancelada.	string	path	sim	42
amount	Valor da transação que será cancelada.	integer	body	sim	10

🟢 200

Cancelamento realizado com sucesso

  {
    "returnCode": "0", 
    "description": "Canceled", 
    "paymentId": "020080286103040952150000006201850000000000", 
    "authorizationCode": "143513", 
    "amount": 1023, 
    "releaseAt": "2019-09-24T13:43:12.1952799-03:00"
  }

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
ReturnCode	Código de retorno.	string
Description	Descrição do retorno.	string
PaymentId	Identificador do pagamento.	string
AuthorizationCode	Código de autorização do cancelamento.	string
Amount	Valor do cancelamento (em centavos).	integer
ReleaseAt	Data e hora do registro de cancelamento.	datetime

🔴 400

Erro na requisição

[ 
    { 
        "tag": "__general__", 
        "description": "Transação não localizada, verifique os dados informados."
    } 
] 

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string

🔴 500

Erro interno

[ 
    { 
        "tag": "", 
        "description": "Não foi possível executar comando. Erro desconhecido." 
    } 
]

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string

Observações

• Limitação de cancelamento: Transações capturadas só podem ser canceladas no mesmo dia.