GET
/
v1
/
payment-methods
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"
        }
      ],
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false,
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      },
      "verifiedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

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

Filtro baseado no campo owner. Aceita uma string ou lista de IDs válidos de 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
enum<string>

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

Available options:
not_verified,
verified,
validated,
verification_failed,
errored,
void
Example:

"verification_failed"

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

Response

200 - application/json
Um objeto com a propriedade `data` e um array de `PaymentMethod` após `starting_after`. Se não houver mais itens, o array será vazio. Esta solicitação nunca retorna erro.

Uma lista de métodos 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 métodos de pagamento

Este objeto representa uma método de pagamento. Ele permite que você crie vínculos empregatícios e rastreie contratos que pertencem a mesma empresa.