Pular para o conteúdo principal

Anular intenção de pagamento

POST 
/v1/payment-intents/:payment_intent/void

Anula uma intenção de pagamento

Request​

Path Parameters

    payment_intent stringrequired

    ID da intenção de pagamento

    Example: pi_5f92f01728e009f403d8502e

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.

    Example: data.loan
    fields string

    Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

    Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

    Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

    Examples:

    Retorna apenas os campos `id` e `createdAt`.

    Example: id,createdAt

Header Parameters

    Idempotency-Key string

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

    Example: 5f92f01728e009f403d8502e
    base39-external-client-id string

    Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

Responses​

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

Schema

    id string

    Identificador exclusivo para o objeto.

    Example: pi_5f92f01728e009f403d8502e
    invoice string

    Identificador que faz referência a uma fatura.

    Example: inv_631a1f531a40784a4b0df5ed
    status string

    Possible values: [paid, void, open]

    Default value: open
    amount double

    Valor da que deverá ser pago.

    paymentDetails

    object

    paidAt date
    amountPaid double
    metadata object
    expireAt date
    method string

    Possible values: [pix, boleto, offline, payment_method, loan]

    Example: boleto

    methodData

    object

    anyOf

    externalId string
    type stringrequired
    Default value: boleto
    provider string

    Provedor utilizado para os boletos

    Possible values: [kobana, default, test_only]

    Example: kobana
    description string
    typeableLine string
    url string
    barcode string
    ourNumber string
    ourNumberRaw string
    customer string
    Example: cust_631a2a321a40784a4b0df641
    events object[]
    metadata object

    Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

    createdAt date-time

    Data de criação do objeto

    Example: 2023-08-25T22:38:41.134Z
    updatedAt date-time

    Data de alteração do objeto

    Example: 2023-08-25T22:38:41.134Z

    createdBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice

    updatedBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice
Loading...