Pagar intenção de pagamento

POST 
/v1/payment-intents/:payment_intent/pay

Paga uma intenção de pagamento

Request

Path Parameters

payment_intent stringrequired
ID da intenção de pagamento
Example: pi_5f92f01728e009f403d8502e

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.
Example: data.loan
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.

Examples:

inclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

Header Parameters

Idempotency-Key string
Chave única de idempotência para evitar duplicação de requisições.
Example: 5f92f01728e009f403d8502e
base39-external-client-id string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

application/json

Body

amountPaiddoublerequired
Valor pago
Example: 100
paidAtdate
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.

Responses

200

Retorna um objeto PaymentIntent com um parâmetro status: paid em caso de sucesso

application/json

Schema

Schema

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

boleto

externalIdstring

typestringrequired

Default value: boleto

providerstring

Provedor utilizado para os boletos

Possible values: [kobana, default, test_only]

Example: kobana

descriptionstring

typeableLinestring

urlstring

barcodestring

ourNumberstring

ourNumberRawstring

customerstring

Example: cust_631a2a321a40784a4b0df641

eventsobject[]

offline

typestringrequired

Default value: offline

descriptionstring

paymentMethod

typestringrequired

Default value: paymentMethod

paymentMethodstringrequired

Example: pm_631a2a321a40784a4b0df641

descriptionstring

loan

loanstringrequired

Example: loan_645122117022fa52620deb01

typestringrequired

Default value: loan

descriptionstring
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

Example (from schema)

{
  "id": "pi_5f92f01728e009f403d8502e",
  "invoice": "inv_631a1f531a40784a4b0df5ed",
  "status": "open",
  "amount": 0,
  "paymentDetails": {
    "paidAt": "2024-07-29",
    "amountPaid": 0,
    "metadata": {}
  },
  "expireAt": "2024-07-29",
  "method": "boleto",
  "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"
  }
}