POST
/
v1
/
payment-methods
/
{id}
/
void
Anular método de pagamento
curl --request POST \
  --url https://api.base39.io/v1/payment-methods/{id}/void \
  --header 'Authorization: Bearer <token>'
{
  "id": "pm_62d988d3946dedfcbe98bb1e",
  "status": "verification_failed",
  "method": "bank_account",
  "methodData": {
    "accountHolderName": "<string>",
    "accountHolderType": "individual",
    "accountHolderDocument": "<string>",
    "bankCode": "<string>",
    "bankName": "<string>",
    "branch": "<string>",
    "number": "<string>",
    "digit": "<string>",
    "accountType": "current",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "links": [
    {
      "owner": "cust_62d988ba99646657fd3efce6",
      "linkedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "verifiedAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false
}

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

​
id
string
required
  • O ID do object

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 o objeto PaymentMethod para um ID válido.

Este objeto representa uma método de pagamento. Ele permite que você crie vínculos empregatícios e rastreie contratos que pertencem a mesma empresa.