Listar métodos de pagamento

GET 
/v1/payment-methods

Retorna todos os métodos de pagamento, ordenados por data de criação, com os mais recentes primeiro.

Request

Query Parameters

method string

Possible values: [bank_account, pix_key]

Filtrar por método. Pode ser bank_account ou 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.
Example: data.loan
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.
Example: obj_5f92f01728e009f403d8502e
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.
Example: obj_5f92f01728e009f403d8502e
limit integer
Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.
Default value: 10
Example: 10
status any

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

Examples:

single

Valor único

Example: verified

list

Lista

Example: verified,not_verified

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

Responses

200

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.

application/json

Schema

Schema

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

Array [

id string

Identificador exclusivo para o objeto.

Example: pm_62d988d3946dedfcbe98bb1e

status string

Status do método de pagamento

Possible values: [not_verified, verified, validated, verification_failed, errored, void]

Example: verification_failed

method stringrequired

Possible values: [bank_account, pix_key]

methodData

object

required

anyOf

BankAccount

As contas bancárias são formas de receber uma transferência em objetos do tipo Customer ou Company.

accountHolderName stringrequired

O nome da pessoa ou empresa que possui a conta bancária. Este campo é obrigatório ao anexar a conta bancária a um objeto Customer ou Company.

accountHolderType stringrequired

O tipo de entidade que detém a conta. Pode ser pessoa física ou empresa. Este campo é obrigatório ao anexar a conta bancária a um objeto Customer ou Company.

Possible values: [individual, company]

accountHolderDocument stringrequired

O documento da entidade que detém a conta. Pode ser CPF ou CNPJ. Este campo é obrigatório ao anexar a conta bancária a um objeto Customer ou Company.

bankCode stringrequired

Código COMPE da Instituição Financeira.

bankName string

Nome do banco associado.

branch stringrequired

A agência da conta bancária.

number stringrequired

O número da conta bancária. Deve ser uma conta corrente ou conta poupança.

digit stringrequired

accountType stringrequired

Possible values: [current, savings]

createdAt date-time

PixKey

As chaves PIX são formas de receber um PIX em objetos do tipo Customer ou Company.

keyType stringrequired

Possible values: [document, email, phone, random]

keyValue stringrequired

accountHolderName stringrequired

O nome da pessoa ou empresa que possui a conta bancária. Este campo é obrigatório ao anexar a conta bancária a um objeto Customer ou Company.

accountHolderDocument stringrequired

O documento da entidade que detém a conta. Pode ser CPF ou CNPJ. Este campo é obrigatório ao anexar a conta bancária a um objeto Customer ou Company.

accountHolderType stringrequired

O tipo de entidade que detém a conta. Pode ser pessoa física ou empresa. Este campo é obrigatório ao anexar a conta bancária a um objeto Customer ou Company.

Possible values: [individual, company]

createdAt date-time

bankCode string

Número do banco

Example: 104

branch string

O número da agência bancária associada à conta.

Example: 4289

digit string

O dígito verificador da conta.

Example: 8

number string

O número da conta.

Example: 01300005670

accountType string

O tipo de conta

Possible values: [current, savings]

Example: current

exists boolean

Um indicador booleano que informa se existe ou não.

Example: true

bankName string

O nome da instituição financeira

Example: Banco S.A.

valid boolean

Um indicador booleano que informa se é válida ou não.

Example: true

ispb string

O número do Identificador de Sistema de Pagamentos Brasileiro (ISPB) da instituição financeira.

Example: 360305

links

object[]

Array [

owner stringrequired

Cliente proprietário da conta a vincular. Ao realizar um vínculo, é obrigatório enviar ou um cliente, ou uma empresa. Cada instância de um vínculo terá ou um cliente ou uma empresa associado à mesma.

Example: cust_62d988ba99646657fd3efce6

linkedAt date-time

Momento em que o vínculo foi realizado.

]

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 date-time

Data de criação do objeto

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

updatedAt date-time

Data de alteração do objeto

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

deleted boolean

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Default value: false

Example: false

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

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.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

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.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

verifiedAt date-time

]

Example (from schema)

{
  "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": "2024-07-29T15:51:28.071Z"
      },
      "links": [
        {
          "owner": "cust_62d988ba99646657fd3efce6",
          "linkedAt": "2024-07-29T15:51:28.071Z"
        }
      ],
      "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": "2024-07-29T15:51:28.071Z"
    }
  ]
}

Loading...