GET
/
v1
/
payment-intents
curl --request GET \
  --url https://api.base39.io/v1/payment-intents \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "data": [
    {
      "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.

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.

​
starting_after
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

​
ending_before
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

​
limit
integer
default:10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

​
invoice
string

ID da fatura. O valor deve ser uma string ou uma lista separada por vírgula.

​
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.

​
paid_at_start
string

Um filtro com base no campo paidAt. O valor deve ser uma data.

​
paid_at_end
string

Um filtro com base no campo paidAt. O valor deve ser uma data.

​
status
enum<string>

O status da intenção de pagamento. O valor deve ser uma string ou uma lista separada por vírgula.

Available options:
open,
paid,
void
Example:

"open"

Response

200 - application/json
Um objeto com a propriedade `data` contendo um array de `PaymentIntent` após o `starting_after`. Se não houver mais itens, o array estará vazio. Nunca retorna um erro.

Uma lista de intenções de pagamento.

​
hasMore
boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

​
data
object[]

Uma lista de intenções de pagamento.

Representa uma intenção de pagamento.