ArticoPay Payment API

Documentacao da API

Integre cobrancas, pagamentos Pix Out e webhooks em uma unica API. Esta documentacao segue o fluxo recomendado: autenticar, criar transacoes, consultar status e receber eventos.

Autenticacao

Envie token e secret no corpo JSON de cada endpoint protegido. Nunca exponha o secret no frontend.

token	string required	Token publico da integracao.
secret	string required	Chave secreta da integracao.

Base URL

BASEhttps://articopay.com/api

Metodos de Pagamento

Pix esta disponivel para integracao publica. Boleto e cartao dependem da adquirente configurada e da liberacao tecnica.

DisponivelPixQR Code e copia e cola.method_pay: "pix"

Sob configuracaoBoletoDepende da adquirente.method_pay: "billet"

Sob configuracaoCartaoDepende de tokenizacao.method_pay: "card"

Auth Required

Criar transacao Pix

Cria uma nova transacao Pix e retorna QR Code para pagamento.

POSThttps://articopay.com/api/wallet/deposit/payment

Auth Required

Criar transacao Boleto

Use o mesmo endpoint de entrada com method_pay: "billet". Disponibilidade depende da adquirente.

Auth Required

Criar transacao Cartao

Use o mesmo endpoint de entrada com method_pay: "card". Disponibilidade depende da adquirente e tokenizacao.

Body da cobranca

No fluxo Pix simplificado da ArticoPay, nome e email do pagador sao obrigatorios. CPF/CNPJ e telefone podem ser omitidos. A configuracao da conta pode exigir dados adicionais; nesses casos, a cobranca sera recusada. Outros fluxos mantem suas exigencias. Nunca envie dados pessoais ficticios.

Campo	Tipo	Descricao
token	string required	Token publico da integracao.
secret	string required	Chave secreta. Nunca exponha no frontend.
amount	number required	Valor da cobranca em reais.
debtor_name	string required	Nome completo do pagador.
email	email required	Email valido do pagador.
debtor_document_number	string opcional no Pix simplificado	CPF ou CNPJ real do pagador, quando informado. Obrigatorio nos demais fluxos.
phone	string opcional no Pix simplificado	Telefone real com DDD. O prefixo brasileiro +55 tambem e aceito e normalizado. Pode ser exigido pela configuracao da conta; obrigatorio nos demais fluxos.
method_pay	enum required	pix, billet ou card.
postback	url required	URL para receber webhook.

Auth Required

Criar solicitacao de saque

Envia um pagamento via Pix para a chave informada.

POSThttps://articopay.com/api/pixout

pixKey	string required	Chave Pix de destino.
pixKeyType	enum required	cpf, email, telefone ou aleatoria.
baasPostbackUrl	url required	URL de callback do saque.

Buscar entrada por ID

POSThttps://articopay.com/api/status

Consulte uma entrada usando idTransaction.

Buscar saque por ID

POSThttps://articopay.com/api/withdraw/status

Consulte uma solicitacao de saque usando id.

Webhook de entrada

Enviado para a URL informada em postback.

POSThttps://seudominio.com/callback/deposit

Webhook de saque

Enviado para a URL informada em baasPostbackUrl.

POSThttps://seudominio.com/callback/withdrawal

Shell cURL

Transacao Pix basica

POST https://articopay.com/api/wallet/deposit/payment

curl --request POST \
  --url https://articopay.com/api/wallet/deposit/payment \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "TOKEN",
    "secret": "SECRET",
    "amount": 10,
    "debtor_name": "Fulano de tal",
    "email": "pagador@example.com",
    "method_pay": "pix",
    "postback": "https:\/\/seudominio.com\/callback\/deposit"
}'

curl --request POST \
  --url https://articopay.com/api/wallet/deposit/payment \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "TOKEN",
    "secret": "SECRET",
    "amount": 10,
    "debtor_name": "Fulano de tal",
    "email": "pagador@example.com",
    "method_pay": "billet",
    "postback": "https:\/\/seudominio.com\/callback\/deposit",
    "debtor_document_number": "CPF_OU_CNPJ_DO_PAGADOR",
    "phone": "TELEFONE_DO_PAGADOR",
    "due_date": "2026-10-23"
}'

curl --request POST \
  --url https://articopay.com/api/wallet/deposit/payment \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "TOKEN",
    "secret": "SECRET",
    "amount": 10,
    "debtor_name": "Fulano de tal",
    "email": "pagador@example.com",
    "method_pay": "card",
    "postback": "https:\/\/seudominio.com\/callback\/deposit",
    "debtor_document_number": "CPF_OU_CNPJ_DO_PAGADOR",
    "phone": "TELEFONE_DO_PAGADOR",
    "installments": 1,
    "card": {
        "holder_name": "FULANO DE TAL",
        "number": "4111111111111111",
        "expiration_month": "12",
        "expiration_year": "2030",
        "cvv": "123"
    }
}'

curl --request POST \
  --url https://articopay.com/api/pixout \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "TOKEN",
    "secret": "SECRET",
    "amount": 10,
    "pixKey": "12345678911",
    "pixKeyType": "cpf",
    "baasPostbackUrl": "https:\/\/seudominio.com\/callback\/withdrawal"
}'

curl --request POST \
  --url https://articopay.com/api/status \
  --header 'Content-Type: application/json' \
  --data '{
    "idTransaction": "ID_DA_TRANSACAO"
}'

Request

{
    "token": "TOKEN",
    "secret": "SECRET",
    "amount": 10,
    "debtor_name": "Fulano de tal",
    "email": "pagador@example.com",
    "method_pay": "pix",
    "postback": "https:\/\/seudominio.com\/callback\/deposit"
}

{
    "token": "TOKEN",
    "secret": "SECRET",
    "amount": 10,
    "debtor_name": "Fulano de tal",
    "email": "pagador@example.com",
    "method_pay": "billet",
    "postback": "https:\/\/seudominio.com\/callback\/deposit",
    "debtor_document_number": "CPF_OU_CNPJ_DO_PAGADOR",
    "phone": "TELEFONE_DO_PAGADOR",
    "due_date": "2026-10-23"
}

{
    "token": "TOKEN",
    "secret": "SECRET",
    "amount": 10,
    "debtor_name": "Fulano de tal",
    "email": "pagador@example.com",
    "method_pay": "card",
    "postback": "https:\/\/seudominio.com\/callback\/deposit",
    "debtor_document_number": "CPF_OU_CNPJ_DO_PAGADOR",
    "phone": "TELEFONE_DO_PAGADOR",
    "installments": 1,
    "card": {
        "holder_name": "FULANO DE TAL",
        "number": "4111111111111111",
        "expiration_month": "12",
        "expiration_year": "2030",
        "cvv": "123"
    }
}

{
    "token": "TOKEN",
    "secret": "SECRET",
    "amount": 10,
    "pixKey": "12345678911",
    "pixKeyType": "cpf",
    "baasPostbackUrl": "https:\/\/seudominio.com\/callback\/withdrawal"
}

{
    "idTransaction": "ID_DA_TRANSACAO"
}

{
    "status": "paid",
    "idTransaction": "ID_DA_TRANSACAO",
    "typeTransaction": "PIX"
}

Response

201 400 401 422 500

{
    "success": true,
    "data": {
        "idTransaction": "ID_DA_TRANSACAO",
        "qrcode": "00020126330014br.gov.bcb.pix...",
        "qr_code_image_url": "https:\/\/exemplo.com\/qr-code.png"
    }
}

{
    "success": false,
    "message": "Requisicao invalida"
}

{
    "success": false,
    "message": "Token ou secret invalidos"
}

{
    "success": false,
    "message": "Erro de validacao",
    "errors": {
        "amount": [
            "O campo amount e obrigatorio."
        ]
    }
}

{
    "success": false,
    "message": "Erro interno do servidor"
}

Transacao criada com sucesso

Respostas por metodo

{
    "success": true,
    "data": {
        "idTransaction": "ID_DA_TRANSACAO",
        "qrcode": "00020126330014br.gov.bcb.pix...",
        "qr_code_image_url": "https:\/\/exemplo.com\/qr-code.png"
    }
}

{
    "success": true,
    "data": {
        "idTransaction": "ID_DA_TRANSACAO",
        "status": "waiting_payment",
        "amount": 10,
        "method_pay": "billet",
        "billet": {
            "line": "34191.09008 01234.567890 12345.678901 2 12340000001000",
            "barcode": "34191234000000100001090012345678901234567890",
            "pdf_url": "https:\/\/seudominio.com\/boleto.pdf",
            "due_date": "2026-10-23"
        }
    }
}

{
    "success": true,
    "data": {
        "idTransaction": "ID_DA_TRANSACAO",
        "status": "approved",
        "amount": 10,
        "method_pay": "card",
        "installments": 1
    }
}

{
    "id": "ID_DA_TRANSACAO",
    "amount": 10,
    "pixKey": "12345678911",
    "pixKeyType": "cpf",
    "withdrawStatusId": "PendingProcessing",
    "createdAt": "2026-10-20T09:25:28-03:00",
    "updatedAt": "2026-10-20T09:25:28-03:00"
}

Status e Webhooks

{
    "success": true,
    "status": "paid",
    "idTransaction": "ID_DA_TRANSACAO"
}

{
    "id": "ID_DA_TRANSACAO",
    "amount": 10,
    "pixKey": "12345678911",
    "pixKeyType": "cpf",
    "withdrawStatusId": "PendingProcessing",
    "createdAt": "2026-10-20T09:25:28-03:00",
    "updatedAt": "2026-10-20T09:25:28-03:00"
}

{
    "status": "paid",
    "idTransaction": "ID_DA_TRANSACAO",
    "typeTransaction": "PIX"
}

{
    "status": "paid",
    "idTransaction": "ID_DA_TRANSACAO",
    "typeTransaction": "PAYMENT"
}