POST
/
v1
/
payment-intents

Authorizations

Authorization
string
headerrequired

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

Headers

Idempotency-Key
string

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

Query Parameters

invoice
string
required

ID da fatura

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[]

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.

Body

application/json

Criar uma intenção de pagamento

amount
number
required

Valor da que deverá ser pago.

expireAt
string
required
method
enum<string>
required
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.

Response

201 - application/json

Representa uma intenção de pagamento.

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

Listar intenções de pagamentoAnular intenção de pagamento