Skip to main content
POST
Habilita pagamentos por PIX (inicia o onboarding)

Authorizations

Authorization
string
header
required

Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....

Body

application/json
name
string
required

Razão social ou nome completo.

Minimum string length: 1
email
string<email>
required

E-mail de contato/notificações.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
cpfCnpj
string
required

CPF ou CNPJ (somente números).

Pattern: ^\d{11}$|^\d{14}$
mobilePhone
string
required

Celular.

Minimum string length: 1
incomeValueCents
integer
required

Faturamento/renda mensal, em centavos (inteiro).

Required range: x <= 9007199254740991
address
string
required

Logradouro.

Minimum string length: 1
addressNumber
string
required

Número.

Minimum string length: 1
province
string
required

Bairro.

Minimum string length: 1
postalCode
string
required

CEP (somente números).

Pattern: ^\d{8}$
companyType
enum<string>

Tipo de pessoa/empresa (Asaas).

Available options:
MEI,
LIMITED,
INDIVIDUAL,
ASSOCIATION
birthDate
string

Data de nascimento (YYYY-MM-DD), pessoa física.

Pattern: ^\d{4}-\d{2}-\d{2}$
phone
string

Telefone fixo.

site
string<uri>

Site.

complement
string

Complemento.

Response

201 - application/json

Default Response

id
string
required

Identificador da habilitação (prefixo pmac_).

organizationId
string
required
status
enum<string>
required

Status interno da habilitação de pagamentos por PIX. requested: na fila de liberação (waitlist). provisioning: em criação. documents_pending: aguardando envio de documentos. under_review: em análise. approved: apto a transacionar. rejected/suspended: bloqueado.

Available options:
requested,
provisioning,
documents_pending,
under_review,
approved,
rejected,
suspended
readiness
boolean
required

true quando a habilitação está aprovada (apta a pagar por PIX).

waitlisted
boolean
required

true quando ainda está na fila de liberação gradual.

generalStatus
enum<string> | null
required

Status cru de um eixo/documento no Asaas.

Available options:
NOT_SENT,
PENDING,
AWAITING_APPROVAL,
APPROVED,
REJECTED
commercialInfoStatus
enum<string> | null
required

Status cru de um eixo/documento no Asaas.

Available options:
NOT_SENT,
PENDING,
AWAITING_APPROVAL,
APPROVED,
REJECTED
bankAccountInfoStatus
enum<string> | null
required

Status cru de um eixo/documento no Asaas.

Available options:
NOT_SENT,
PENDING,
AWAITING_APPROVAL,
APPROVED,
REJECTED
documentationStatus
enum<string> | null
required

Status cru de um eixo/documento no Asaas.

Available options:
NOT_SENT,
PENDING,
AWAITING_APPROVAL,
APPROVED,
REJECTED
pixStatus
enum<string> | null
required

Status cru de um eixo/documento no Asaas.

Available options:
NOT_SENT,
PENDING,
AWAITING_APPROVAL,
APPROVED,
REJECTED
statusReason
string | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required