Dupay

Esta chamada de API será utilizada para o cadastro de novas contas no sistema. O cadastro das contas é o primeiro passo para a utilização do sistema da Dupay.

A chamada dessa API não necessita de autenticação.

Após o cadastro da conta, a mesma passa por um processo de validação dos dados e somente após a conclusão que ela ficará liberada para realizar transações. Normalmente esse processo demora em torno de um dia útil.

Todas as requisições à API devem utilizar o método HTTP POST. A API recusa qualquer outro método que não seja o POST nas requisições.

É importante que envie os dados corretos da conta. Alguns dados não podem ser editados posteriormente.

MÉTODO DA API: newAccount

Parâmetros a serem enviados:

method = “newAccount”
companyName = Nome completo ou razão social
fantasyName = Nome fantasia
document = CPF ou CNPJ
responsibleName = Nome do responsável
responsibleDocument = Documento(CPF) do responsável
phoneNumber = Telefone de contato
zipCode = Cep do endereço da conta.
address = Logradouro
addressNumber = Número da residência ou estabelecimento comercial. Enviar números ou “S/N”
complement = Opcional* - Complemento do endereço
district = Bairro da conta
city = Nome da cidade da conta
state = Sigla do estado da conta. 2 letras.
email = email do responsável. Também será o login no sistema.
bank = Código do banco.
bankAgency = Número da agência bancária
bankAgencyDigit = Opcional* - Código da agência bancária. Obrigatório para Banco do Brasil e Bradesco apenas. Outros bancos não informar esse campo.
bankAccount = Número da conta bancária.
bankAccountDigit = Código da agência bancária.
bankType = Informar "C" para conta corrente ou "P" para poupança.
bankOperation = Opcional* - Operação da conta. Utilizar somente para Caixa Econômica.
bankSlipActive = Opcional* - Indica que a conta utiliza boleto bancário.
bankSlipDays = Quantidade de dias antes para a geração dos boletos das recorrências.
bankSlipMaxInstallments = Quantidade máxima de parcelas no boleto.
creditCardActive = Opcional* - Indica que a conta utiliza cartão de crédito.
creditCardTries = Opcional* - Quantidade de tentativas de cobrança via cartão de crédito para as recorrências.
creditCardInterval = Opcional* - Intervalo entre as tentativas de cobrança via cartão de crédito.
creditCardInstallmentActive = Opcional* - Indica se utiliza o parcelamento via cartão de crédito.
creditCardMaxInstallment = Opcional* - Indica o máximo de parcelas para o parcelamento via cartão de crédito.
interestActive = Opcional* - Indica se cobra juros por atraso no pagamento.
finesActive = Opcional* - Indica se cobra multa por atraso no pagamento.
finesPercent = Opcional* - Percentual da multa por atraso.

URL DA API

https://painel.dupay.com.br/api_v1/?vkey=5343f84566a14db9f4a8f79c713085c3

Os dados devem ser enviados preferencialmente por JSON e a resposta da API sempre será em JSON.

Todas as chamadas da API da Dupay respondem em JSON e possui algumas variáveis padrões na resposta. São elas:

status = Retorna 0 para falha e 1 para sucesso na chamada da API
message = Mensagem informativa em caso de falha na chamada da API
data = Dados retornados pela API em caso de sucesso na chamada.

Segue abaixo um exemplo de retorno JSON da chamada de cadastro de conta:

{
    "status": 1,
    "message": "Empresa cadastrada com sucesso",
    "data": {
        "accountId": 20,
        "companyName": "Dupay Serviços Financeiros Ltda",
        "fantasyName": "Dupay",
        "document": "00111222333344",
        "responsibleName": "Responsável 1",
        "responsibleDocument": "00011122233",
        "phoneNumber": "2730252519",
        "zipCode": "01311200",
        "address": "Avenida Paulista",
        "addressNumber": "3001",
        "complement": "",
        "district": "Bela Vista",
        "city": "São Paulo",
        "state": "SP",
        "email": "suporte@dupay.com.br",
        "bank": "341",
        "bankAgency": "1234",
        "bankAgencyDigit": "",
        "bankAccount": "123456",
        "bankAccountDigit": "7",
        "bankType": "C",
        "bankOperation": "",
        "bankSlipActive": "1",
        "bankSlipDays": "9",
        "bankSlipMaxInstallments": "48",
        "creditCardActive": "1",
        "creditCardTries": "5",
        "creditCardInterval": "2",
        "creditCardInstallmentActive": "1",
        "creditCardMaxInstallment": "10",
        "interestActive": "0",
        "finesActive": "0",
        "finesPercent": "5.00"
    }
}