Atualiza pagamento

PATCH /payments/{id}

Atualiza um pagamento existente através do ID

Parâmetros

idstringobrigatório

ID do pagamento previamente enviado ou gerado na criação.

Corpo da requisição

paymentobjectobrigatório
payment object
statusstring enumobrigatório

Status final do pagamento. Consulte a documentação para mais detalhes sobre os status possíveis.

Allowed: succeeded declined failed blocked
methodobject

Método de pagamento. Utilizar este parâmetro apenas quando for necessário complementar dados que não puderam ser transmitidos na criação.

method object
typestring enum

Tipo do método de pagamento.

Allowed: credit_card debit_card
cardobject
card object
networkstring enumobrigatório

Bandeira

Allowed: visa mastercard american_express diners_club elo hipercard jcb discover other
presencestring enumobrigatório

Indica se a transação foi realizada com cartão presente (CP) ou cartão não presente (CNP). Consulte a documentação sobre presença de cartões para mais informações.

Allowed: card_present card_not_present
binstring \| null

Primeiros 8 números do PAN que identificam o emissor do cartão (conhecido também como IIN)

last_fourstring \| null

Últimos 4 números do PAN

transactionsarray

Lista com as tentativas de transação para este pagamento. Obrigatório se o `status` do pagamento for `succeeded` ou `declined`. Recomendável para `failed` e `blocked` se houverem tentativas de transação.

transactions[] item
idstring

Código identificador único da transação. Consulte a documentação para mais detalhes sobre o código da transação.

statusstring enumobrigatório

Status de retorno da tentativa de transação. Consulte a documentação para mais detalhes sobre os status possíveis.

Allowed: succeeded declined failed
durationinteger

Tempo de execução da transação em milissegundos (1 segundo = 1000 milissegundos).

timestampdate-time \| null

Data e hora em que a transação foi iniciada no formato ISO 8601. Se não for enviado, o horário atual será usado. O prazo máximo para envio retroativo (backfill) é 24 horas. Horários no futuro não são permitidos.

connectorobjectobrigatório

Informações sobre o conector de pagamento utilizado na transação. O conector pode ser uma adquirente, um subadquirente ou um gateway.

connector object
idstringobrigatório

Código da integração com o conector. Informe um código que represente um contrato de filiação ou uma conexão de integração específica. Recomendamos prefixar o código com o tipo do conector para facilitar consultas em relatórios.

typestringobrigatório

Tipo do conector. Consulte a documentação para obter a lista completa.

response_codestring \| null

Código de resposta alfanumérico da tentativa. Para cartão de crédito no Brasil, utilizar preferencialmente o padrão determinado pela normativa 21 da ABECS. Obrigatório se `transaction.status` for `succeeded` ou `declined`. Recomendável para `failed` quando presente.

Respostas

200Pagamento atualizado com sucesso
401Credenciais de acesso inválidas
Response body
errorsarray
errors[] item
fieldstring

Campo da requisição onde ocorreu o erro

typestring

Código do tipo do erro

messagestring

Mensagem do erro

422Parâmetros inválidos
Response body
errorsarray
errors[] item
fieldstring

Campo da requisição onde ocorreu o erro

typestring

Código do tipo do erro

messagestring

Mensagem do erro

404Objeto não encontrado
Response body
errorsarray
errors[] item
fieldstring

Campo da requisição onde ocorreu o erro

typestring

Código do tipo do erro

messagestring

Mensagem do erro

{
  "payment": {
    "status": "succeeded",
    "method": {
      "type": "credit_card",
      "card": {
        "network": null,
        "presence": null,
        "bin": null,
        "last_four": null
      }
    },
    "transactions": [
      {
        "id": null,
        "status": null,
        "duration": null,
        "timestamp": null,
        "connector": null
      }
    ]
  }
}