API Reference

Criar transação para cartão, utilize o post abaixo :

Importante :

Para empresas com emissão automática de nota fiscal ativa, na transação deve ser informado os itens da venda para emissão da nota.

Antifraude :

Envie no parametro "client_ip" o IP do cliente que está executando a transação, este parâmetro é utilizado nas análises de antifraude.

POST END_POINT/transacao

{
    "empresa":{"id":"UUID"},
    "parcelas":int,
    "valor":double,
    "tipo":"String",
    "card_number":"String",
    "card_holder_name":"String",
    "card_expires":"String",
    "card_cvv":"String",
    "client_ip" : "String",
    "splits":[
        {
            "recebedor":{"id": "UUID"},
            "metodo":"String",
            "paga_taxa_transacao":boolean,
            "paga_resto_divisao_taxa":boolean,
            "valor":int
        },{
            "recebedor":{"id": "UUID"},
            "metodo":"String",
            "paga_taxa_transacao":boolean,
            "valor":double,
        },{
            "recebedor":{"id": "UUID"},
            "metodo":"String",
            "valor":double,
        }
    ],
    "cliente":{"id": "UUID"},
    "itens": [
        {
            "quantidade": int,
            "servico": {
                "id": "String"
            },
            "desconto": double,
            "total": double
        },
        {
            "quantidade": int,
            "servico": {
                "id": "String"
            },
            "desconto": double,
            "total": double
        }
    ]
}

🚧

Atenção :

Caso a emissão de NFS-e esteja ativada, a RPS gerada será devolvida no corpo da transação, esta RPS será transmitida automaticamente para a prefeitura do município da empresa emissora, após a conversão na prefeitura, será enviada automaticamente para o e-mail do cliente e um postback será enviado para o end point de postback do estabelecimento.

Retorno do POST feito mais acima :

{
    "id": int,
    "empresa": {
        "id": "String",
        "status": "String",
        "cnpj": "String",
        "razao_social": "String",
        "nome_fantasia": "String",
        "telefone": "String",
        "email": "String",
        "webhook": "String"
    },
    "cliente": {
        "id": "String",
        "tipo": "String",
        "nome": "String",
        "cpf": "String",
        "email": "String",
        "telefone_celular": "String",
        "cep": "String",
        "endereco": "String",
        "numero": "String",
        "bairro": "String",
        "cidade": "String",
        "uf": "String"
    },
    "data_criacao": "String",
    "data_atualizacao": "String",
    "status": "String",
    "tipo": "String",
    "origem": "String",
    "valor": double,
    "valor_liquido": double,
    "valor_taxa_administracao": double,
    "valor_taxa_antecipacao": double,
    "parcelas": 1,
    "card_holder_name": "String",
    "card_expires": "String",
    "card_brand": "String",
    "nsu": "String",
    "nsu_terminal": "String",
    "numero_terminal": "String",
    "pdv_adquirente": "String",
    "pagamentos": [
        {
            "id": "String",
            "status": "String",
            "recebedor": {
                "id": "String",
                "status": "ATIVA",
                "cnpj": "String",
                "razao_social": "String",
                "nome_fantasia": "String"
            },
            "data_compensacao_original": "String",
            "data_compensacao": "String",
            "valor": double,
            "valor_taxa_administracao": double,
            "valor_taxa_antecipacao": double,
            "valor_liquido": double,
            "parcela": int
        },
        {
            "id": "String",
            "status": "String",
            "recebedor": {
                "id": "String",
                "status": "String",
                "cnpj": "String",
                "razao_social": "String",
                "nome_fantasia": "String"
            },
            "data_compensacao_original": "String",
            "data_compensacao": "String",
            "valor": double,
            "valor_taxa_administracao": double,
            "valor_taxa_antecipacao": double,
            "valor_liquido": double,
            "parcela": int
        },
        {
            "id": "String",
            "status": "String",
            "recebedor": {
                "id": "String",
                "status": "String",
                "cnpj": "String",
                "razao_social": "String",
                "nome_fantasia": "String",
                "telefone": "String",
                "email": "String",
                "webhook": "String"
            },
            "data_compensacao_original": "String",
            "data_compensacao": "String",
            "valor": double,
            "valor_taxa_administracao":double,
            "valor_taxa_antecipacao": double,
            "valor_liquido": double,
            "parcela": int
        }
    ],
    "itens": [
        {
            "quantidade": int,
            "servico": {
                "id": "String"
            },
            "desconto": double,
            "total": double
        },
        {
            "quantidade": int,
            "servico": {
                "id": "String"
            },
            "desconto": double,
            "total": double
        }
    ],
    "nota_fiscal": {
        "id": int,
        "status": "String",
        "data_emissao": "String",
        "prestador": {
            "id": "String",
            "status": "String",
            "cnpj": "String",
            "razao_social": "String",
            "nome_fantasia": "String",
            "telefone": "String",
            "email": "String",
            "webhook": "String"
        },
        "tomador": {
            "id": "String",
            "tipo": "String",
            "nome": "String",
            "cpf": "String",
            "email": "String",
            "telefone_celular": "String",
            "cep": "String",
            "endereco": "String",
            "numero": "String",
            "bairro": "String",
            "cidade": "String",
            "uf": "String"
        },
        "numero_rps": int,
        "serie_rps": "String",
        "itens": [
            {
                "quantidade": int,
                "servico": {
                    "id": "String"
                },
                "desconto": double,
                "total": double
            },
            {
                "quantidade": int,
                "servico": {
                    "id": "String"
                },
                "desconto": double,
                "total": double
            }
        ]
    }
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!