Skip to main content
POST
/
api
/
signup
Criar nova conta (sandbox ou produção)
curl --request POST \
  --url https://sandbox.ntxpay.com/api/signup \
  --header 'Content-Type: application/json' \
  --data '
{
  "holderName": "Maria Lopez",
  "holderTaxIdPrimary": "LOMA850101ABC",
  "holderTaxIdPrimaryType": "RFC",
  "accountType": "PF",
  "email": "maria@example.com",
  "phone": "+5215512345678",
  "isSandbox": false
}
'
{
  "accountId": 93,
  "publicId": "acc_550e8400-e29b-41d4-a716-446655440000",
  "credentials": {
    "clientId": "qr-93-550e8400",
    "clientSecret": "a1b2c3d4e5f6g7h8"
  },
  "certificate": {
    "fingerprint": "sha256:abcd1234...",
    "expiresAt": "2027-05-13T00:00:00.000Z"
  },
  "message": "Conta criada com sucesso. Guarde clientSecret em local seguro."
}

Body

application/json
​
holderName
string
required

Nome do titular

Required string length: 3 - 255
Example:

"Maria Lopez"

​
holderTaxIdPrimary
string
required

RFC (PF/PJ) ou CURP (PF)

Required string length: 10 - 20
Example:

"LOMA850101ABC"

​
holderTaxIdPrimaryType
enum<string>
required
Available options:
RFC,
CURP
Example:

"RFC"

​
accountType
enum<string>
required

PJ = empresa, PF = pessoa física

Available options:
PJ,
PF
Example:

"PF"

​
email
string<email>

Email de contato

Example:

"maria@example.com"

​
phone
string

Telefone E.164

Required string length: 8 - 20
Example:

"+5215512345678"

​
isSandbox
boolean
default:false

Se true, cria conta em sandbox (mainProvider=sandbox). Default false.

Response

Conta criada com sucesso

​
accountId
integer
Example:

93

​
publicId
string
Example:

"acc_550e8400-e29b-41d4-a716-446655440000"

​
mainProvider
enum<string>
Available options:
smartfastpay,
sandbox
​
credentials
object
​
certificate
object

Certificado mTLS, quando emitido

​
message
string
Example:

"Conta criada com sucesso. Guarde clientSecret em local seguro."