Obter intenção de pagamento

Retorna um objeto PaymentIntent

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

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

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

Show child attributes

expireAt

string

method

enum<string>

Available options:

boleto,

offline,

payment_method,

loan

methodData

object

• boleto
• offline
• paymentMethod
• loan

Show child attributes

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