PaymentMethods

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.

data.method

enum<string>

required

Available options:

bank_account,

pix_key

data.methodData

object

required

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

data.id

string

Identificador exclusivo para o objeto.

Example:

"pm_62d988d3946dedfcbe98bb1e"

data.status

enum<string>

Status do método de pagamento

Available options:

not_verified,

verified,

validated,

verification_failed,

errored,

void

Example:

"verification_failed"

data.links

object[]

Vínculo entre uma conta e um cliente ou empresa

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

data.createdAt

string

Data de criação do objeto

Example:

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

data.updatedAt

string

Data de alteração do objeto

Example:

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

data.deleted

boolean

default:false

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

Example:

false

data.createdBy

object

data.updatedBy

object

data.verifiedAt

string

PaymentMethod Product

{
  "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"
    }
  ]
}

Empréstimos

Empresas

Clientes

Fundos

Eventos

Cobrança

Arquivos

Configurações

Entidades

Automações

Modelos

PaymentMethods