Pular para o conteúdo principal

PaymentIntents

Uma lista de intenções de pagamento.

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
    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
  • ]
    • PaymentIntents
    {
      "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"
          }
        }
      ]
    }