POST
/
v1
/
payment-intents
curl --request POST \
  --url https://api.base39.io/v1/payment-intents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 123,
  "expireAt": "2023-12-25",
  "method": "boleto",
  "methodData": {
    "type": "boleto",
    "provider": "kobana",
    "description": "<string>",
    "customer": "cust_631a2a321a40784a4b0df641",
    "events": [
      {}
    ]
  },
  "metadata": {}
}'
{
  "id": "pi_5f92f01728e009f403d8502e",
  "invoice": "inv_631a1f531a40784a4b0df5ed",
  "status": "open",
  "amount": 123,
  "paymentDetails": {
    "paidAt": "2023-12-25",
    "amountPaid": 123,
    "metadata": {}
  },
  "expireAt": "2023-12-25",
  "method": "boleto",
  "methodData": {
    "externalId": "<string>",
    "type": "boleto",
    "provider": "kobana",
    "description": "<string>",
    "typeableLine": "<string>",
    "url": "<string>",
    "barcode": "<string>",
    "ourNumber": "<string>",
    "ourNumberRaw": "<string>",
    "customer": "cust_631a2a321a40784a4b0df641",
    "events": [
      {}
    ]
  },
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

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.

​
base39-external-client-id
string

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

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

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.

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:
pix,
boleto,
offline,
payment_method,
loan
Example:

"boleto"

​
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
Retorna o objeto `PaymentIntent` se a criação for bem-sucedida. Retorna um erro para parâmetros inválidos, como fatura inválida.

Representa uma intenção de pagamento.

​
id
string

Identificador exclusivo para o objeto.

Example:

"pi_5f92f01728e009f403d8502e"

​
invoice
string

Identificador que faz referência a uma fatura.

Example:

"inv_631a1f531a40784a4b0df5ed"

​
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:
pix,
boleto,
offline,
payment_method,
loan
Example:

"boleto"

​
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

Example:

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

​
updatedAt
string

Data de alteração do objeto

Example:

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

​
createdBy
object
​
updatedBy
object