{"info":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","description":"

Introdução

\n\n

A API AZ Pay está implementada em conformidade com o princípio de designREST. Nossa API possui recursos orientados a URLs, com códigos HTTP para indicar erros. Nós utilizamos funcionalidades HTTP nativas, como verbos de ação POST, PUT, GET, DELETE, para operações de leitura e escrita, bem como o modeloOAuth 2.0 de autenticação através de tokens bearerHTTP.

\n\n

Nós suportamos chamadas diretas aos recursos da API a partir de outras origens,CORS(cross-origin resource sharing), permitindo você interagir de maneira segura com nossas APIs a partir de aplicações web, lembrando sempre de utilizar sua chave pública nesses casos, reservando sua chave secreta para chamadas internas de sistema. Todas as respostas da API estão no formato de dados JSON, incluindo errors.

\n\n

Para permitir que você possa explorar todos os serviços sem preocupação, nossas contas possuem chaves de acesso nos modos de produção (LIVE - https://api.azape.co) e homologação (TEST - https://api.azape.dev). Possuímos duas modalidades de contratação, Gateway (onde o acesso é parcial, podendo apenas utilizar a Compradores, Transações, Planos e Assinaturas), e Marketplace (onde o acesso é total, tudo que o Gateway tem mais Vendedores, Pagamentos, Transferencias e Notificações).

\n\n

Autenticação Básica

\n\n

Nossas APIs REST permitem autenticação utilizandoOAuth 2.0 de autenticação através de tokens bearer.

\n\n

Você receberá um email contendo um link para gerar suas chaves de acesso. Caso o link não esteja mais disponível e você não tenha mais sua chave, solicite aosuporte.

\n\n

Para autenticar, você utilizará a chave recebida como token em seu cliente HTTP. Caso ele não tenha suporte a OAuth 2.0, você deverá adicionar um header HTTP, exemplo: Authorization: Bearer tGzv3JOkF0XG5Qx2TlKWIA

\n\n

Toda a comunicação deve ser criptografada via SSL/HTTPS. O token de autenticação bearer não é reversível, e toda a comunicação é por HTTPS, assim o contexto de segurança está completamente protegido. Um aplicativo deve enviar um cabeçalho de Autorização HTTP contendo o token bearer a cada solicitação.

\n\n

Toda requisição recebida que não esteja em HTTPS será considerada comprometida pelo nosso sistema e irá falhar.

\n\n

🚧 PRIMEIRO USO
A primeira requisição é utilizada para ativar sua chave, caso você receba um HTTP Status Code 403, aguarde 5 a 10 minutos e você poderá utilizar normalmente sua chave. Caso o problema persista solicite ajuda emapi@azape.co

\n\n

❗️NOTA
Você deverá salvar as suas chaves de API, independentemente de qualquer coisa. NÃO COMPARTILHE suas chaves de API com ninguém, nem mesmo nos canais de suporte da Azape.
Nenhum funcionário da Azape está autorizado a pedir sua chave de API ou qualquer outro dado sensível.

\n\n

Testando

\n\n

Quais cartões de crédito você deve usar para testar?

\n\n

Para testar sua integração sem ter que utilizar cartões de crédito de produção, você deve utilizar o nosso ambiente de testes. Esse ambiente é uma cópia exata do ambiente de produção, porém os cartões de crédito e as contas bancárias não são cobrados.

\n\n

Você poderá utilizar os seguintes números de cartão de crédito para simular transações de pagamento bem-sucedidas:

\n\n

Número	Bandeira
4539003370725497	Visa (Digitada)
4761340000000035	Visa (Chip & PIN)
4716588836362104	Visa (Tarja)
4532650104137832	Visa Electron (Débito)
5356066320271893	MasterCard (Digitada)
5201561050024014	MasterCard (Chip & PIN)
5577270004286630	MasterCard (Tarja)
5138692036125449	MasterCard Maestro (Débito)

\n\n

Além disso, esses são os números \"mágicos\" de cartões que gerarão respostas específicas, úteis para testar diferentes cenários:

Número	Descrição
6011457819940087	A transação será recusada com um código de \"card_declined\".
4929710426637678	A transação será recusada com um código \"card_declined\".
4710426743216178	A transação será recusada com um código \"service_request_timeout\".

\n\n

📘 NOTA
Você poderá usar qualquer holder_name, expiration_month, expiration_year e security_code para transação digitada.

Não utilize esses números de cartões em ambiente de produção!

\n\n

Códigos de Erro

\n\n

Códigos de Status HTTP

Em poucas palavras, existem apenas 3 resultados na interação entre seu aplicativo e nossa API:

\n\n

Tudo funcionou
O aplicativo fez algo errado
A API fez algo errado
A API Azape tenta retornar códigos de status de resposta HTTP apropriados para cada solicitação.

\n\n

Em geral, os códigos no intervalo 2xx indicam sucesso, os códigos no intervalo 4xx indicam um erro resultante das informações fornecidas (por exemplo, um parâmetro necessário faltou, uma transação falhou, etc.) e os códigos no intervalo 5xx indicam um erro com os servidores da Azape.

\n\n

A tabela a seguir contém os valores mais comuns para os códigos de status HTTP retornados pela API:

\n\n

HTTP STATUS CODE	Texto	Descrição
200	OK	Tudo funcionou conforme o esperado.
201	Created	A requisição foi bem sucedida e um novo recurso foi criado.
304	Not Modified	Não havia dados novos para retornar.
400	Bad Request	A requisição foi invalida ou não atingiu o servidor. Muitas vezes, falta um parâmetro obrigatório.
401	Unauthorized	As credenciais de autenticação estavam faltando ou foram incorretas.
402	Request Failed	Os parâmetros foram válidos mas a requisição falhou.
403	Forbidden	A requisição foi ok, mas foi recusado ou o acesso não foi permitido. Uma mensagem de erro que acompanha a mensagem explica o porquê.
404	Not Found	A URI solicitada é inválida ou o recurso solicitado, como por exemplo, um vendedor não existe ou foi excluído.
500	Internal Server Error	Algo está quebrado. Por favor, assegure-se de que a equipe Azape esteja investigando.
502	Bad Gateway	A Azape caiu ou está sendo atualizada.

\n\n

Mensagens de erro

\n\n

Quando uma requisição de API falha, a Azape retornará um código de resposta HTTP 4xx ou 5xx que identifica genericamente a falha, bem como uma resposta JSON que fornece informações mais específicas sobre o erro (ou os erros) que causou a falha.

\n\n

A resposta conterá:

\n\n

O status e o status_code.
O tipo e a categoria que você pode usar para programar as respostas aos erros.
Uma mensagem legível para humanos que explica por que o erro ocorreu.
Os valores possíveis para o parâmetro de tipo estão listados abaixo:

\n\n

Status Code	Tipo	Categoria	Descrição	Cod. Erro Bandeira
500	processing_error	server_api_error	Ocorreu um erro de processamento na Azape. Se você receber esta mensagem, entre em contato com api@azape.co
409	invalid_request_error	duplicate_taxpayer_id	Customer with this taxpayer_id already exists.
408	invalid_request_error	service_request_timeout	Credit card process is temporarily unavailable at the specified location.
404	invalid_request_error	endpoint_not_found	The requested URL was not found on the server
401	invalid_request_error	authentication_failed	The supplied user credentials failed validation for the requested service.
401	invalid_request_error	expired_security_key	The API Key provided has expired or has been deleted.
401	invalid_request_error	invalid_key_for_api_call	This API call cannot be made with a publishable API key.
400	invalid_request_error	transaction_amount_error	The minimum amount is $0.50 (or equivalent in country currency). The amount must be a positive integer in cents representing how much to charge, e.g 1260 for $12.60.
400	invalid_request_error	transfer_amount_error	The minimum transfer amount is $1.00 (or equivalent in country currency). The amount must be a positive integer in cents representing how much to charge, e.g 1260 for $12.60.
400	invalid_request_error	missing_required_param	Missing required parameter(s). Please verify request parameters.
400	invalid_request_error	unsupported_payment_type	Invalid request: unsupported payment type.
400	invalid_request_error	invalid_payment_information	Invalid payment information. Please verify request parameters.
400	invalid_request_error	invalid_parameter	Invalid parameter(s). Your parameter value is incorrect. Please verify request parameters.
402	file_upload	file_size_too_large
402	invalid_request_error	insufficient_escrow_funds_error	Requested transfer exceeds remaining settled funds in escrow.
402	invalid_request_error	capture_transaction_error	The capture request failed. Transaction could not be captured.
402	invalid_request_error	no_action_taken	No action taken. Unable to back out prior transaction
402	invalid_request_error	seller_authorization_refused	Seller has not been authorized to charge credit cards. Complete activation to start processing payments.
402	invalid_request_error	void_transaction_error	The void request failed. Transaction could not be voided.
402	card_error	invalid_expiry_month	Invalid expiry month value. Please verify request parameters.
402	card_error	invalid_expiry_year	Invalid expiry year value. Please verify request parameters.
402	card_error	card_customer_not_associated	Transaction denied. No active card.
402	card_error	insufficient_funds_error	Requested credit exceeds remaining settled funds.	51
402	card_error	expired_card_error	The credit card has expired.	33
402	card_error	invalid_card_number	The card number is not a valid credit card number.	15
402	card_error	invalid_pin_code	Transaction denied. Invalid PIN code.	55
402	card_error	authorization_refused	Transação ilegal	58

\n\n

Compatibilidade futura

\n\n

Para compatibilidade futura, interprete os seguintes intervalos de código de status:

\n\n

200-299 como sucesso,
400-499 como erros de solicitação do cliente,
500-599 como erros de servidor

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4126294","collectionId":"235c44c5-70c2-47ab-a658-73ae9ddd1203","publishedId":"TzeXjSgD","public":true,"customColor":{"top-bar":"201F23","right-sidebar":"38373B","highlight":"D557DE"},"publishDate":"2025-06-02T15:26:04.000Z"},"item":[{"name":"Cadastro e Credenciamento","item":[{"name":"Vendedor","item":[{"name":"Recuperar detalhes do vendedor pelo id","id":"996aec83-4035-42ea-9558-882c99637a85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/sellers/:seller_id","urlObject":{"path":["sellers",":seller_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"e5f2adbb-1084-4e85-9317-6a06fc512194","type":"any","value":"","key":"seller_id"}]}},"response":[],"_postman_id":"996aec83-4035-42ea-9558-882c99637a85"},{"name":"Listar MCCs (Merchant Category Codes)","id":"d4be6472-4ac7-424b-aea1-30a74dd3f26b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/sellers/mcc","urlObject":{"path":["sellers","mcc"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"d4be6472-4ac7-424b-aea1-30a74dd3f26b"},{"name":"Criar novo vendedor do tipo indivíduo CPF","id":"90ee2670-dcee-4e8d-8918-a1bd59329760","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"\", //Primeiro nome do vendedor\n \"last_name\": \"\", //Último nome do vendedor\n \"email\": \"\", //Email do vendedor\n \"phone_number\": \"\", //Número do telefone do vendedor\n \"taxpayer_id\": \"\", //CPF do vendedor\n \"birthdate\": \"\", //Data de nascimento do vendedor \"YYYY-MM-DD\"\n \"statement_descriptor\": \"\", //Esse é o nome que aparece na fatura associado a transação.\n \"description\": \"\", //Descrição\n \"address\": {\n \"line1\": \"\", //Logradouro\n \"line2\": \"\", //Número\n \"line3\": \"\", //Complemento\n \"neighborhood\": \"\", //Bairro/Distrito/Comunidade dentro de uma cidade\n \"city\": \"\", //Cidade\n \"state\": \"\", //Código ISO 3166-2 para o estado, com duas letras. Ex.: \"MG\",\"RJ\",\"PR\"\n \"postal_code\": \"\", //CEP com 8 digitos sem separador\n \"country_code\": \"\" //ISO 3166-1 alpha-2 - códigos de país de duas letras. Valor padrão: \"BR\"\n },\n \"mcc\": \"\", //Envie o código de atividade do negócio (MCC ID). Ex.: \"id\": \"1\".\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/sellers/individuals","urlObject":{"path":["sellers","individuals"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"90ee2670-dcee-4e8d-8918-a1bd59329760"},{"name":"Alterar um vendedor do tipo indivíduo CPF","id":"88602238-14c1-4e1f-8d8d-0babe9cd921c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"phone_number\": \"\",\n \"statement_descriptor\": \"\",\n \"description\": \"\",\n \"address\": {\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/sellers/individuals/:seller_id","urlObject":{"path":["sellers","individuals",":seller_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"d1124eac-094c-4841-a060-f9cb85048dbb","type":"any","value":"","key":"seller_id"}]}},"response":[],"_postman_id":"88602238-14c1-4e1f-8d8d-0babe9cd921c"},{"name":"Criar novo vendedor do tipo empresa CNPJ","id":"75f2967c-a1fe-4cf4-943d-4891011cffcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"owner\": {\n \"first_name\": \"\", //Primeiro nome do proprietário\n \"last_name\": \"\", //Último nome do proprietário\n \"email\": \"\", //Email do proprietário\n \"phone_number\": \"\", //Número do telefone do proprietário \"+5551999999999\"\n \"taxpayer_id\": \"\", //CPF do proprietário \"012345678999\"\n \"birthdate\": \"\" //Data de nascimento do proprietário \"YYYY-MM-DD\"\n },\n \"description\": \"\", //Descrição da empresa\n \"business_name\": \"\", //Nome da empresa\n \"business_phone\": \"\", //Telefone da empresa\n \"business_email\": \"\", //Email da empresa\n \"business_website\": \"\", //Site da empresa\n \"business_description\": \"\", //Descrição da empresa\n \"business_facebook\": \"\", //Página do Facebook da empresa\n \"business_twitter\": \"\", //Página do Twitter da empresa\n \"ein\": \"\", //CNPJ da empresa\n \"statement_descriptor\": \"\", //Esse é o nome que aparece na fatura associado a transação\n \"business_address\": {\n \"line1\": \"\", //Logradouro\n \"line2\": \"\", //Número\n \"line3\": \"\", //Complemento\n \"neighborhood\": \"\", //Bairro/Distrito/Comunidade dentro de uma cidade\n \"city\": \"\", //Cidade\n \"state\": \"\", //Código ISO 3166-2 para o estado, com duas letras. Ex.: \"MG\",\"RJ\",\"PR\"\n \"postal_code\": \"\", //CEP com 8 digitos sem separador\n \"country_code\": \"\" //ISO 3166-1 alpha-2 - códigos de país de duas letras. Valor padrão: \"BR\"\n },\n \"business_opening_date\": \"\", //Data de abertura da empresa \"YYYY-MM-DD\"\n \"owner_address\": {\n \"line1\": \"\", //Logradouro\n \"line2\": \"\", //Número\n \"line3\": \"\", //Complemento\n \"neighborhood\": \"\", //Bairro/Distrito/Comunidade dentro de uma cidade\n \"city\": \"\", //Cidade\n \"state\": \"\", //Código ISO 3166-2 para o estado, com duas letras. Ex.: \"MG\",\"RJ\",\"PR\"\n \"postal_code\": \"\", //CEP com 8 digitos sem separador\n \"country_code\": \"\" //ISO 3166-1 alpha-2 - códigos de país de duas letras. Valor padrão: \"BR\"\n },\n \"mcc\": \"\", //Envie o código de atividade do negócio (MCC ID). Ex.: \"id\": \"1\"\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/sellers/businesses","urlObject":{"path":["sellers","businesses"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"75f2967c-a1fe-4cf4-943d-4891011cffcf"},{"name":"Alterar um vendedor do tipo empresa CNPJ","id":"a3ad6a16-3fbb-4eb3-923b-5ee94280f3d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"owner\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"birthdate\": \"\"\n },\n \"description\": \"\",\n \"business_name\": \"\",\n \"business_phone\": \"\",\n \"business_email\": \"\",\n \"business_website\": \"\",\n \"business_description\": \"\",\n \"business_facebook\": \"\",\n \"business_twitter\": \"\",\n \"statement_descriptor\": \"\",\n \"business_address\": {\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\"\n },\n \"business_opening_date\": \"\",\n \"owner_address\": {\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/sellers/businesses/:seller_id","urlObject":{"path":["sellers","businesses",":seller_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"87ba4680-2d44-4a2c-9a31-03f63cc20171","type":"any","value":"","key":"seller_id"}]}},"response":[],"_postman_id":"a3ad6a16-3fbb-4eb3-923b-5ee94280f3d5"},{"name":"Enviar documento para KYC do vendedor","id":"a7cc932c-199e-4e9a-8f52-0668778d35d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"SELFIE","description":"

Envio Obrigatório

\n","type":"file","uuid":"d374cb7f-7faf-435f-a14b-e59eb6675001","value":null,"disabled":true},{"key":"CNH_FULL","description":"

Enviar documento CNH completo ou

\n","type":"file","uuid":"be602ffd-bbcd-4afe-ae4b-8caa1fb49efc","value":null,"disabled":true},{"key":"CNH_FRONT","description":"

Enviar documento CNH Frente e

\n","type":"file","uuid":"3d9fe997-508c-4afc-ab00-d0cca0853618","value":null,"disabled":true},{"key":"CNH_BACK","description":"

Enviar documento CNH Trazeira ou

\n","type":"file","uuid":"8b48a918-cea1-40c5-bb1c-833adcaf4fc3","value":null,"disabled":true},{"key":"RG_FRONT","description":"

Enviar documento RG Frente e

\n","type":"file","uuid":"0718d5d1-e44e-470d-bba6-2e05e3209909","value":null,"disabled":true},{"key":"RG_BACK","description":"

Enviar documento RG Trazeira

\n","type":"file","uuid":"6d159a3f-7125-4b71-aba2-ea850d98fba8","value":null,"disabled":true}]},"url":"https://api.azape.co/sellers/:seller_id/documents","description":"

Documentos Suportados: 

SELFIE: Formato de imagem (PNG, JPEG, BMP, WebP, HEIC, HEIF) 
\n
CNH_FULL: Formato de imagem (PNG, JPEG, BMP, WebP, HEIC, HEIF) ou PDF 
\n
CNH_FRONT: Formato de imagem (PNG, JPEG, BMP, WebP, HEIC, HEIF) 
\n
CNH_BACK: Formato de imagem (PNG, JPEG, BMP, WebP, HEIC, HEIF)
\n
RG_FRONT: Formato de imagem (PNG, JPEG, BMP, WebP, HEIC, HEIF) 
\n
RG_BACK: Formato de imagem (PNG, JPEG, BMP, WebP, HEIC, HEIF)
\n

Documentos Obrigatórios para Completar o KYC: 

SELFIE (obrigatório) + uma das seguintes opções:
\n
- CNH_FULL (completa), ou
  \n
- CNH_FRONT + CNH_BACK (frente e verso), ou  
  \n
- RG_FRONT + RG_BACK (frente e verso)
  \n
\n
   
\n
Tamanho máximo de envio de cada documento: 3mb
\n

\n","urlObject":{"path":["sellers",":seller_id","documents"],"host":["https://api.azape.co"],"query":[],"variable":[{"type":"any","value":"","key":"seller_id"}]}},"response":[],"_postman_id":"a7cc932c-199e-4e9a-8f52-0668778d35d0"},{"name":"Deleta um de vendedor pelo id","id":"352b509d-1f14-42a6-a686-775ecd0d9416","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.azape.co/sellers/:seller_id","urlObject":{"path":["sellers",":seller_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"4a60a72e-2b6a-4d39-8d38-b12733d7d1f8","type":"any","value":"","key":"seller_id"}]}},"response":[],"_postman_id":"352b509d-1f14-42a6-a686-775ecd0d9416"}],"id":"10b36d62-1216-419c-9a41-504de80db7e8","description":"

Os vendedores representam pessoas (PF) ou empresas (PJ). Normalmente, os vendedores oferecem uma variedade de mercadorias novas, usadas, remodeladas e colecionáveis on-line (cartão não presente). Você pode vincular seus cartões de crédito, contas bancárias, transações, reembolsos e muito mais...

\n\n

A Azape deve cumprir certos requisitos antes de ativar um vendedor para receber cartões de crédito e receber pagamentos. Para ser compatível, a Azape deve executar o KYC ou \"conhecer o seu cliente\" em um destinatário antes de permitir o processamento do cartão de crédito em um ambiente de produção e os fundos serem enviados para uma conta bancária.
Então, colete toda a informação que puder!

\n\n

Passo a Passo

Para usar o serviço de Credenciamento da Azape, você precisa:

Cadastro → Envio os dados do vendedor via API.
\n
Documentação → Envio dos documentos de identificação via API.
\n
Conta Bancária → Tokeniza e associa conta do vendedor.
\n
Análise BaaS → Aguardo da aprovação.
\n
Pronto! → Vendedor habilitado e pronto para vender.
\n

\n
❗️ Envio de Documento e Selfie A partir de 13 de março de 2026, para maior segurança e conformidade regulatória, será preciso realizar o envio de documento (RG/CNH) e Selfie do vendedor para que o credenciamento aconteça.
\n

🚧 Prazo de habilitação
O SLA de análise para credenciamento de novos sellers na Azape é de até 3 minutos para 99% dos casos.
Os casos de exceção, como empresas S/A ou empresas LTDAs que possuam uma empresa S/A na sua cadeia societária, possuem um SLA máximo de 3 dias úteis para finalização da análise.
O resultado da verificação é enviado via webhook, e para integração siga o manual.

\n\n

Implementando o credenciamento

\n\n

Possibilita o cadastro de um vendedor (seller) no marketplace e informando seus dados bancários de mesmatitularidade . Com essas informações a Zoop começa a realizar as devidas verificações para habilitar ou não o seller.

\n\n

Fluxo detalhado

\n\n

Para usar o serviço de Credenciamento da Azape, você precisa:

\n\n

Realizar o cadastro de um novo vendedor via API. Tokenizar uma conta bancária de mesma titularidade e associar ao seller, enviar Selfie e Documento.
Uma vez que o cadastro será avaliado e o mesmo podendo ser liberado ou não pela Azape.

\n\n

A Azape irá lidar com toda a parte burocrática, como a verificação da conta do vendedor (incluindo os requisitos do governo KYC - Conheça o seu Cliente), saques da conta bancária, segurança, etc. E ainda lhe dará acesso total a todas as informações sobre a conta, incluindo histórico de pagamentos, saldo da conta e notificações. Desta forma, você pode se concentrar em fornecer a melhor experiência do usuário para seu caso de uso.

\n\n

Clique na imagem para aumentar.

\n\n

Fluxo de status

\n\n

pending (Pendente) - As informações do vendedor foram recebidas com sucesso para processamento / subscrição.
enabled (Habilitado) - As informações do vendedor foram verificadas e validadas com
sucesso podendo prosseguir com as transações.
active (Ativo) - O cadastro do vendedor no Azape está completo.
denied (Negado) - O cadastro de um novo Seller (vendedor) não foi aprovado pela Azape, tendo que entrar em contato com api@azape.co para maiores informações.
deleted (Excluído) - O cadastro do vendedor foi excluído.
disabled (desabilitado) - O cadastro do vendedor encontra-se desabilitado.

\n\n

O objeto vendedor

\n\n

Atributos

\n\n

Id	Valor Identificador exclusivo para este vendedor
resource	Value: seller
taxpayer_id	Um número de identificação do contribuinte é usado para registrar e acompanhar os pagamentos de impostos.
type	(individual, business)
description	Uma string arbitrária que você pode anexar a um recurso de vendedor
first_name	Contém o primeiro nome do vendedor
last_name	Contém o sobrenome do vendedor
email	Endereço de e-mail deste vendedor
phone_number	Formatação do número E.164 para o telefone do vendedor. Os números E.164 podem ter um máximo de quinze dígitos e geralmente são escritos da seguinte forma: [+] [código do país] [número do assinante, incluindo o código de área].
mcc	integer Um código de 4 dígitos designado por uma empresa de cartão de crédito que lista o produto, serviço ou linha de negócios de um comerciante.
birthdate	Data de nascimento do vendedor individual ou representante do negócio. O formato é AAAA-MM, e. \"1980-05\"
facebook	ID do Facebook ou nome de usuário do vendedor ou representante do negócio.
twitter	ID do Twitter ou nome de usuário do vendedor ou representante do negócio
ein	CNPJ do Vendendor
address
	line1 Endereço da pessoa.
	lin2 O número da rua permite que você identifique cada edifício em uma rua.
	line3 Número do apartamento e outras informações.
	neighborhood Um distrito, especialmente um que forma uma comunidade dentro de uma cidade ou cidade.
	city Cidade do vendedor individual.
	state Código ISO 3166-2 para o estado da pessoa
	postal_code Código postal da pessoa
created_at	W3C Datetime Format para a criação da data (yyyy-mm-ddThh:mm:ssZ)
updated_at	W3C Datetime Format para a última atualização (yyyy-mm-ddThh:mm:ssZ)

\n\n

📘 Status de vendedor
new (Novo) - O vendedor foi criado pelo aplicativo.

pending (Pendente) - As informações do vendedor foram recebidas com sucesso
para processamento / subscrição.

enabled (Habilitado) - As informações do vendedor foram verificadas e validadas
com sucesso. Foi concedida uma aprovação temporária e o vendedor pode realizar
transações de cartões de crédito por um período de tempo limitado, até que o
processo de subscrição seja concluído. Sem aviso prévio, o pedido pode ser negado mais
tarde.

activo (Ativo) - O cadastro do vendedor na Azape está completo.

deleted (Excluído) - O cadastro do vendedor foi excluído.

expired (Expirou) - O Vendedor irá expirar se ainda estiverem em estado \"novo\"
após 30 minutos.

","event":[{"listen":"prerequest","script":{"id":"2b61738f-3ae1-43f8-a89c-6e266e92bac8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cbbe1050-1c96-401a-820b-a79cbfb1abd3","type":"text/javascript","exec":[""]}}],"_postman_id":"10b36d62-1216-419c-9a41-504de80db7e8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}},{"name":"Comprador","item":[{"name":"Recuperar detalhes do comprador","id":"889ede91-cd0c-4483-a12a-f258618ba9f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/buyers/:buyer_id","urlObject":{"path":["buyers",":buyer_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"cc7450b4-34de-4c18-ac9f-fbd5cffb7547","type":"any","value":"","key":"buyer_id"}]}},"response":[],"_postman_id":"889ede91-cd0c-4483-a12a-f258618ba9f2"},{"name":"Busca comprador através CPF/CNPJ","id":"e94d02be-e664-4a7b-b5a1-cc951bd044f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/buyers/search?taxpayer_id=","urlObject":{"path":["buyers","search"],"host":["https://api.azape.co"],"query":[{"key":"taxpayer_id","value":""}],"variable":[]}},"response":[],"_postman_id":"e94d02be-e664-4a7b-b5a1-cc951bd044f2"},{"name":"Criar comprador","id":"ef89c29a-a2e0-4394-8f4b-51a934a61033","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"\", //Primeiro nome do comprador\n \"last_name\": \"\", //Último nome do comprador\n \"email\": \"\", //Email do comprador\n \"phone_number\": \"\", //Telefone do comprador\n \"taxpayer_id\": \"\", //CPF do comprador\n \"birthdate\": \"\", //Data de nascimento do comprador \"YYYY-MM-DD\"\n \"description\": \"\", //Descrição\n \"address\": {\n \"line1\": \"\", //Logradouro\n \"line2\": \"\", //Número\n \"line3\": \"\", //Complemento\n \"neighborhood\": \"\", //Bairro/Distrito/Comunidade dentro de uma cidade\n \"city\": \"\", //Cidade\n \"state\": \"\", //Código ISO 3166-2 para o estado, com duas letras. Ex.: \"MG\",\"RJ\",\"PR\"\n \"postal_code\": \"\", //CEP com 8 digitos sem separador\n \"country_code\": \"\" //ISO 3166-1 alpha-2 - códigos de país de duas letras. Valor padrão: \"BR\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/buyers","urlObject":{"path":["buyers"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef89c29a-a2e0-4394-8f4b-51a934a61033"},{"name":"Alterar detalhes de comprador","id":"68bc2c9f-c38b-49df-aaed-ccb6d8c066eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"birthdate\": \"\",\n \"address\": {\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/buyers/:buyer_id","urlObject":{"path":["buyers",":buyer_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"a9d474eb-0767-49f9-b004-e75dd67b7621","type":"any","value":"","key":"buyer_id"}]}},"response":[],"_postman_id":"68bc2c9f-c38b-49df-aaed-ccb6d8c066eb"},{"name":"Remover comprador pelo id","id":"1607ae14-d512-4821-ae6b-9a64f27cc4a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.azape.co/buyers/:buyer_id","urlObject":{"path":["buyers",":buyer_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"d0eb37c4-4e03-43f0-8302-c34cb189c6d3","type":"any","value":"","key":"buyer_id"}]}},"response":[],"_postman_id":"1607ae14-d512-4821-ae6b-9a64f27cc4a0"}],"id":"bf4e8b05-5c3b-411f-a078-84a9682fc349","description":"

Comprador

Os clientes da Azape podem ter duas funções: o comprador (usuários que podem ser debitados) e a função do vendedor (usuários que podem ser creditados). Nesta sessão, vamos falar um pouco mais sobre o objeto \"comprador\" ou \"buyer\".

O objeto comprador (buyer) é usado para editar, excluir e atualizar os compradores, bem como para permitir reembolsos, assinaturas, inserir detalhes do cartão de crédito para um comprador, editar detalhes e, claro, fazer transações.

O objeto Comprador

Atributos

ID	Valor Identificador único do comprador
resource	Valor: buyer
description	Campo livre contendo a descrição do comprador
first_name	primeiro nome do comprador
last_name	último nome do comprador
taxpayer_id	CPF ou CNPJ do comprador
email	Endereço de email do comprador
phone_number	Número do telefone do comprador no formato E.164. Os números E.164 podem ter um máximo de quinze dígitos e geralmente são escritos da seguinte forma: [+] [código do país] [número do assinante, incluindo o código de área].
birthdate	Data de nascimento do comprador no formato YYYY-MM-DD
facebook	Facebook ID do comprador
twitter	Twitter ID do comprador
address	objeto \"address\" O mesmo objeto utilizado no campo de endereço do vendedor.
default_credit	Método padrão para pagamento atribuído ao comprador que será utilizado para debitar da conta ou do cartão de crédito.
created_at	Data de criação do comprador no formato (yyyy-mm-ddThh:mm:ssZ)
updated_at	Data da última atualização do comprador no formato (yyyy-mm-ddThh:mm:ssZ)

","event":[{"listen":"prerequest","script":{"id":"2395ed60-c6ed-40c2-b11f-cf024f2d5d7c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d4cfd5ae-61fe-4a71-89ed-1e1b94b461aa","type":"text/javascript","exec":[""]}}],"_postman_id":"bf4e8b05-5c3b-411f-a078-84a9682fc349","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}},{"name":"Token","item":[{"name":"Recuperar detalhes de token de cartão/conta bancária","id":"7232dd99-8cac-46a8-ac4b-02189622c2df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/tokens/:token_id","urlObject":{"path":["tokens",":token_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"488bd4d8-ad48-4271-aa81-2eb8ea7fd7b5","type":"any","value":"","key":"token_id"}]}},"response":[],"_postman_id":"7232dd99-8cac-46a8-ac4b-02189622c2df"},{"name":"Criar novo token de cartão","id":"953b3350-535f-4e9e-9869-c46af623f222","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"holder_name\": \"\", //Nome do portador\n \"expiration_month\": \"\", //Mês de expiração do cartão (MM)\n \"expiration_year\": \"\", //Ano de expiração do cartão (AAAA)\n \"card_number\": \"\", //Número do cartão\n \"security_code\": \"\" //Código de segurança do cartão (CVC)\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/cards/tokens","urlObject":{"path":["cards","tokens"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"953b3350-535f-4e9e-9869-c46af623f222"},{"name":"Criar novo token de conta bancária","id":"cf4b54b8-774f-4b13-a8cc-479e372d8470","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"holder_name\": \"\", //Nome do portador\n \"bank_code\": \"\", //Código do banco\n \"routing_number\": \"\", //Agencia sem DV (4 digitos)\n \"account_number\": \"\", //Conta Bancaria com DV ( dígito verificador)\n \"taxpayer_id\": \"\", //CPF, caso seller seja PF\n \"ein\": \"\", //CNPJ, caso seller seja PJ\n \"type\": \"\" //Conta corrente (checking) ou poupança (savings)\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/bank_accounts/tokens","urlObject":{"path":["bank_accounts","tokens"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf4b54b8-774f-4b13-a8cc-479e372d8470"},{"name":"Atrelar token de conta bancária a customer","id":"ca32291f-6dfa-49a7-b300-696dcd3718b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customer\": \"\", //ID do Seller\n \"token\": \"\" //ID do Token gerado\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/bank_accounts","urlObject":{"path":["bank_accounts"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"ca32291f-6dfa-49a7-b300-696dcd3718b9"}],"id":"89618be5-1be3-4609-860a-8ab633276334","description":"

Token

\n\n

A Azape possui a funcionalidade de tokenização, que é o ato de usar um valor substituto, ou token' que não tem valor inerente, no lugar dos dados que tem valor. Desta forma, você poderá realizar cobranças em um cartão de crédito sem ter que armazenar informações confidenciais em seus próprios servidores ou ter que pedir aos seus clientes que digitem as informações de cartões todas as vezes.

Os tokens devem ser usados apenas uma vez ou armazená-lo pra uso posterior e multiplas vezes, você precisará criar um objeto comprador (buyer) ou vendedor (seller) - pessoa física ou jurídica e atrelar o token a ele.

O objeto token

Atributos

Id	Valor Identificador único para este objeto
resource	Valor: token
type	( card, bankaccount) O tipo do token
used	Indica se o token foi ou não utilizado. Tokens podem ser utilizados apenas 1 vez se não atrelados a um Buyer ou Seller. Valor padrão: true
created_at	Data de criação do token no formato (yyyy-mm-ddThh:mm:ssZ)
updated_at	Data da última atualização no formato (yyyy-mm-ddThh:mm:ssZ)

","event":[{"listen":"prerequest","script":{"id":"a770fb49-c17c-4a59-8dd4-853a5db427a0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d10eedf3-a023-4711-a405-ce538baff3ea","type":"text/javascript","exec":[""]}}],"_postman_id":"89618be5-1be3-4609-860a-8ab633276334","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}}],"id":"65c7cd0b-f4cf-4c70-a3ec-0db38b17f891","description":"

Os objetos base, são especificamente as informações (Clientes e Vendedores) necessárias para efetivação de qualquer transação.

\n","_postman_id":"65c7cd0b-f4cf-4c70-a3ec-0db38b17f891","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}},{"name":"Transações e Recebíveis","item":[{"name":"Transação","item":[{"name":"Recuperar detalhes de uma transação pelo ID","id":"e9009ed0-e44e-4a13-8b2e-12a8bb561db3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/transactions/:transaction_id","urlObject":{"path":["transactions",":transaction_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"a0bdac3d-94e7-486b-9800-efac27775400","type":"any","value":"","key":"transaction_id"}]}},"response":[],"_postman_id":"e9009ed0-e44e-4a13-8b2e-12a8bb561db3"},{"name":"Criar transação pré autorização Cartão online","id":"a5237dcb-7f6b-45fa-8c40-c59105e337f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": \"\", //Valor em centavos a ser cobrado pela transação. Ex. R$10,00 = 1000\n \"description\": \"\", //Descrição da transação\n \"reference_id\": \"\", //ID do pedido da transação\n \"on_behalf_of\": \"\", //Id do vendedor dono da transação\n \"installment_plan\": \"\", //Número de parcelas da transação\n \"statement_descriptor\": \"\", //Nome da empresa que aparecerá na fatura. Utilizando esse campo você sobrescreve a informação do cadastro do Vendedor.\n \"customer\": \"\", //Id do comprador que será cobrado\n \"antifraud\": { //Objeto com as informações para o Antifraude\n \"address\": { //Objeto com o endereço de envio do pedido\n \"line1\": \"\", //Logradouro\n \"line2\": \"\", //Número\n \"line3\": \"\", //Complemento\n \"neighborhood\": \"\", //Bairro\n \"city\": \"\", //Cidade\n \"state\": \"\", //UF (Sigla)\n \"postal_code\": \"\" //CEP (Sem formatação)\n },\n\t\t\"price\": \"\", //Custo do envio do pedido\n \"items\": [ //Array dos itens do pedido\n {\n \"code\": \"\", //SKU do produto\n \"name\": \"\", //Nome do produto\n \"value\": \"\", //Valor do produto\n \"amount\": \"\", //Quantidade de itens do produto\n \"categoryName\": \"\" //Categoria do produto\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/transactions/card","urlObject":{"path":["transactions","card"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"a5237dcb-7f6b-45fa-8c40-c59105e337f6"},{"name":"Criar transação captura Cartão online","id":"353cd5c8-a600-433b-9f22-c0275b121839","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": \"\", //Valor em centavos a ser efetivado pela transação. Ex. R$10,00 = 1000\n \"on_behalf_of\": \"\" //Id do vendedor dono da transação\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/transactions/:transaction_id/capture","urlObject":{"path":["transactions",":transaction_id","capture"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"bbea27ff-fd51-4b45-8fb0-70d716edf9f1","type":"any","value":"","key":"transaction_id"}]}},"response":[],"_postman_id":"353cd5c8-a600-433b-9f22-c0275b121839"},{"name":"Criar transação completa Cartão online","id":"6be6c7ea-7079-42f6-beb4-52a6d756ef8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": \"\", //Valor em centavos a ser cobrado pela transação. Ex. R$10,00 = 1000\n \"description\": \"\", //Descrição da transação\n \"reference_id\": \"\", //ID do pedido da transação\n \"on_behalf_of\": \"\", //Id do vendedor dono da transação\n \"installment_plan\": \"\", //Número de parcelas da transação\n \"statement_descriptor\": \"\", //Nome da empresa que aparecerá na fatura. Utilizando esse campo você sobrescreve a informação do cadastro do Vendedor.\n \"customer\": \"\", //Id do comprador que será cobrado\n \"antifraud\": { //Objeto com as informações para o Antifraude\n \"address\": { //Objeto com o endereço de envio do pedido\n \"line1\": \"\", //Logradouro\n \"line2\": \"\", //Número\n \"line3\": \"\", //Complemento\n \"neighborhood\": \"\", //Bairro\n \"city\": \"\", //Cidade\n \"state\": \"\", //UF (Sigla)\n \"postal_code\": \"\" //CEP (Sem formatação)\n },\n\t\t\"price\": \"\", //Custo do envio do pedido\n \"items\": [ //Array dos itens do pedido\n {\n \"code\": \"\", //SKU do produto\n \"name\": \"\", //Nome do produto\n \"value\": \"\", //Valor do produto\n \"amount\": \"\", //Quantidade de itens do produto\n \"categoryName\": \"\" //Categoria do produto\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/transactions/full","urlObject":{"path":["transactions","full"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"6be6c7ea-7079-42f6-beb4-52a6d756ef8d"},{"name":"Criar transação Boleto","id":"ca8a7972-e45b-45b5-a29c-9b32274ff6f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": \"\", //Valor em centavos a ser cobrado pela transação. Ex. R$10,00 = 1000\n \"description\": \"\", // Descrição da cobrança\n \"reference_id\": \"\", //ID do pedido da transação\n \"on_behalf_of\": \"\", //Identificador do Vendedor responsável pela venda\n \"customer\": \"\", //Identificador do comprador que será cobrado. Obs. Deve ter cadastro completo com Endereço completo\n \"payment_method\": {\n \"expiration_date\": \"\", //Data de vencimento \"YYYY-MM-DD\"\n \"top_instructions\": \"\" //Instruções para o comprador\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/transactions/boleto","description":"

Boleto não possui cancelamento via API, ele é cancelado automaticamente se não for pago em até 60 dias a contar da data da emissão.

\n","urlObject":{"path":["transactions","boleto"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"ca8a7972-e45b-45b5-a29c-9b32274ff6f1"},{"name":"Criar transação Pix","id":"03f80542-40ea-4fc5-a41f-9953edb2cf18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": \"\", //Valor em centavos a ser cobrado pela transação. Ex. R$10,00 = 1000\n \"description\": \"\", // Descrição da cobrança\n \"reference_id\": \"\", //ID do pedido da transação\n \"on_behalf_of\": \"\", //Identificador do Vendedor responsável pela venda\n \"buyer\": { //Objeto com os dados do comprador\n \"id\": \"\", //ID do comprador caso já cadastrado\n \"doc\":\"\", //Identificador do comprador que será cobrado (CPF/CNPJ).\n \"name\": \"\" //Nome do comprador.\n }\n \n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/transactions/pix","description":"

Criando uma transação Pix online

O Pix é novo meio de pagamento instantâneo de fácil integração que otimiza a transação entre consumidores e vendedores.

Fluxo transacional

\n
❗️
\n
Sobre o pagamento
\n
Para o cliente “pagador” da transação de Pix será exibida a identificação do seller no campo “mensagem ao pagador”.
\n
Caso uma confirmação de pagamento seja realizada depois da expiração do QR Code, automaticamente uma operação de cancelamento (void) será comandada.
\n

QR Code e \"Copia e cola\"

Para obter os dados para gerar QR Code ou para o pagamento \"copia e cola\" é necessário utilizar a informação que retorna no campo \"emv\" após a criação do Pix, conforme o exemplo abaixo:

Retorno Pix - emv

\"qr_code\": {\n            \"emv\": \"00020101021226770014BR.GOV.BCB.PIX2555api.itau/pix/qr/v2/c8f91ed7-b017-4e04-b744-7b3a0169625b5204000053039865802BR5925Zoop Tecnologia E Meios D6009SAO PAULO62070503***63042330\"\n        }\n\n

Tempo de expiração de Pix QR Code.

Atualmente, o limite global para qualquer marketplace é de 5 minutos.

Fluxo de status

Fluxo de status

Durante o fluxo de compra uma transação existem diferentes estados de acordo com as atualizações aplicadas.

Você pode verificar o estado atual através do campo \"status\", sempre retornado no objeto da transação. Também é possível verificar o histórico de uma transação através do campo \"history\".

new: Uma nova transação foi criada e as informações foram recebidas com sucesso para processamento.

pending: Observe que o status da transação é retornado como pending, permanecendo neste estado até que o pagamento seja identificado ou então o prazo de validade se encerre.

succeeded: O pagamento do Pix foi identificado pela Azape.

failed: Ocorreu uma falha ao processar a transação.

canceled: O pagamento foi cancelado/anulado pelo vendedor. As taxas cobradas originalmente também são anuladas. Esse status também refere-se a uma transação de Pix não paga dentro do tempo de validade do QR Code. O evento disparado no caso de expiração de QR Code será \"transaction.canceled\". Também será atualizado o campo \"operation_type\"' para \"expiration\" na chave \"history\"

\n","urlObject":{"path":["transactions","pix"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"03f80542-40ea-4fc5-a41f-9953edb2cf18"},{"name":"Estornar transação Cartão Online","id":"e8910c70-1061-48ee-8cee-9e310fdaac16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"on_behalf_of\": \"\", //Identificador do seller responsável pela venda\n \"amount\": \"\" //Valor da venda a ser estornado em centavos. Ex. R$10,00 = 1000\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/transactions/:transaction_id/void","urlObject":{"path":["transactions",":transaction_id","void"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"325aaea4-dd1b-439d-b892-ae9396d2e3f0","type":"any","value":"","key":"transaction_id"}]}},"response":[],"_postman_id":"e8910c70-1061-48ee-8cee-9e310fdaac16"}],"id":"4c007be3-7888-4be1-b042-a037fe834ded","description":"

Transação

\n\n

Quando um cliente fornece um número de cartão, mas não tem acesso ao cartão físico, a compra é conhecida como uma transação de cartão não presente (CNP). Esse tipo de transação geralmente ocorre através da Internet ou através de um call center.

\n\n

O recurso de transações é usado para debitar um cartão ou uma conta bancária eletronicamente via ACH. Ele retorna um identificador exclusivo que pode ser posteriormente usado para emitir um reembolso integral ou parcial. Você precisará de um ID de cliente existente (vendedor ou comprador) ou de um método de pagamento válido (cartão ou conta bancária).

\n\n

Tanto o cartão como a conta bancária devem ser um token não usado ou um ID exclusivo existente já associado a um cliente. Alternativamente, você também pode usar um ID de pré-autorização.

\n\n

O recurso da transação

\n\n

Atributos

\n\n

ID	Valor Identificador exclusivo para esta transação
resource	Value: transaction
status	(new, pending, pre_authorized, succeeded, failed, reversed, canceled, refunded, dispute, charged_back) Indica o estado atual desta transação, por exemplo, reembolsado significa que o valor é totalmente reembolsado.
amount	> 0 Um número inteiro positivo em centavos que representa o quanto de carga, p. \"1260\" por R$ 12,60.
original_amount	> 0 Um número inteiro positivo em centavos
currency	Um código de moeda com formato ISO 4217 de 3 letras
description	Uma seqüência arbitrária que você pode anexar a um objeto de transação
reference_id	ID referência do pedido referente a transação
antifraud	Objeto com os dados para validação do Antifraude
payment_type	enum (credit, boleto) Métodos de pagamento aceitos. Os métodos de pagamento disponíveis podem variar de acordo com a localização.
transaction_number	Este é o número da transação que aparece nos recibos de e-mail enviados para esta venda.
refunds	refund objects or null
rewards	Um identificador exclusivo para o objeto de recompensas associado.
discounts	Um identificador exclusivo para o objeto de desconto associado.
sales_receipt	Um identificador exclusivo para o objeto de recebimento associado.
on_behalf_of	Um identificador exclusivo de um objeto vendedor. Tanto os vendedores individuais ou comerciais dentro do seu mercado.
customer	Um identificador exclusivo de um vendedor ou um objeto comprador. Os clientes representam vendedores (indivíduos ou empresas) ou compradores dentro do mercado.
statement_descriptor	Um descritor de declaração é o nome da empresa que aparece no extrato mensal do cartão de crédito do cliente. Permite que o cliente identifique rapidamente as transações reduzindo disputas e atendimento ao cliente.
payment_method	Um método de pagamento válido (cartão ou conta bancária).
installment_plan	O plano permite aos compradores comprar produtos em até 12 parcelas em qualquer cartão de crédito, com ou sem taxas de juros.
mode	(interest_free, with_interest) Indica o tipo de plano de parcelamento. Para os planos de juros, o montante do pagamento será dividido em parcelas mensais. O vendedor recebe o pagamento no mesmo número de parcelas. Para com os planos de interesse, o interesse é aplicado ao preço de compra, o montante será dividido em parcelas mensais e pago pelo comprador. O vendedor recebe o valor total de uma só vez, a partir de uma transação de cartão de crédito.
number_installments	O número de parcelas é organizado com o comprador no momento da compra.
fees	> 0 Um número inteiro positivo em centavos que representa a taxa total aplicada à transação.
fee_details
currency	string A 3-letter ISO 4217 formatted currency code
location_latitute	float A latitude em que ocorreu a transação
location_longitude	float A longitude em que ocorreu a transação
expected_on	W3C Datetime Format (yyyy-mm-ddThh:mm:ssZ) Retornar ao criar a transação como uma estimativa para quando o dinheiro estará disponível.
created_at	W3C Datetime Format para a criação de data (yyyy-mm-ddThh:mm:ssZ)
updated_at	W3C Datetime Format Para a última atualização (yyyy-mm-ddThh:mm:ssZ)

\n\n

📘 Status da Transação
Novo (new) - A transação foi criada pelo aplicativo.
Pendente (pending) - As informações da transação foram recebidas com sucesso para processamento.
Pré-autorizado ( pre_authorized) - Quando as Transações são emitidas com o parâmetro de captura como falso, uma pré-autorização é criada e precisará ser capturada mais tarde. Uma transação pré-autorizada deve ser capturada dentro de sete dias ou será automaticamente expirada.
Sucesso (succeeded) - O pagamento foi autorizado e os fundos estarão disponíveis em depósito.
Falhou (failed) - A transação falhou.
Invertido (reversed) - Uma reversão ocorre antes que a transação tenha sido confirmada.
Cancelado (canceled) - O pagamento foi cancelado / anulado pelo vendedor ou pelo aplicativo. As taxas cobradas originalmente também são anuladas.
Reembolsado (refunded) - A diferença entre um vazio e um reembolso se resume a se uma transação foi ou não resolvida. Uma transação instável pode ser anulada. Uma vez que uma transação foi resolvida, ela só pode ser reembolsada.
Disputa (dispute) - Quando o titular do cartão envia uma queixa comunicando-se com o banco emissor sobre a transação errada, o banco emissor abre uma disputa com o comerciante, solicitando a documentação necessária e a prova para remediar o estorno. Se a documentação fornecida for satisfatória, a disputa é simplesmente recusada e o cliente é cobrado com uma taxa de processamento. Se os documentos parecem ser insatisfatórios, o montante do reembolso será fornecido ao cliente e o comerciante será debitado.
charged_back - O status indica que o pagamento foi cobrado pelo comprador e o pagamento foi debitado da conta do vendedor.

\n\n

🚧 Fluxo de notificação de Charged Back
O comprador solicita ao seu banco emissor o estorno / cancelamento de uma transação;
O emissor informa à Azape que esta transação foi contestada pelo comprador;
A Azape atualiza o status da transação para \"dispute\" e suspende os pagamentos de recebíveis a vencer associados a esta venda;
A notificação sobre transações em disputa é realizada automaticamente pelo sistema através do disparo do evento de \"transaction.disputed\" devendo este evento ser monitorado pelo marketplace para a que possa atuar caso desejado;
Caso o EC ou o Marketplace envie a documentação necessária no prazo de 7 dias (corridos) a Azape encaminha a documentação ao adquirente / emissor e aguarda o resultado do processo, que pode ocorrer no prazo de até 30 dias (corridos);
Caso o retorno seja favorável ao EC, a Azape é notificada, confirma o processo de disputa e dispara o evento \"transaction.dispute.succeeded\", alterando o status da transação para 'succeeded' e removendo a suspensão dos recebíeis pendentes de pagamento;
Caso o retorno seja favorável ao comprador, ou a Azape não receba retorno no prazo estipulado, o processo de disputa é encerrado e o status da transação é alterado em definitivo para \"charged_back\", sendo disparado o evento \"transaction.charged_back\" e realizado o debito na conta do EC ou do Marketplace, dependendo de quem for o responsável pelos chargebacks no contrato comercial
Caso o Marketplace / EC não envie a documentação dentro do prazo, o processo de disputa é encerrado e o status da transação é atualizado em definitivo para \"transaction.charged_back\"

","event":[{"listen":"prerequest","script":{"id":"bc045c2e-3df5-4fb8-b5bf-9f0e40cf54ea","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b5998f54-ea55-4259-9100-834064ea68c6","type":"text/javascript","exec":[""]}}],"_postman_id":"4c007be3-7888-4be1-b042-a037fe834ded","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}},{"name":"Cartão","item":[{"name":"Recuperar detalhes de cartão pelo ID","id":"092e24a8-b6d3-4c0b-837e-31c363bdc653","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/cards/:card_id","urlObject":{"path":["cards",":card_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"4199c4a6-a5fb-4d44-bac2-3d2fcea30d6f","type":"any","value":"","key":"card_id"}]}},"response":[],"_postman_id":"092e24a8-b6d3-4c0b-837e-31c363bdc653"},{"name":"Associar cartão ao comprador","id":"9f8c1dfc-157e-40e5-aebc-894692ded3e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"token\": \"\", //ID do token de cartão a ser associado ao customer\n \"customer\": \"\" //ID do customer\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/cards","urlObject":{"path":["cards"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"9f8c1dfc-157e-40e5-aebc-894692ded3e0"},{"name":"Remover cartão pelo ID","id":"78e210c5-af00-4aed-9497-ac1cfbf8dfc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.azape.co/cards/:card_id","urlObject":{"path":["cards",":card_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"de093c16-274a-4b08-a741-166fc2da1b0b","type":"any","value":"","key":"card_id"}]}},"response":[],"_postman_id":"78e210c5-af00-4aed-9497-ac1cfbf8dfc8"}],"id":"f511f8e4-c483-4e28-baad-2637f683be14","description":"

Cartão

O recurso do cartão representa um método de pagamento com cartão de crédito. Você só pode criar um novo cartão de crédito se tiver um token de cartão seguro. A Azape usa tokenização para proteger cartões, contas bancárias e proteger outras informações confidenciais de identificação pessoal (PII), a fim de cumprir os padrões da indústria e os regulamentos governamentais.

O recurso do cartão

Atributos

ID	Valor Identificador exclusivo para este cartão
resource	Value: card
description	Um valor definido para descriação do cartão
first4_digits	Primeiros 4 digitos do cartão de crédito
card_brand	Bandeira do cartão. Pode ser Visa, American Express, MasterCard, Discover, JCB, Diners Club, or Desconhecido
expiration_month	Mês de expiração do cartão de crédito
expiration_year	Ano de expiração do cartão de crédito
holder_name	Nome do vendedor (seller) ou comprador (buyer) a quem este cartão de crédito foi emitido.
customer	O identificador exclusivo de um vendedor (*seller) ou um recurso comprador (buyer)
is_active	Indica se o cartão está ativo ( true ) ou foi desativado ( false ). Valor padrão: true
is_verified	Se um recurso de cartão foi ou não verificado durante o cartão, você não processou transações com cartões que falham neste check.ization (por exemplo, corresponde ao código de segurança). É fortemente recomendável
fingerprint	Todo cartão ( card) recurso tem um atributo de impressão digital que pode ser usado para identificar de forma exclusiva um número de cartão particular
verification_checklist
postal_code_check	Se o código postal foi fornecido, os resultados do cheque: pass, fail ou unchecked
security_code_check	Se um CVC fosse fornecido, os resultados do cheque:pass, fail, ou unchecked
address_line1_check	Se o Endereço[line1] foi fornecido, os resultados da analise podem ser: pass, fail, ou unchecked
created_at	W3C Datetime Format para a criação da data (yyyy-mm-ddThh:mm:ssZ)
updated_at	W3C Datetime Format para a última atualização (yyyy-mm-ddThh:mm:ssZ)

","event":[{"listen":"prerequest","script":{"id":"71a7cab4-126f-4e6e-b491-aa674054e1c9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d486e0ca-1e41-4de9-b4f2-2712b2375e94","type":"text/javascript","exec":[""]}}],"_postman_id":"f511f8e4-c483-4e28-baad-2637f683be14","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}},{"name":"Boleto","item":[{"name":"Recuperar detalhes do boleto pelo ID","id":"48f6f8a9-21da-4408-86de-308d9ac1ca50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/boletos/:boleto_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["boletos",":boleto_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"9ef7905a-41da-42b6-8096-710e9f0b31dd","type":"any","value":"","key":"boleto_id"}]}},"response":[],"_postman_id":"48f6f8a9-21da-4408-86de-308d9ac1ca50"},{"name":"Solicitar cancelamento Boleto","id":"7bb99ab1-8769-4c6b-b6ea-7d3a67150740","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.azape.co/transactions/:transaction_id/boleto/cancel","urlObject":{"path":["transactions",":transaction_id","boleto","cancel"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"361ab3b8-05ad-42bc-b7f1-1819e9c0f027","type":"any","value":"","key":"transaction_id"}]}},"response":[],"_postman_id":"7bb99ab1-8769-4c6b-b6ea-7d3a67150740"}],"id":"177b59f7-0e72-403b-ab57-6ca071332e64","_postman_id":"177b59f7-0e72-403b-ab57-6ca071332e64","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}},{"name":"Regra de Divisão - Split","item":[{"name":"Recuperar detalhes das regras de divisão por transação","id":"b0d7b78e-64fe-441e-8ded-403b863c5cbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/transactions/:transaction_id/split_rules","urlObject":{"path":["transactions",":transaction_id","split_rules"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"7075caf5-d8e7-4364-84e3-45fa84040c59","type":"any","value":"","key":"transaction_id"}]}},"response":[],"_postman_id":"b0d7b78e-64fe-441e-8ded-403b863c5cbb"},{"name":"Recuperar detalhe de uma regra de divisão por transação","id":"06f9d7be-cc38-460f-9170-772829531e56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/transactions/:transaction_id/split_rules/:id","urlObject":{"path":["transactions",":transaction_id","split_rules",":id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"202245f0-b923-40e1-90a3-49d3b536524c","type":"any","value":"","key":"transaction_id"},{"id":"5d1d548f-12e8-47fb-9c4c-6401f99aac0b","type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"06f9d7be-cc38-460f-9170-772829531e56"},{"name":"Criar regra de divisão por transação","id":"45e8aa41-5e40-4f85-87da-9b3874d1485e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"recipient\": \"\", //Identificador do seller recebedor\n \"charge_processing_fee\": \"\", //Define se vai ser feito split em cima do valor bruto (true) ou liquido (false)\n \"percentage\": \"\", //Percentual da venda a ser splitado\n \"amount\": \"\" //Valor em centavos a ser splitado. Ex. R$10,00 = 1000\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/transactions/:transaction_id/split_rules","urlObject":{"path":["transactions",":transaction_id","split_rules"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"6ba2c10d-9a39-4386-a0e1-35a3cb7ec032","type":"any","value":"","key":"transaction_id"}]}},"response":[],"_postman_id":"45e8aa41-5e40-4f85-87da-9b3874d1485e"},{"name":"Alterar regra de divisão por transação","id":"374873ef-1911-4afe-9588-930fadba65a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"recipient\": \"\", //Identificador do seller recebedor\n \"charge_processing_fee\": \"\", //Define se vai ser feito split em cima do valor bruto (true) ou liquido (false)\n \"percentage\": \"\", //Percentual da venda a ser splitado\n \"amount\": \"\" //Valor em centavos a ser splitado. Ex. R$10,00 = 1000\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/transactions/:transaction_id/split_rules/:id","urlObject":{"path":["transactions",":transaction_id","split_rules",":id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"8a7e9581-750a-469f-b4d6-4844eae8c263","type":"any","value":"","key":"transaction_id"},{"id":"ccb40873-45b9-4e59-8659-0e61cff39fee","type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"374873ef-1911-4afe-9588-930fadba65a2"},{"name":"Remover regra de divisão por transação","id":"42b22bea-ac81-40e5-9217-04697b1225f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.azape.co/transactions/:transaction_id/split_rules/:id","urlObject":{"path":["transactions",":transaction_id","split_rules",":id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"b610aefb-797b-461e-94a0-f23c169506e0","type":"any","value":"","key":"transaction_id"},{"id":"f27364ba-7286-4e62-b145-8822574a182c","type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"42b22bea-ac81-40e5-9217-04697b1225f3"}],"id":"1b31b98b-3f6e-46f3-91a7-7762804bcea8","_postman_id":"1b31b98b-3f6e-46f3-91a7-7762804bcea8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}},{"name":"Recebíveis","item":[{"name":"Listar recebíveis por transação","id":"33b2748f-15c6-4a99-b0c9-e6df3296c389","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/transactions/:transaction_id/receivables","urlObject":{"path":["transactions",":transaction_id","receivables"],"host":["https://api.azape.co"],"query":[],"variable":[{"type":"any","value":"","key":"transaction_id"}]}},"response":[],"_postman_id":"33b2748f-15c6-4a99-b0c9-e6df3296c389"},{"name":"Listar detalhes de recebível","id":"edc721da-6664-425f-885e-116cd94da1f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/receivables/:receivable_id","urlObject":{"path":["receivables",":receivable_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"type":"any","value":"","key":"receivable_id"}]}},"response":[],"_postman_id":"edc721da-6664-425f-885e-116cd94da1f9"}],"id":"cee9847f-db80-4892-813c-5c71e2526586","description":"

Recebíveis

Um objeto recebível é criado quando ocorre uma cobrança por cartão ou boleto, que identificará o quanto irá receber por essa transação, bem como quando os fundos estarão disponíveis no seu saldo.

id `string`	Identificador exclusivo para este recebível
status `enum`	(Pendente, pago, cancelado, reembolsado) Indica o status atual deste recebível, por exemplo, pago significa que o dinheiro é creditado com sucesso no saldo do vendedor.
recipient `string`	Um identificador exclusivo de um objeto vendedor. Os destinatários representam vendedores dentro do seu mercado.
transaction `string`	Um identificador exclusivo do objeto de transação que se originou recebido.
split_rule `string`	Um identificador exclusivo do objeto split_rule que originou o recebível.
amount `integer`	>0(maior que zero) Um número inteiro positivo em centavos que representam a quantidade líquida a receber, e. \"1260\" por R$ 12,60
liable `boolean`	Seja ou não o recebível será reembolsado em caso de rejeição de uma transação.
installment `string`	Indica o número da parcela a ser paga neste recebimento.
paid_at `string`	W3C Datetime Format Para a data de pagamento (yyyy-mm-ddThh:mm:ssZ)
canceled_at `string`	W3C Datetime Format Para a data de cancelamento (yyyy-mm-ddThh:mm:ssZ)
expected_on `string`	W3C Datetime Format Para a data esperada de crédito a receber no saldo do vendedor (yyyy-mm-ddThh:mm:ssZ)

","_postman_id":"cee9847f-db80-4892-813c-5c71e2526586","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}}],"id":"7ee39030-b3c0-48c2-8a9b-6464db207f6e","event":[{"listen":"prerequest","script":{"id":"51e85c78-ab10-4919-b7b3-e10ab741f89a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"afa87e57-686e-465d-846c-0b8d0b0d8b9c","type":"text/javascript","exec":[""]}}],"_postman_id":"7ee39030-b3c0-48c2-8a9b-6464db207f6e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}},{"name":"Pagamentos e Transferências","item":[{"name":"Conta Bancária","item":[{"name":"Associar conta bancaria com customer","id":"36fce67a-04c9-4be3-8dcb-889c5725861f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customer\":\"\", //Id do seller\n \"token\":\"\" //Id token gerado da conta\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/bank_accounts","urlObject":{"path":["bank_accounts"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"36fce67a-04c9-4be3-8dcb-889c5725861f"},{"name":"Remover detalhes de conta bancária","id":"56052c64-7e8f-41a1-a7f6-ea069f84ef63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.azape.co/bank_accounts/:bank_account_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["bank_accounts",":bank_account_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"dad00a3d-c70b-4c0d-bc4e-a244877a9a44","description":{"content":"

Id to token gerado da conta

\n","type":"text/plain"},"type":"any","value":"","key":"bank_account_id"}]}},"response":[],"_postman_id":"56052c64-7e8f-41a1-a7f6-ea069f84ef63"}],"id":"4af4886a-369e-4125-a1d5-08404aa7f1e9","description":"

Ao criar contas bancárias você poderá creditar sem ter que inserir repetidamente a informação. O recurso bank_account representa uma conta bancária e você só pode criar uma nova se tiver um token bancário seguro. A Azape usa tokenização para proteger contas bancárias, cartões e informações confidenciais de identificação pessoal (PII) para cumprir os padrões da indústria e os regulamentos governamentais.

O recurso da conta bancária

Atributos

id	string Código identificador único de uma conta bancária
resource	string Valor: bank_account
type	enum (checking, savings)
customer	string O identificador do vendedor (seller) ou de um comprador (buyer)
description	string Campo livre que contém dados adicionais da conta.
bank_name	string Nome do banco
bank_code	string O código do banco é atribuído pelo banco central para identificar um banco especificamente.
holder_name	string Nome do titular da conta
last4_digits	string Os últimos 4 dígitos da conta
is_active	boolean Indica se a conta está ou não ativada. Valor padrão: true
is_verified	boolean Indica se a conta foi ou não verificada durante a tokenização bancária.
fingerprint	string Todos os objetos \"bank_account\" possuem um atributo \"fingerprint\" que podem ser utilizados para identificar uma conta específica.
verification_setlist	object
postal_code_check	string Se o CEP for fornecido, os possíveis valores são: pass, fail ou unchecked
address_line1_check	string Se a linha 1 do endereço for fornecida, os resultados serão: pass, fail ou unchecked
metadata	optional {\"key\": \"value\"} or null Mapeamento de chaves (keys) de string e valores de caracteres. Key é o identificador para os metadados (máximo de 30 caracteres). value é a informação a ser armazenada como metadado.
created_at	string Data de criação no formato (yyyy-mm-ddThh:mm:ssZ)
updated_at	string Data de atualização no formato (yyyy-mm-ddThh:mm:ssZ)

","_postman_id":"4af4886a-369e-4125-a1d5-08404aa7f1e9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}},{"name":"Extrato","item":[{"name":"Listar extrato por seller","id":"c051f940-84f6-4ca9-95e1-a711220043f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/sellers/:seller_id/balances/history","urlObject":{"path":["sellers",":seller_id","balances","history"],"host":["https://api.azape.co"],"query":[],"variable":[{"type":"any","value":"","key":"seller_id"}]}},"response":[],"_postman_id":"c051f940-84f6-4ca9-95e1-a711220043f0"}],"id":"9c2063d1-e852-467d-8205-f974703d4064","_postman_id":"9c2063d1-e852-467d-8205-f974703d4064","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}}],"id":"02d36063-b51d-4ace-a83a-b3a97b1a9fd4","_postman_id":"02d36063-b51d-4ace-a83a-b3a97b1a9fd4","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}},{"name":"Planos e Assinaturas","item":[{"name":"Planos","item":[{"name":"Recupera um plano pelo ID","id":"e3dedd62-91bf-4403-bb4e-68a0a778a7c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/plans/:plan_id","urlObject":{"path":["plans",":plan_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"b9d1e364-bb57-46eb-9972-64822489728f","type":"any","value":"","key":"plan_id"}]}},"response":[],"_postman_id":"e3dedd62-91bf-4403-bb4e-68a0a778a7c3"},{"name":"Criar um plano","id":"530ca59a-ebc1-45cb-b558-f22ec416f224","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"frequency\": \"\", //Frequencia que o plano será cobrado [daily, monthly, weekly, annually]\n \"interval\": \"\", //Intervalo entre frequencia de cobrança\n \"payment_methods\": [\n \"\"\n ], //Métodos de pagamento utilizados [credit]\n \"amount\": \"\", //Valor plano em centavos. Ex. R$ 10,00 = 1000\n \"setup_amount\": \"\", //Valor do setup do plano em centavos\n \"description\": \"\", //Descrição do plano\n \"name\": \"\", //Nome do plano\n \"grace_period\": \"\", //Perído (dias) de carência para a primeira cobrança do plano\n \"tolerance_period\": \"\", //Perído de tolerancia caso haja falha de pagamento\n \"duration\": \"\" //Tempo de duração do plano em relação à frequencia escolhida\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/plans","urlObject":{"path":["plans"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"530ca59a-ebc1-45cb-b558-f22ec416f224"},{"name":"Alterar plano pelo identificador","id":"70a94301-1c93-48af-b5d7-b4f1d4ad6325","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"frequency\": \"\", //Frequencia que o plano será cobrado [daily, monthly, weekly, annually]\n \"interval\": \"\", //Intervalo entre frequencia de cobrança\n \"payment_methods\": [\n \"\"\n ], //Métodos de pagamento utilizados [credit]\n \"amount\": \"\", //Valor plano em centavos. Ex. R$ 10,00 = 1000\n \"setup_amount\": \"\", //Valor do setup do plano em centavos\n \"description\": \"\", //Descrição do plano\n \"name\": \"\", //Nome do plano\n \"grace_period\": \"\", //Perído (dias) de carência para a primeira cobrança do plano\n \"tolerance_period\": \"\", //Perído de tolerancia caso haja falha de pagamento\n \"duration\": \"\" //Tempo de duração do plano em relação à frequencia escolhida\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/plans/:plan_id","urlObject":{"path":["plans",":plan_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"7c5c7efe-2f56-4866-a3d7-7f2136846935","type":"any","value":"","key":"plan_id"}]}},"response":[],"_postman_id":"70a94301-1c93-48af-b5d7-b4f1d4ad6325"},{"name":"Deletar um plano pelo ID","id":"36a04b6a-3a25-464e-b644-e8e686d14cdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.azape.co/plans/:plan_id","urlObject":{"path":["plans",":plan_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"726c2fcc-16b3-4585-bd6f-f900c76acd53","type":"any","value":"","key":"plan_id"}]}},"response":[],"_postman_id":"36a04b6a-3a25-464e-b644-e8e686d14cdf"}],"id":"b2ff05b9-85d2-4c5b-961d-abaea7f0f9a2","description":"

Planos

Um plano define como assinaturas serão vendidas, renovadas e faturadas. Por exemplo, uma academia pode possuir um \"Plano mensal\" que é renovado automaticamente todo mês, ou um \"Plano bimestral\", renovado automaticamente a cada dois meses.

Na criação de planos é possível informar a frequência (frequency) de cobrança do plano, podendo ser diário, mensal, semanal ou anual, bem como o intervalo (interval) de cobrança com base na frequência definida, ou seja, caso a frequência seja mensal e o intervalo dois (02) a cobrança será feita a cada dois meses.

Planos são gerenciados por vendedor, sendo possível criar múltiplos planos com diferentes políticas de cobrança, cada qual com seu valor em centavos, formas de pagamentos permitidas, período de carência para primeira cobrança e prazo de tolerância em caso de atraso no pagamento.

Os planos são exclusivamente utilizado em assinaturas com cobrança via cartão de crédito, sendo impossível a criação e utilização de um plano com cobrança no boleto.

\n\n

Tipos de Eventos

Segue a lista de eventos enviados no fluxo de gestão de planos, assinaturas e faturas

Evento	Descrição
plan.created	ocorre quando um novo plano é criado
plan.deleted	ocorre quando um plano é removido
plan.updated	ocorre quando um plano é alterado

\n\n

Campos

Lista dos campos com os valores esperados

id	Valor
frequency - Obrigatório	String: Frequencia que o plano será cobrado: ['daily', 'monthly', 'weekly', 'annually']
interval - Obrigatório	int32: Intervalo entre frequencia de cobrança
amount - Obrigatório	int32: Um número inteiro positivo em centavos que representa o valor a ser cobrado na recorrencia, 'R$12,60' por '1260'
setup_amount	int32: Um número inteiro positivo em centavos que representa o valor a ser cobrado como valor inicial, 'R$12,60' por '1260'. Se não será cobrado não enviar.
description	String: Descrição do plano
name - Obrigatório	String: Nome do plano
grace_period	int32: Período (dias) de carência para a primeira cobrança do plano.
tolerance_period	int32: Período (dias) de tolerância caso haja falha de pagamento
duration	int32: Tempo de duração do plano em relação à frequência escolhida

","event":[{"listen":"prerequest","script":{"id":"a4b983c9-0662-4e7d-a812-2560c95406ad","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"36915309-df2c-4e0f-b4de-b5bf18fe0730","type":"text/javascript","exec":[""]}}],"_postman_id":"b2ff05b9-85d2-4c5b-961d-abaea7f0f9a2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}},{"name":"Assinaturas","item":[{"name":"Recupera uma assinatura pelo ID","id":"a5786b3d-6187-43cd-8931-d8cc0317a7b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/subscriptions/:subscription_id","urlObject":{"path":["subscriptions",":subscription_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"e0624e70-73e1-4bbb-9701-a4e1b18ff970","type":"any","value":"","key":"subscription_id"}]}},"response":[],"_postman_id":"a5786b3d-6187-43cd-8931-d8cc0317a7b0"},{"name":"Criar uma assinatura entre um comprador e um plano","id":"cb94f30b-2b2c-48aa-b187-78b77cbb9aaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"plan\": \"\", //Referência a um plano existente\n \"on_behalf_of\": \"\", //Referência a um vendedor existente\n \"customer\": \"\", //Referência a um comprador existente\n \"due_date\": \"\", //Data da próxima cobrança \"YYYY-MM-DD\"\n \"expiration_date\":\"\", //Data final da assinatura se houver \"YYYY-MM-DD\"\n \"amount\": \"\", //Valor em centavos. Ex. R$10,00 = 1000\n \"grace_period\": \"\", //Perído (dias) de carência para a primeira cobrança da assinatura\n \"tolerance_period\": \"\" //Perído de tolerancia caso haja falha de pagamento\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/subscriptions","urlObject":{"path":["subscriptions"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb94f30b-2b2c-48aa-b187-78b77cbb9aaa"},{"name":"Alterar os detalhes de uma assinatura pelo identificador","id":"224c9c8d-5bf7-4244-a74f-8406a83be5be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"plan\": \"\", //Referência a um plano existente\n \"on_behalf_of\": \"\", //Referência a um vendedor existente\n \"customer\": \"\", //Referência a um comprador existente\n \"due_date\": \"\", //Data da próxima cobrança \"YYYY-MM-DD\"\n \"expiration_date\":\"\", //Data final da assinatura se houver \"YYYY-MM-DD\"\n \"amount\": \"\", //Valor em centavos. Ex. R$10,00 = 1000\n \"grace_period\": \"\", //Perído (dias) de carência para a primeira cobrança da assinatura\n \"tolerance_period\": \"\" //Perído de tolerancia caso haja falha de pagamento\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/subscriptions/:subscription_id","urlObject":{"path":["subscriptions",":subscription_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"f000bac3-a2b1-4985-bb80-aa9f6ca53e02","type":"any","value":"","key":"subscription_id"}]}},"response":[],"_postman_id":"224c9c8d-5bf7-4244-a74f-8406a83be5be"},{"name":"Deletar uma assinatura pelo ID","id":"6c775467-7544-401e-96a2-dc70dc8d7490","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.azape.co/subscriptions/:subscription_id","urlObject":{"path":["subscriptions",":subscription_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"7da8303f-bda9-4213-8e45-356740a21342","type":"any","value":"","key":"subscription_id"}]}},"response":[],"_postman_id":"6c775467-7544-401e-96a2-dc70dc8d7490"}],"id":"5b576da9-8e6e-4120-b940-826366cf0fc2","description":"

Assinaturas

Assinaturas definem a relação entre um plano e um cliente, possuindo data de início e fim, representando um contrato com cobranças recorrentes baseadas nas regras estabelecidas entre o cliente e o parceiro, conforme plano vinculado.

Na criação de assinatura é obrigatório informar o plano associado, bem como o comprador, sendo possível configurar uma data de expiração (data para a primeira cobrança).

Dado que uma assinatura esteja vencida a cada período determinado, então é gerado automaticamente uma fatura para esta assinatura, sendo o estado da assinatura alterado para pending até que a fatura associada seja paga.

Cobrança automática de assinaturas pendentes de pagamento

Dado que uma fatura esteja pendente de pagamento, e o comprador associado possua como forma padrão de pagamento cartão de crédito então uma vez ao dia é feito uma tentativa de cobrança no cartão, sendo associada a transação criada a fatura existente, Caso a cobrança seja realizada com sucesso a fatura é alterada para o estado de paid, e caso exista uma assinatura vinculada a fatura ela é alterada para o estado de pago caso não exista mais nenhuma fatura pendente de pagamento, sendo disparado um evento de subscription.paid também na assinatura.

As assinaturas exclusivamente podem ser criadas com cobrança via cartão de crédito, sendo impossível a criação e utilização de uma assinaturas com cobrança no boleto.

Tipos de Eventos

Segue a lista de eventos enviados no fluxo de assinaturas

Evento	Descrição
subscription.created	ocorre quando uma nova assinatura é criada
subscription.updated	ocorre quando uma assinatura é alterada
subscription.expired	ocorre quando uma assinatura é expirada pela data de vencimento programada
subscription.active	ocorre quando uma assinatura é ativada, podendo ocorrer mais de uma vez por assinatura
subscription.paid	ocorre quando o pagamento de uma fatura gerada automaticamente para uma assinatura é paga
subscription.overdue	ocorre quando falha o pagamento de uma fatura gerada automaticamente para uma assinatura
subscription.deleted	ocorre quando uma assinatura é removida
subscription.suspended	ocorre quando uma assinatura é suspensa

\n\n

Campos

Lista dos campos com os valores esperados

id	Valor
plan - Obrigatório	String: Referência a um plano existente
on_behalf_of - Obrigatório	String: Id de referência a um vendedor existente (EC).
customer - Obrigatório	String: Id de referência a um comprador existente.
due_date - Obrigatório	String: Data da primeira cobrança. Formato: 'YYYY-MM-DD', '2020-10-25'
expiration_date	String: Data final da assinatura se existir. Formato: 'YYYY-MM-DD', '2020-10-25'
amount	int32: Um número inteiro positivo em centavos que representa o valor a ser cobrado como valor inicial, 'R$12,60' por '1260'.
grace_period	int32: Perído (dias) de carência para a primeira cobrança do plano.
tolerance_period	int32: Perído (dias) de tolerancia caso haja falha de pagamento

","event":[{"listen":"prerequest","script":{"id":"09f0cfbd-8cfc-4258-be03-2aa6765d7071","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"714e2d85-cad7-4191-8782-a5606c90b6b8","type":"text/javascript","exec":[""]}}],"_postman_id":"5b576da9-8e6e-4120-b940-826366cf0fc2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}},{"name":"Faturas","item":[{"name":"Recuperar os detalhes de uma fatura pelo ID","id":"60c336f9-4d98-4388-83b9-b680aac2f09c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.azape.co/invoices/:invoice_id","urlObject":{"path":["invoices",":invoice_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"6b364386-138e-433c-98e9-e7ed9d657c77","type":"any","value":"","key":"invoice_id"}]}},"response":[],"_postman_id":"60c336f9-4d98-4388-83b9-b680aac2f09c"},{"name":"Criar uma fatura avulsa","id":"1f860056-9c75-4cae-9ed6-f7707e0f0655","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"subscription\": \"\", //Referência a uma assinatura existente\n \"on_behalf_of\": \"\", //Referência a um vendedor existente\n \"customer\": \"\", //Referência a um comprador existente\n \"description\": \"\", //Descrição da fatura\n \"payment_method\": \"\", //Método de pagamento [credit, boleto]\n \"due_date\": \"\", //Data da próxima cobrança\n \"expiration_date\": \"\", //Data de vencimento cobrança\n \"amount\": \"\", //Valor em centavos. Ex. R$10,00 = 1000\n \"tolerance_period\": \"\", //Período de tolerância caso haja falha no pagamento\n \"max_retries\": \"\" //Quantidade máxima de vezes que se deve tentar efetuar o pagamento\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/invoices","description":"

A fatura totaliza, em valores financeiros, mercadorias ou serviços que serão cobrados do cliente. Uma conta telefônica é um exemplo de fatura que você pode relacionar com seu cotidiano. Uma fatura pode conter vários itens: \"Assinatura mensal\", \"Suporte técnico adicional\", \"Mensagens enviadas\", etc.\nFaturas podem existir independente de assinaturas e neste caso elas são chamadas de \"faturas avulsas\" e são ligadas diretamente ao cliente.

\n","urlObject":{"path":["invoices"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"1f860056-9c75-4cae-9ed6-f7707e0f0655"},{"name":"Estornar e reembolsar fatura","id":"963ca232-02ab-4be1-9501-c18f9dc24f26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.azape.co/invoices/:invoice_id/void","description":"

Estornar uma fatura paga, sendo feito o processamento do estorno da forma de cobrança associada ao pagamento da fatura;

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["invoices",":invoice_id","void"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"dde76152-f0e4-4130-aaa4-faebec770469","type":"any","value":"","key":"invoice_id"}]}},"response":[],"_postman_id":"963ca232-02ab-4be1-9501-c18f9dc24f26"},{"name":"Remover uma fatura pelo ID","id":"88ffc7be-45fb-4dd7-b72a-bacdbd2c4f74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.azape.co/invoices/:invoice_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["invoices",":invoice_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"ed373b17-bbe7-41b0-aec8-afa6f0e5cefc","type":"any","value":"","key":"invoice_id"}]}},"response":[],"_postman_id":"88ffc7be-45fb-4dd7-b72a-bacdbd2c4f74"}],"id":"4c715a85-56c7-4e7d-a5bc-1a49b764bddc","description":"

Faturas

\n\n

Uma fatura totaliza, em valores financeiros, mercadorias ou serviços que serão cobrados do cliente. Uma conta telefônica é um exemplo de fatura que você pode relacionar com seu cotidiano. Uma fatura pode conter vários itens: \"Assinatura mensal\", \"Suporte técnico adicional\", \"Mensagens enviadas\", etc.

📘 Faturas avulsas ou criadas automaticamente
Faturas podem ser criadas automaticamente pele estrutura de recorrência da Azape, com base nas regras de planos e assinaturas, ou então existir independente de assinaturas, neste caso elas são chamadas de \"faturas avulsas\" e são ligadas diretamente ao cliente.

Faturas avulsas são independentes de assinaturas e podem ser usadas para cobrar qualquer tipo de valor não recorrente, sendo possível configurar, política de retentativa, prazo de vencimento, comprador, formas de pagamento possíveis, url de retorno, pagamento pós vencimento com valor da multa diária

Suspensão de cobrança em caso de tentativas excedido

Dado que o número de retentativas de cobrança seja excedido para uma determinada fatura então a fatura é marcada automaticamente como expired pelo sistema, bem como a assinatura, não sendo feitas novas tentativas de cobrança na fatura ou na assinatura.

Política de retentativa de cobrança

É possível customizar a política de retentativa, incluindo dias prioritários para tentativa, bem como número de retentativas máximo por fatura.

Tipos de Eventos

Segue a lista de eventos enviados no fluxo de faturas.

Evento	Descrição
invoice.created	ocorre quando uma fatura avulsa ou automática, vinculada a uma assinatura, é criada
invoice.updated	ocorre quando uma fatura é alterada
invoice.paid	ocorre quando uma fatura é paga
invoice.canceled	ocorre quando uma fatura é cancelada
invoice.overdue	ocorre quando uma fatura esgota as tentativas de cobrança e é expirada por falta de pagamento
invoice.expired	ocorre quando uma fatura expira pela data de vencimento programada
invoice.refunded	ocorre quando uma fatura paga é estornada e o saldo devolvido ao comprador

","_postman_id":"4c715a85-56c7-4e7d-a5bc-1a49b764bddc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}}],"id":"6e48d7f1-418d-46b1-8157-c96e7be664c0","_postman_id":"6e48d7f1-418d-46b1-8157-c96e7be664c0","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}},{"name":"Notificações e Eventos","item":[{"name":"Webhook","item":[{"name":"Criar/atualizar webhook por marketplace","id":"852af4de-19c5-4d67-970d-0592877b6037","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"\", //URL do endpoint que ira receber o payload\n \"description\": \"\", //Descrição do Webhook\n \"event\": \"\" //Evento que será monitorado por esse Webhook [\"sellers\", \"transactions\", \"subscriptions\", \"receivables\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/webhook","description":"

Ao submeter um Webhook de um evento que já exista, ele automaticamente vai atualizar o Webhook anterior.

\n","urlObject":{"path":["webhook"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"852af4de-19c5-4d67-970d-0592877b6037"}],"id":"a5322ec2-dd44-4473-96e4-0bf2669d39b2","description":"

O recurso webhook

Webhook (callbacks) é uma forma de se registrar para receber informações úteis de uma URL específica de sua escolha. Você pode criar um webhook por evento!

Quando um evento desencadeia um webhook (por exemplo, uma transação foi aprovada com sucesso), tentaremos enviar essa notificação para a URL que foi especificada.

Caso seu sistema responda com um status code 200 será entendido que o evento foi recebido e não será enviado novamente, no entanto, pode acontecer de eventos serem disparados mais de uma vez, aconselhamos que realize um tratamento adequado em sua aplicação.

\n\n

Atributos

id	string Identificador exclusivo para este webhook
resource	string Value: webhook
url	string A URL ( pública ) para a qual os dados do evento serão postados. A carga útil dos dados Webhook é enviada como JSON no corpo de solicitação POST.
description	string Uma string arbitrária que você pode anexar a um objeto webhook
event	string Este é o tipo de evento que seu webhook estará monitorando. Você pode monitorar um evento por webhook. Os eventos disponíveis hoje são: [\"sellers\", \"transactions\", \"subscriptions\"]
createdAt	string W3C Datetime Format para a criação da data (yyyy-mm-ddThh:mm:ssZ)
updatedAt	string W3C Datetime Format para a última atualização (yyyy-mm-ddThh:mm:ssZ)

","_postman_id":"a5322ec2-dd44-4473-96e4-0bf2669d39b2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}}],"id":"4cc8d088-dbcb-4a2d-aa4f-8463d626da4d","_postman_id":"4cc8d088-dbcb-4a2d-aa4f-8463d626da4d","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","id":"235c44c5-70c2-47ab-a658-73ae9ddd1203","name":"AZ Pay","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"7e96f4e7-f4fa-4ac4-9c09-e78e8ffe6bcd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bd9c9096-66d3-4bf9-90c7-584bf3f030f0","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.azape.co"},{"key":"baseStagingUrl","value":"https://api.staging.azape.co"}]}