Listar intenções de pagamento

Retorna todas as intenções de pagamento.

Os itens são retornados e ordenados por data de criação, com os itens mais recentes primeiro.

Authorizations

Authorization

string

header

required

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

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.

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.

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.

limit

integer

default:10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

invoice

string

ID da fatura

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

Um objeto com uma propriedade `data` que contém um array de itens começando após o item `starting_after`. Cada entrada no array é um objeto `PaymentIntent` separado. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de intenções de pagamento.

hasMore

boolean

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.

Representa uma intenção de pagamento.

Show child attributes

data.id

string

Identificador exclusivo para o objeto.

Example:

"pi_5f92f01728e009f403d8502e"

data.invoice

string

Identificador que faz referência a uma fatura.

Example:

"inv_631a1f531a40784a4b0df5ed"

data.status

enum<string>

default:open

Available options:

paid,

void,

open

data.amount

number

Valor da que deverá ser pago.

data.paymentDetails

object

Show child attributes

data.paymentDetails.paidAt

string

data.paymentDetails.amountPaid

number

data.paymentDetails.metadata

object

data.expireAt

string

data.method

enum<string>

Available options:

boleto,

offline,

payment_method,

loan

Example:

"boleto"

data.methodData

object

• boleto
• offline
• paymentMethod
• loan

Show child attributes

data.methodData.type

string

default:boleto

required

data.methodData.provider

string

default:kobana

required

data.methodData.externalId

string

data.methodData.description

string

data.methodData.typeableLine

string

data.methodData.url

string

data.methodData.barcode

string

data.methodData.ourNumber

string

data.methodData.customer

string

Example:

"cust_631a2a321a40784a4b0df641"

data.methodData.events

object[]

data.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.

data.createdAt

string

Data de criação do objeto

Example:

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

data.updatedAt

string

Data de alteração do objeto

Example:

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