POST
/
v1
/
payment-intents
/
{payment_intent}
/
void
Anular intenção de pagamento
curl --request POST \
  --url https://api.base39.io/v1/payment-intents/{payment_intent}/void \
  --header 'Authorization: Bearer <token>'
{
  "id": "pi_5f92f01728e009f403d8502e",
  "invoice": "inv_631a1f531a40784a4b0df5ed",
  "status": "open",
  "amount": 123,
  "paymentDetails": {
    "paidAt": "2023-12-25",
    "amountPaid": 123,
    "metadata": {}
  },
  "expireAt": "2023-12-25",
  "method": "boleto",
  "methodData": {
    "externalId": "<string>",
    "type": "boleto",
    "provider": "kobana",
    "description": "<string>",
    "typeableLine": "<string>",
    "url": "<string>",
    "barcode": "<string>",
    "ourNumber": "<string>",
    "customer": "cust_631a2a321a40784a4b0df641",
    "events": [
      {}
    ]
  },
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

Path Parameters

​
payment_intent
string
required

ID da intenção de pagamento

Query Parameters

​
expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

​
fields
string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Response

200 - application/json

Retorna um objeto PaymentIntent com um parâmetro status: void em caso de sucesso.

Representa uma intenção de pagamento.