GET
/
v1
/
invoices
/
{invoice}
/
payment-intents
/
{payment_intent}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

payment_intent
string
required

ID da intenção de pagamento

invoice
string
required

ID da fatura

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

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.

Response

200 - application/json
id
string

Identificador exclusivo para o objeto.

invoice
string

Identificador que faz referência a uma fatura.

status
enum<string>
default: open
Available options:
paid,
void,
open
amount
number

Valor da que deverá ser pago.

paymentDetails
object
expireAt
string
method
enum<string>
Available options:
boleto,
offline,
payment_method,
loan
methodData
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
string

Data de criação do objeto

updatedAt
string

Data de alteração do objeto

createdBy
object
updatedBy
object