Criar venda

Utilize nossa API para criar uma venda através do checkout transparente. Para isso, basta enviar uma requisição conforme o exemplo abaixo:

POST /api/v1/order

Para esse endpoint, é necessário ter criado o produto e os checkouts no nosso painel.

Abaixo, você pode ver exemplos de requisições para os métodos de pagamento: Pix, Cartão de crédito e Boleto.

curl --request POST \
    --url https://sandbox.azpag.dev/api/v1/order \
    --header 'Authorization: Bearer {token}' \
    --header 'Accept: application/json' \
    --header 'Content-type: application/json' \
    --data '{
        "checkout_id": "nVfgcG",
        "src": "<src>",
        "ref": "<ref>",
        "customer": {
            "fullname": "Elias Heitor Martins",
            "taxvat": "73845499222",
            "email": "elias@exemplo.com",
            "telephone": "6137210648"
        },
        "address": {
            "postcode": "73751-100",
            "street": "Rua Quadra 10",
            "number": "681",
            "complement": "",
            "city": "Planaltina",
            "region": "GO",
            "district": "Setor Norte",
            "country": "BR"
        },
        "payment": {
            "method": "pix",
            "expiration": 10
        }
    }'

curl --request POST \
    --url https://sandbox.azpag.dev/api/v1/order \
    --header 'Authorization: Bearer {token}' \
    --header 'Accept: application/json' \
    --header 'Content-type: application/json' \
    --data '{
        "checkout_id": "nVfgcG",
        "src": "<src>",
        "ref": "<ref>",
        "customer": {
            "fullname": "Elias Heitor Martins",
            "taxvat": "73845499222",
            "email": "elias@exemplo.com",
            "telephone": "6137210648"
        },
        "address": {
            "postcode": "73751-100",
            "street": "Rua Quadra 10",
            "number": "681",
            "complement": "",
            "city": "Planaltina",
            "region": "GO",
            "district": "Setor Norte",
            "country": "BR"
        },
        "payment": {
            "method": "bank_slip"
        }
    }'

O valor total do checkout será dividido pelas parcelas informadas, sem acréscimo de juros. Se desejar cobrar juros, informe a opção “apply_interest” no grupo de informações “payment”.

curl --request POST \
    --url https://sandbox.azpag.dev/api/v1/order \
    --header 'Authorization: Bearer {token}' \
    --header 'Accept: application/json' \
    --header 'Content-type: application/json' \
    --data '{
        "checkout_id": "nVfgcG",
        "src": "<src>",
        "ref": "<ref>",
        "customer": {
            "fullname": "Elias Heitor Martins",
            "taxvat": "73845499222",
            "email": "elias@exemplo.com",
            "telephone": "6137210648"
        },
        "address": {
            "postcode": "73751-100",
            "street": "Rua Quadra 10",
            "number": "681",
            "complement": "",
            "city": "Planaltina",
            "region": "GO",
            "district": "Setor Norte",
            "country": "BR"
        },
        "payment": {
            "method": "credit",
            "installments": 1,
            "apply_interest": 0,
            "card": {
                "number": "1111222233334444",
                "holder": "Elias Heitor Martins",
                "expiration": "01/2023",
                "security": "123"
            }
        }
    }'

Caso você precise enviar um valor customizado ao checkout, insira-o no grupo de informações denominado “payment” com o item “custom_total”.

curl --request POST \
    --url https://sandbox.azpag.dev/api/v1/order \
    --header 'Authorization: Bearer {token}' \
    --header 'Accept: application/json' \
    --header 'Content-type: application/json' \
    --data '{
        "checkout_id": "nVfgcG",
        "src": "<src>",
        "ref": "<ref>",
        "customer": {
            "fullname": "Elias Heitor Martins",
            "taxvat": "73845499222",
            "email": "elias@exemplo.com",
            "telephone": "6137210648"
        },
        "address": {
            "postcode": "73751-100",
            "street": "Rua Quadra 10",
            "number": "681",
            "complement": "",
            "city": "Planaltina",
            "region": "GO",
            "district": "Setor Norte",
            "country": "BR"
        },
        "payment": {
            "method": "credit",
            "custom_total": 100.30,
            "installments": 1,
            "apply_interest": 0,
            "card": {
                "number": "1111222233334444",
                "holder": "Elias Heitor Martins",
                "expiration": "01/2029",
                "security": "123"
            }
        }
    }'

Itens adicionais ou descontos

É possível adicionar itens ou descontos nas vendas através do nó de “items” na integração.

curl --request POST \
    --url https://sandbox.azpag.dev/api/v1/order \
    --header 'Authorization: Bearer {token}' \
    --header 'Accept: application/json' \
    --header 'Content-type: application/json' \
    --data '{
        "checkout_id": "nVfgcG",
        "src": "<src>",
        "ref": "<ref>",
        "customer": {
            "fullname": "Elias Heitor Martins",
            "taxvat": "73845499222",
            "email": "elias@exemplo.com",
            "telephone": "6137210648"
        },
        "address": {
            "postcode": "73751-100",
            "street": "Rua Quadra 10",
            "number": "681",
            "complement": "",
            "city": "Planaltina",
            "region": "GO",
            "district": "Setor Norte",
            "country": "BR"
        },
        "items": [
            {
                "sku": "001",
                "title": "Desconto",
                "unit_price": -30,
                "quantity": 1
            }
        ],
        "payment": {
            "method": "credit",
            "custom_total": 100.30,
            "installments": 1,
            "apply_interest": 0,
            "card": {
                "number": "1111222233334444",
                "holder": "Elias Heitor Martins",
                "expiration": "01/2029",
                "security": "123"
            }
        }
    }'

Todos os atributos

Atributo	Tipo	Obrigatório	Descrição	Instruções
checkout_id	Texto	Sim	Informação do checkout que será realizado a transação.	Preencha esse campo com o “Chave do checkout”. Essa informação conta em “Produtos” > “Checkouts”.
src	Texto	Não	Pode ser usado para referência externa, afim de identificar o pedido. Essa informação é devolvida na consulta por API ou webhooks.	Recomendamos usar esse campo para identificação única do pedido.
ref	Texto	Não	Pode ser usado para referência externa, afim de identificar o pedido. Essa informação é devolvida na consulta por API ou webhooks.	Recomendamos usar esse campo para identificação única do pedido.
customer ⌄	Objeto	Sim
fullname	Texto	Sim	Nome do comprador. Ex: João da Silva	Em caso de empresas, informar a Razão Social.
taxvat	Texto	Sim	Documento do comprador. Ex: 94919583052	O campo aceita CPF ou CNPJ.
email	Texto	Sim	Email do comprador.
telephone	Texto	Não	Telefone do comprador. Ex: 51999999999
address ⌄	Objeto	Sim
postcode	Texto	Sim	CEP do endereço do comprador. Ex: 90670-090
street	Texto	Sim	Logradouro do endereço do comprador. Ex: Av. Princesa Isabel
number	Número	Sim	Número do endereço do comprador. Ex: 123
complement	Texto	Não	Complemento do endereço do comprador. Ex: Sala 801
district	Texto	Sim	Bairro do endereço do comprador. Ex: Higienopolis
city	Texto	Sim	Cidade do endereço do comprador. Ex: Porto Alegre
region	Texto	Sim	UF do endereço do comprador. Ex: RS
items ⌄	Array	Não	Lista de produtos adicionais ao checkout, caso não estejam cadastrado no sistema.
items[].title	Texto	Sim	Descrição do produto nessa transação. Ex: Camisa branca
items[].sku	Texto	Sim	Codigo do produto nessa transação. Se não informado, o nome do produto é usado para gerar um slug. Ex: camiseta-branca
items[].unit_price	Decimal	Sim	Valor unitário do produto nessa transação. Não utilize virgula para casa decimal de centavos. Ex: 25.00
items[].quantity	Inteiro	Sim	Quantidade do produto nessa transação. Ex: 2
payment ⌄	Objeto	Sim
method	Texto	Sim	Qual opção de pagamento será realizado: `credit`, `bank_slip` ou `pix`
expiration	Inteiro	Não	Tempo limite para atualização do status de pagamento não efetuado. O tempo deve ser informado em minutos. O padrão do sistema é de 10 minutos.	Disponível apenas para pagamentos com cartão de crédito ou Pix. O QRCode do Pix expira após o tempo e não é aceito pelo sistema bancário.
installments	Inteiro	Sim	Número de parcelas. Ex: 3	Caso seja boleto ou pix, será considerado padrão 1.
apply_interest	Boolean	Não	Marque se deseja que nosso sistema aplique juros ao valor total informado.
custom_total	Decimal	Não	Se deseja enviar um valor customizado para o total da transação.	Se informado, o valor do checkout cadastrado no painel administrativo será desconsiderado.
custom_quantity	Inteiro	Não	Se deseja informar a quantidade de itens que represantam essa transação.	Se informado, a quantidade do checkout cadastrado no painel administrativo será desconsiderado.
payment.card ⌄	Objeto	Não	Se o `method` for credit, necessário informar os dados.
holder	Texto	Sim	Nome impresso no cartão de crédito do comprador. Ex: João da Silva
number	Texto	Sim	Número do cartão de crédito do comprador. Ex: 4122XXXXXXXX6740
expiration	Texto	Sim	Data de expiração do cartão de crédito do comprador. Ex: MM/YYYY
security	Texto	Sim	Código de verificação do cartão de crédito. Ex: 241

Nas transações por cartão de crédito, haverá nas respostas informações do token do cartão de crédito. É possível armazenar esse token para realizar novas vendas, informando apenas este campo ao invés de todos os dados de cartão.