POST
/
v1
/
payment-methods
curl --request POST \
  --url https://api.base39.io/v1/payment-methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
  },
  "links": [
    {
      "owner": "cust_62d988ba99646657fd3efce6"
    }
  ],
  "metadata": {}
}'
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

​
base39-external-client-id
string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

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.

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

Body

application/json

Criar um método de pagamento

​
method
enum<string>
required
Available options:
bank_account,
pix_key
​
methodData
object
required

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

​
status
enum<string>

Status do método de pagamento

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

"verification_failed"

​
links
object[]

Vínculo entre uma conta e um cliente ou empresa

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

Response

201 - application/json
Retorna o objeto `PaymentMethod` se a criação for bem-sucedida. Retorna erro para parâmetros inválidos.

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.

​
method
enum<string>
required
Available options:
bank_account,
pix_key
​
methodData
object
required

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

​
id
string

Identificador exclusivo para o objeto.

Example:

"pm_62d988d3946dedfcbe98bb1e"

​
status
enum<string>

Status do método de pagamento

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

"verification_failed"

​
links
object[]

Vínculo entre uma conta e um cliente ou empresa

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

Data de criação do objeto

Example:

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

​
updatedAt
string

Data de alteração do objeto

Example:

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

​
deleted
boolean
default:false

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

Example:

false

​
createdBy
object
​
updatedBy
object