Skip to main content
GET
/
v1
/
payment-methods
Listar métodos de pagamento
curl --request GET \
  --url https://api.base39.io/v1/payment-methods \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "data": [
    {
      "id": "pm_62d988d3946dedfcbe98bb1e",
      "status": "verification_failed",
      "method": "bank_account",
      "methodData": {
        "accountHolderName": "<string>",
        "accountHolderType": "individual",
        "accountHolderDocument": "<string>",
        "bankCode": "<string>",
        "bankName": "<string>",
        "branch": "<string>",
        "number": "<string>",
        "digit": "<string>",
        "accountType": "current",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "links": [
        {
          "owner": "cust_62d988ba99646657fd3efce6",
          "linkedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "verifiedAt": "2023-11-07T05:31:56Z",
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
method
enum<string>

Filtrar por método. Pode ser bank_account ou pix_key.

Available options:
bank_account,
pix_key
​
owner
string

Um filtro com base no campo owner. O valor deve ser uma string ou uma lista separada por vírgula, que represente um ou um conjunto de ids validos do tipo customer ou company.

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

​
status
string

O status do método de pagamento. O valor deve ser uma string ou uma lista separada por vírgula.

Status do método de pagamento

Example:

"verification_failed"

​
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

Um objeto com uma propriedade data que contém um array de itens começando após o item starting_after. Cada entrada no array é um objeto PaymentMethod separado. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de métodos de pagamento. A parte de uma resposta da API que descreve a paginação

​
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
PaymentMethod · object[]

Uma lista de métodos de pagamento

⌘I