Listar intenções de pagamento da fatura

GET 
/v1/invoices/:invoice/payment-intents

Retorna todas as intenções de pagamento da fatura, ordenadas por data de criação, com os itens mais recentes primeiro.

Request

Path Parameters

invoice stringrequired
ID da fatura
Example: inv_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
starting_after string
Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.
Example: obj_5f92f01728e009f403d8502e
ending_before string
Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.
Example: obj_5f92f01728e009f403d8502e
limit integer
Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.
Default value: 10
Example: 10
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:

inclusao

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

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

Responses

200

Retorna um objeto com a propriedade data, que é um array de PaymentIntent começando após starting_after. O array estará vazio se não houver mais itens. Nunca retorna erro.

application/json

Schema

Schema

hasMoreboolean
Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.
Example: true

data

object[]

Uma lista de intenções de pagamento.

Array [

idstring

Identificador exclusivo para o objeto.

Example: pi_5f92f01728e009f403d8502e

invoicestring

Identificador que faz referência a uma fatura.

Example: inv_631a1f531a40784a4b0df5ed

statusstring

Possible values: [paid, void, open]

Default value: open

amountdouble

Valor da que deverá ser pago.

paymentDetails

object

paidAtdate

amountPaiddouble

metadataobject

expireAtdate

methodstring

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

Example: boleto

methodData

object

anyOf

boleto

externalIdstring

typestringrequired

Default value: boleto

providerstring

Provedor utilizado para os boletos

Possible values: [kobana, default, test_only]

Example: kobana

descriptionstring

typeableLinestring

urlstring

barcodestring

ourNumberstring

ourNumberRawstring

customerstring

Example: cust_631a2a321a40784a4b0df641

eventsobject[]

offline

typestringrequired

Default value: offline

descriptionstring

paymentMethod

typestringrequired

Default value: paymentMethod

paymentMethodstringrequired

Example: pm_631a2a321a40784a4b0df641

descriptionstring

loan

loanstringrequired

Example: loan_645122117022fa52620deb01

typestringrequired

Default value: loan

descriptionstring

metadataobject

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.

createdAtdate-time

Data de criação do objeto

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

updatedAtdate-time

Data de alteração do objeto

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

createdBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

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.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

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.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

]

Example (from schema)

{
  "hasMore": true,
  "data": [
    {
      "id": "pi_5f92f01728e009f403d8502e",
      "invoice": "inv_631a1f531a40784a4b0df5ed",
      "status": "open",
      "amount": 0,
      "paymentDetails": {
        "paidAt": "2024-07-29",
        "amountPaid": 0,
        "metadata": {}
      },
      "expireAt": "2024-07-29",
      "method": "boleto",
      "methodData": {
        "externalId": "string",
        "type": "boleto",
        "provider": "kobana",
        "description": "string",
        "typeableLine": "string",
        "url": "string",
        "barcode": "string",
        "ourNumber": "string",
        "ourNumberRaw": "string",
        "customer": "cust_631a2a321a40784a4b0df641",
        "events": [
          {}
        ]
      },
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "string",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "string",
        "app": "backoffice"
      }
    }
  ]
}