{"info":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","description":"

Introdução

A API AZ Pay segue os princípios de design REST: recursos orientados a URLs, verbos HTTP (POST, PUT, GET e DELETE) para leitura e escrita, códigos de status HTTP para indicar sucesso ou erro e autenticação por token bearer. Todas as respostas são em JSON, incluindo os erros.

Suportamos chamadas diretas a partir de outras origens (CORS), o que permite integrar aplicações web com segurança. Nesses casos, use sua chave pública no navegador e reserve a chave secreta para chamadas entre servidores.

\n\n

Ambientes

Sua conta possui chaves de acesso para dois ambientes. O ambiente de homologação é uma cópia do de produção, mas cartões e contas bancárias não são cobrados.

\n\n\n

Ambiente	URL base	Uso
Produção (LIVE)	`https://api.azape.co`	Cobranças reais
Homologação (TEST)	`https://api.azape.dev`	Desenvolvimento e testes, com os cartões de teste listados abaixo

🚧 Novos endereços a partir de 01/12/2026
A partir de 1º de dezembro de 2026 a API passa a responder também nos novos endereços, que se tornam os oficiais:
\n\n\n
Ambiente Nova URL base
Produção (LIVE) https://api.azpay.me
Homologação (TEST) https://api.staging.azpay.me
\n
Os endereços atuais continuam ativos durante o período de transição, e a data de desligamento será comunicada com pelo menos 90 dias de antecedência. Recomendamos parametrizar a URL base na sua integração para trocar de endereço sem alterar código. Nesta coleção, use as variáveis baseUrl e baseStagingUrl (endereços atuais) ou baseUrlNew e baseStagingUrlNew (novos endereços).

Ambiente	Nova URL base
Produção (LIVE)	`https://api.azpay.me`
Homologação (TEST)	`https://api.staging.azpay.me`

\n\n

Modalidades de contratação

Gateway: acesso parcial, com Compradores, Transações, Planos e Assinaturas.
Marketplace: acesso total. Tudo que o Gateway tem, mais Vendedores, Pagamentos, Transferências e Notificações.

\n\n

Autenticação

A autenticação usa token bearer. Sua chave de acesso é enviada pela equipe AZ Pay no e-mail de ativação da conta. Para uma nova chave, ou caso não tenha mais a sua, fale com o suporte.

Envie a chave no cabeçalho Authorization de toda requisição:

Authorization: Bearer <sua_chave>

Toda a comunicação deve ser feita por HTTPS. Requisições recebidas sem HTTPS são consideradas comprometidas e falham.

🚧 Primeiro uso
A primeira requisição ativa a sua chave. Se você receber HTTP 403 nos primeiros minutos, aguarde de 5 a 10 minutos e tente novamente. Se o problema persistir, escreva para api@azape.co.

❗️ Guarde suas chaves
Salve suas chaves de API em local seguro. Não compartilhe suas chaves com ninguém, nem mesmo nos canais de suporte da AZ Pay. Nenhum colaborador da AZ Pay está autorizado a pedir sua chave de API ou qualquer outro dado sensível.

\n\n

Testando

Para testar sua integração sem cartões reais, use o ambiente de homologação. Os números abaixo simulam transações aprovadas:

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)

Estes números \"mágicos\" geram respostas específicas, úteis para testar cenários de erro:

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\".

📘 Nota
Você pode usar qualquer holder_name, expiration_month, expiration_year e security_code nas transações digitadas. Não use esses números em produção.

\n\n\n

Limites de requisições

Para proteger a plataforma contra abuso, a API limita o volume de chamadas. Os limites atuais:

\n\n\n

Escopo	Limite	Janela
Todas as rotas, por endereço IP	300 requisições	1 minuto
Criação de compradores e vendedores (`POST /buyers`, `POST /sellers/individuals`, `POST /sellers/businesses`), por chave de acesso	30 requisições	1 hora

Ao exceder um limite, a API responde 429 Too Many Requests com o corpo abaixo e o cabeçalho RateLimit (RFC 9331 / draft-8) indicando quando a janela reinicia:

{ \"error\": true, \"message\": \"Too many requests, try again later.\" }

Trate o 429 com nova tentativa após o tempo informado no cabeçalho, com espera exponencial. Não crie o mesmo comprador ou vendedor repetidas vezes: consulte antes com GET /buyers/search ou GET /sellers/search/:cpf_cnpj.

\n\n

Validação de campos

Nas rotas de criação de compradores e vendedores, os campos abaixo são validados antes do processamento. Um valor presente e inválido retorna 400 Bad Request com { \"error\": true, \"message\": \"Invalid <campo>\" }.

\n\n\n\n\n

Campo	Regra
`taxpayer_id`	CPF (11 dígitos) ou CNPJ (14 dígitos) com dígitos verificadores válidos. Pontuação é aceita e ignorada.
`ein`	CNPJ com dígitos verificadores válidos (vendedor pessoa jurídica).
`email`, `business_email`	Formato de e-mail válido, até 254 caracteres.
`phone_number`, `business_phone`	Entre 10 e 13 dígitos, formato E.164 recomendado (`+5511999999999`).

O corpo das requisições JSON é limitado a 1 MB. O envio de documentos (multipart/form-data) aceita arquivos de até 3 MB.

\n\n

Códigos de status HTTP

Existem apenas três resultados possíveis na interação entre a sua aplicação e a API: tudo funcionou, a aplicação fez algo errado, ou a API fez algo errado. Códigos 2xx indicam sucesso, 4xx indicam erro nas informações enviadas (parâmetro obrigatório ausente, transação recusada) e 5xx indicam erro nos servidores da AZ Pay.

Os códigos mais comuns retornados pela API:

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 inválida 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.
413	Payload Too Large	O corpo da requisição excede 1 MB.
429	Too Many Requests	Limite de requisições excedido. Veja \"Limites de requisições\" e aguarde o tempo indicado no cabeçalho `RateLimit`.
500	Internal Server Error	Algo está quebrado. Por favor, assegure-se de que a equipe AZ Pay esteja investigando.
502	Bad Gateway	A AZ Pay caiu ou está sendo atualizada.

\n\n

Mensagens de erro

Quando uma requisição falha, a API retorna um código HTTP 4xx ou 5xx e um JSON com detalhes do erro, contendo:

status e status_code;
type e category, que você pode usar para tratar os erros na sua aplicação;
message, uma mensagem legível explicando o motivo.

Os valores possíveis para tipo e categoria:

Status Code	Tipo	Categoria	Descrição	Código da bandeira
500	processing_error	server_api_error	Ocorreu um erro de processamento na AZ Pay. 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

Para compatibilidade com novos códigos, interprete os intervalos: 200 a 299 como sucesso, 400 a 499 como erro do cliente e 500 a 599 como erro do servidor.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4126294","collectionId":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","publishedId":"2sBYB2qnBJ","public":true,"customColor":{"top-bar":"201F23","right-sidebar":"303030","highlight":"965EF4"},"publishDate":"2026-09-22T15:46:34.000Z"},"item":[{"name":"Cadastro e Credenciamento","item":[{"name":"Vendedor","item":[{"name":"Recuperar vendedor pelo ID","id":"64b0465e-7d0e-4b53-b3e4-78767fa17329","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/sellers/:seller_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["sellers",":seller_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"ed3c418b-3f1a-4837-a88c-af3543b44936","type":"any","value":"","key":"seller_id"}]}},"response":[],"_postman_id":"64b0465e-7d0e-4b53-b3e4-78767fa17329"},{"name":"Listar MCCs (categorias de negócio)","id":"8cd673cf-3d65-4f5e-9f63-310897cd380d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/sellers/mcc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["sellers","mcc"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"8cd673cf-3d65-4f5e-9f63-310897cd380d"},{"name":"Criar vendedor pessoa física (CPF)","id":"a058db6c-d7d4-4d21-8893-2a819757db03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"revenue\": \"\", //Faturamento mensal estimado, em centavos\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/sellers/individuals","description":"

Campos de documento, e-mail e telefone são validados (400 Invalid <campo>). Limite de 30 criações por hora por chave (429).

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["sellers","individuals"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"a058db6c-d7d4-4d21-8893-2a819757db03"},{"name":"Alterar vendedor pessoa física (CPF)","id":"fb8288c3-cbd8-4126-94d1-57c1d5d807a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["sellers","individuals",":seller_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"6320647b-2758-468f-ac21-ea15958e28f8","type":"any","value":"","key":"seller_id"}]}},"response":[],"_postman_id":"fb8288c3-cbd8-4126-94d1-57c1d5d807a8"},{"name":"Criar vendedor pessoa jurídica (CNPJ)","id":"851eabec-fa2b-416d-8b39-6c91e69541e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 \"revenue\": \"\", //Faturamento mensal estimado, em centavos\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/sellers/businesses","description":"

Campos de documento, e-mail e telefone são validados (400 Invalid <campo>). Limite de 30 criações por hora por chave (429).

Arquivo do documento. Imagem (PNG, JPEG, BMP, WebP, HEIC, HEIF) ou PDF (apenas CNH_FULL). Tamanho máximo: 3 MB

\n","value":null},{"key":"document_type","type":"text","value":"SELFIE","description":"

Tipo do documento: SELFIE, CNH_FULL, CNH_FRONT, CNH_BACK, RG_FRONT ou RG_BACK

\n"}]},"url":"https://api.azape.co/sellers/:seller_id/documents","description":"

Envie um documento por requisição, como multipart/form-data com dois campos: file (o arquivo) e document_type (o tipo). Repita a chamada para cada documento.

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

\n\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

Retornos:

200: documento recebido e encaminhado para análise.
400 com { \"error\": true, \"message\": \"...\" }: arquivo ausente, formato não suportado, acima de 3 MB, document_type inválido ou formato não permitido para o tipo informado.

O resultado da análise pode ser acompanhado em Consultar status de credenciamento do vendedor (GET /sellers/:seller_id/status). Se o cadastro for negado por inconsistência cadastral (por exemplo, nome divergente do CPF), corrija os dados do vendedor e reenvie os documentos para uma nova análise.

Retorna o status atual do vendedor e o andamento de cada etapa do credenciamento (KYC), incluindo o motivo quando alguma etapa é negada. Use este endpoint para acompanhar o resultado após o cadastro e o envio dos documentos, e para saber se cabe uma nova tentativa.

Atributos da resposta

seller_id	Identificador do vendedor.
status	Status geral do vendedor: pending, enabled, denied ou disabled.
onboarding_steps	Lista das etapas do credenciamento.
	step_type ONBOARDING_INITIALIZATION, BANK_ACCOUNT, IDENTITY_DOCUMENT, SELFIE ou RISK_ASSESSMENT (análise de risco).
	status PENDING, PENDING_EVALUATION, COMPLETED, SKIPPED ou REJECTED.
	rejection_reason Texto do motivo, presente apenas quando a etapa foi rejeitada.
	metadata Detalhes da análise. Em `decision_reasons`, cada item traz `reason` (motivo), `detail` (detalhe) e `retry` (`true` quando cabe nova tentativa após corrigir o cadastro e reenviar os documentos).
	created_at / updated_at Datas no formato yyyy-mm-ddThh:mm:ss

Motivos mais comuns em RISK_ASSESSMENT

REGISTRATION_INCONSISTENCY / NAME_INVALID: o nome cadastrado diverge do nome vinculado ao CPF ou CNPJ. Corrija o cadastro do vendedor (first_name e last_name exatamente como na Receita Federal) e reenvie os documentos.
INTERNAL_KYC_POLICY: negado por política interna de análise (retry: false). Não há nova análise pela API.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["sellers",":seller_id","status"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"8f07c77f-7437-469a-8877-1155fd7b6575","type":"any","value":"","key":"seller_id"}]}},"response":[{"id":"44dde186-149c-4c9d-8677-ca231e6375ab","name":"Vendedor negado na análise de risco","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.azape.co/sellers/:seller_id/status","host":["https://api.azape.co"],"path":["sellers",":seller_id","status"],"variable":[{"key":"seller_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"seller_id\": \"\",\n \"status\": \"denied\",\n \"onboarding_steps\": [\n {\n \"step_type\": \"ONBOARDING_INITIALIZATION\",\n \"status\": \"COMPLETED\",\n \"created_at\": \"2026-09-01T17:30:55\",\n \"updated_at\": \"2026-09-01T17:30:55\"\n },\n {\n \"step_type\": \"BANK_ACCOUNT\",\n \"status\": \"COMPLETED\",\n \"created_at\": \"2026-09-01T17:30:55\",\n \"updated_at\": \"2026-09-01T17:30:57\"\n },\n {\n \"step_type\": \"IDENTITY_DOCUMENT\",\n \"status\": \"COMPLETED\",\n \"created_at\": \"2026-09-01T17:30:55\",\n \"updated_at\": \"2026-09-18T16:46:43\"\n },\n {\n \"step_type\": \"SELFIE\",\n \"status\": \"COMPLETED\",\n \"created_at\": \"2026-09-01T17:30:55\",\n \"updated_at\": \"2026-09-18T16:46:42\"\n },\n {\n \"step_type\": \"RISK_ASSESSMENT\",\n \"status\": \"REJECTED\",\n \"rejection_reason\": \"Rejected by antifraud evaluation\",\n \"metadata\": {\n \"reason_codes\": [\n \"REGISTRATION_INCONSISTENCY\"\n ],\n \"decision_reasons\": [\n {\n \"reason\": \"REGISTRATION_INCONSISTENCY\",\n \"detail\": \"NAME_INVALID\",\n \"retry\": true\n }\n ]\n },\n \"created_at\": \"2026-09-18T16:46:43\",\n \"updated_at\": \"2026-09-18T16:48:51\"\n }\n ]\n}"}],"_postman_id":"9856249a-5e60-463f-b3b6-f2b1259c15d5"},{"name":"Remover vendedor pelo ID","id":"fd535963-ef61-4a94-8543-1731763643b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.azape.co/sellers/:seller_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["sellers",":seller_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"41c20a82-b2eb-4125-9126-3539632e1485","type":"any","value":"","key":"seller_id"}]}},"response":[],"_postman_id":"fd535963-ef61-4a94-8543-1731763643b6"},{"name":"Buscar vendedor por CPF/CNPJ","id":"a178edc8-9455-4a10-8377-092f552e1b6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/sellers/search/:cpf_cnpj","description":"

Busca um vendedor pelo CPF ou CNPJ, apenas números. Retorna o objeto vendedor ou 404 se não houver cadastro.

Define quando o saldo do vendedor é transferido automaticamente para a conta bancária cadastrada. Disponível apenas para contas Marketplace.

Os vendedores representam pessoas (PF) ou empresas (PJ). Cada vendedor pode ter cartões, contas bancárias, transações, reembolsos e transferências vinculados a ele.

\n\n

Antes de habilitar um vendedor a receber pagamentos, a AZ Pay executa o processo de KYC (\"conheça o seu cliente\"), exigido pela regulação, para liberar o processamento de cartões em produção e o envio de fundos para a conta bancária.
Por isso, envie o cadastro o mais completo possível.

\n\n

Passo a Passo

Para usar o credenciamento da AZ Pay, siga estes passos:

Cadastro → Envie os dados do vendedor via API.
\n
Documentação → Envie os documentos de identificação via API.
\n
Conta bancária → Tokenize e associe a conta do vendedor.
\n
Análise → Aguarde a aprovação. Acompanhe pelo GET /sellers/:seller_id/status.
\n
Pronto! → Vendedor habilitado e pronto para vender.
\n

\n
❗️ Envio de Documento e Selfie Para maior segurança e conformidade regulatória, o credenciamento exige o envio de documento (RG ou CNH) e selfie do vendedor.
\n

🚧 Prazo de habilitação
A análise de credenciamento de novos vendedores leva até 3 minutos em 99% dos casos.
Casos de exceção, como empresas S/A ou LTDAs com uma S/A na cadeia societária, levam até 3 dias úteis.
O resultado da verificação é enviado pelo webhook do evento sellers.

\n\n

Implementando o credenciamento

\n\n

Permite cadastrar um vendedor (seller) no marketplace informando seus dados bancários de mesma titularidade. Com essas informações a AZ Pay começa a realizar as devidas verificações para habilitar ou não o seller.

\n\n

Fluxo detalhado

\n\n

Para usar o credenciamento da AZ Pay, siga estes passos:

\n\n

Cadastre o vendedor via API, tokenize uma conta bancária de mesma titularidade e associe ao vendedor, e envie selfie e documento.
O cadastro é avaliado e pode ser aprovado ou negado pela AZ Pay.

\n\n

A AZ Pay cuida da parte burocrática: verificação do vendedor (KYC), saques para a conta bancária e segurança. Você tem acesso a todas as informações da conta, como histórico de pagamentos, saldo e notificações, e pode se concentrar na experiência do seu usuário.

\n\n

Fluxo de status

\n\n

pending (Pendente) - As informações do vendedor foram recebidas e estão em análise.
enabled (Habilitado) - As informações do vendedor foram validadas e ele já pode transacionar.
active (Ativo) - O cadastro do vendedor na AZ Pay está completo.
denied (Negado) - O cadastro do vendedor não foi aprovado. O vendedor não pode ser titular de transações, mas pode receber split se possuir conta bancária ativa (veja \"Regra de Divisão - Split\"). Consulte o motivo em Consultar status de credenciamento do vendedor (GET /sellers/:seller_id/status); em caso de dúvida, entre em contato com api@azape.co.
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	Valor: seller
taxpayer_id	CPF do vendedor pessoa física.
type	(individual, business)
description	Texto livre que você pode anexar ao vendedor
first_name	Contém o primeiro nome do vendedor
last_name	Contém o sobrenome do vendedor
email	E-mail do 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 Vendedor
address
	line1 Logradouro.
	line2 Número do endereço.
	line3 Complemento (apartamento, sala, bloco).
	neighborhood Bairro.
	city Cidade.
	state UF (sigla do estado)
	postal_code CEP, apenas números
created_at	Data de criação no formato yyyy-mm-ddThh:mm:ssZ
updated_at	Data da última atualização no formato 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 e estão em análise.
enabled (Habilitado) - As informações do vendedor foram verificadas e validadas
com sucesso. O vendedor pode transacionar.
active (Ativo) - O cadastro do vendedor na AZ Pay está completo.
deleted (Excluído) - O cadastro do vendedor foi excluído.
expired (Expirado) - O cadastro expira se permanecer em \"new\" por mais de 30 minutos.

🚧 Validação e limites
taxpayer_id (CPF), ein (CNPJ), email/business_email e phone_number/business_phone são validados antes do processamento; valores inválidos retornam 400 com { \"error\": true, \"message\": \"Invalid <campo>\" }. A criação é limitada a 30 requisições por hora por chave de acesso; acima disso a API responde 429. Consulte antes de criar para evitar duplicidade. Detalhes em \"Limites de requisições\" e \"Validação de campos\" na Introdução.

","_postman_id":"3f7d4cb7-0a29-42a3-b86c-9f9e6cba689a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}},{"name":"Comprador","item":[{"name":"Recuperar comprador pelo ID","id":"975b8c64-4d03-43e4-8781-c2f297f1b2ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/buyers/:buyer_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["buyers",":buyer_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"514c3ce3-f7ef-4925-9387-b4c08b978eda","type":"any","value":"","key":"buyer_id"}]}},"response":[],"_postman_id":"975b8c64-4d03-43e4-8781-c2f297f1b2ad"},{"name":"Buscar comprador por CPF/CNPJ","id":"bb63992b-3c2c-4e9c-bb94-9c2bef7035eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/buyers/search?taxpayer_id=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["buyers","search"],"host":["https://api.azape.co"],"query":[{"key":"taxpayer_id","value":""}],"variable":[]}},"response":[],"_postman_id":"bb63992b-3c2c-4e9c-bb94-9c2bef7035eb"},{"name":"Criar comprador","id":"c632d3ed-8136-4d6c-8dd9-518fa87b3d63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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","description":"

Campos de documento, e-mail e telefone são validados (400 Invalid <campo>). Limite de 30 criações por hora por chave (429).

Comprador

Os clientes da AZ Pay têm dois papéis: o comprador (quem paga) e o vendedor (quem recebe). Nesta seção, falamos do objeto comprador (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	Sobrenome do comprador
taxpayer_id	CPF ou CNPJ do comprador
email	E-mail 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 no formato yyyy-mm-ddThh:mm:ssZ
updated_at	Data da última atualização no formato yyyy-mm-ddThh:mm:ssZ

🚧 Validação e limites
taxpayer_id (CPF/CNPJ com dígitos verificadores), email e phone_number são validados antes do processamento; valores inválidos retornam 400 com { \"error\": true, \"message\": \"Invalid <campo>\" }. A criação é limitada a 30 requisições por hora por chave de acesso; acima disso a API responde 429. Consulte antes de criar para evitar duplicidade. Detalhes em \"Limites de requisições\" e \"Validação de campos\" na Introdução.

","_postman_id":"94ae0501-684b-4a0e-a80b-77bb9cc40686","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}},{"name":"Token","item":[{"name":"Recuperar token de cartão ou conta bancária","id":"f0462074-d35f-41fb-b814-095183b0d589","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/tokens/:token_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["tokens",":token_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"7f4ff0f1-150a-4579-b896-1d75e026f5c0","type":"any","value":"","key":"token_id"}]}},"response":[],"_postman_id":"f0462074-d35f-41fb-b814-095183b0d589"},{"name":"Criar token de cartão","id":"e021dab3-5b46-4ab8-9714-443d742e2024","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["cards","tokens"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"e021dab3-5b46-4ab8-9714-443d742e2024"},{"name":"Criar token de conta bancária","id":"8b930d32-cf8f-4666-ae02-0ce3c940ab22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["bank_accounts","tokens"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"8b930d32-cf8f-4666-ae02-0ce3c940ab22"}],"id":"31c1877b-1b5f-45cc-a3da-2e9f6e7d7a61","description":"

Token

\n\n

A AZ Pay possui a funcionalidade de tokenização, que é o ato de usar um valor substituto (token), sem 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 múltiplas 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 no formato yyyy-mm-ddThh:mm:ssZ
updated_at	Data da última atualização no formato yyyy-mm-ddThh:mm:ssZ

","_postman_id":"31c1877b-1b5f-45cc-a3da-2e9f6e7d7a61","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}}],"id":"47a74e3a-4d76-4545-a358-3a037b64d726","description":"

Os objetos base são as informações de compradores, vendedores e tokens necessárias para efetivar qualquer transação.

","_postman_id":"47a74e3a-4d76-4545-a358-3a037b64d726","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}},{"name":"Transações e Recebíveis","item":[{"name":"Transação","item":[{"name":"Recuperar transação pelo ID","id":"979dc6fb-8a52-4dd1-aebd-b8bae55f01c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/transactions/:transaction_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["transactions",":transaction_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"1679a025-2ec4-4a5e-940e-18264d966202","type":"any","value":"","key":"transaction_id"}]}},"response":[],"_postman_id":"979dc6fb-8a52-4dd1-aebd-b8bae55f01c3"},{"name":"Criar transação com pré-autorização (cartão)","id":"357d954f-62ab-4ec5-b2f6-9ccb417ecc06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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. Se informado, substitui o nome do cadastro do vendedor.\n \"customer\": \"\", //ID do comprador que será cobrado\n \"token\": \"\", //Token do cartão gerado em POST /cards/tokens. Opcional: sem ele, é cobrado o cartão padrão do comprador\n \"antifraud\": { //Opcional. Informações do pedido para análise de risco\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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["transactions","card"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"357d954f-62ab-4ec5-b2f6-9ccb417ecc06"},{"name":"Capturar transação pré-autorizada (cartão)","id":"51534ef3-bd66-4045-b661-a612efe7eb77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["transactions",":transaction_id","capture"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"20640594-1eda-4e26-b06a-54589fe22407","type":"any","value":"","key":"transaction_id"}]}},"response":[],"_postman_id":"51534ef3-bd66-4045-b661-a612efe7eb77"},{"name":"Criar transação com captura direta (cartão)","id":"2056a3e1-970a-40d3-bb28-6fd1bddfcb0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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. Se informado, substitui o nome do cadastro do vendedor.\n \"customer\": \"\", //ID do comprador que será cobrado\n \"token\": \"\", //Token do cartão gerado em POST /cards/tokens. Opcional: sem ele, é cobrado o cartão padrão do comprador\n \"split_rules\": [ //Opcional. Regras de divisão do valor entre vendedores\n {\n \"recipient\": \"\", //ID do vendedor que recebe a parte\n \"amount\": \"\", //Valor em centavos (ou use \"percentage\")\n \"percentage\": \"\", //Percentual do valor (ou use \"amount\")\n \"liable\": \"\", //Se o recebedor responde por estornos e chargebacks\n \"charge_processing_fee\": \"\" //Se o recebedor paga a taxa de processamento\n }\n ],\n \"antifraud\": { //Opcional. Informações do pedido para análise de risco\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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["transactions","full"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"2056a3e1-970a-40d3-bb28-6fd1bddfcb0a"},{"name":"Criar transação Boleto","id":"f827690a-259c-40de-be4b-49ecb3f8d789","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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\": \"\", //ID do vendedor responsável pela venda\n \"customer\": \"\", //ID do comprador que será cobrado. Ele precisa ter endereço completo no cadastro\n \"logo\": \"\", //Opcional. URL do logotipo exibido no boleto\n \"split_rules\": [ //Opcional. Regras de divisão do valor entre vendedores\n {\n \"recipient\": \"\", //ID do vendedor que recebe a parte\n \"amount\": \"\", //Valor em centavos (ou use \"percentage\")\n \"percentage\": \"\", //Percentual do valor (ou use \"amount\")\n \"liable\": \"\", //Se o recebedor responde por estornos e chargebacks\n \"charge_processing_fee\": \"\" //Se o recebedor paga a taxa de processamento\n }\n ],\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":"

O boleto pode ser cancelado pelo endpoint POST /transactions/:transaction_id/boleto/cancel. Se não for pago, ele expira automaticamente em até 60 dias a contar da emissão.

Criando uma transação Pix online

O Pix é o meio de pagamento instantâneo brasileiro, de integração simples, que agiliza a transação entre compradores 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, a transação passa por diferentes estados conforme as atualizações recebidas.

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: A transação permanece pendente até o pagamento ser identificado ou o QR Code expirar.

succeeded: O pagamento do Pix foi identificado pela AZ Pay.

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 é usado quando o Pix não é pago dentro da 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\"

Lista as transações de um vendedor, com paginação e filtros por período, meio de pagamento, ID da transação e comprador.

Quantidade de registros por página (padrão 100)

\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"

Deslocamento para paginação

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

Ordenação: time-descending ou time-ascending

\n","type":"text/plain"},"key":"sort","value":"time-descending"},{"description":{"content":"

Data inicial no formato YYYY-MM-DD

\n","type":"text/plain"},"key":"date_range_gte","value":""},{"description":{"content":"

Data final no formato YYYY-MM-DD

\n","type":"text/plain"},"key":"date_range_lte","value":""},{"description":{"content":"

credit, boleto ou pix

\n","type":"text/plain"},"key":"payment_type_filter","value":""},{"description":{"content":"

Filtra por ID da transação

\n","type":"text/plain"},"key":"transaction_id_filter","value":""},{"description":{"content":"

Filtra por ID do comprador

\n","type":"text/plain"},"key":"customer_filter","value":""}],"variable":[{"id":"f183f80f-0157-4eef-9309-43f924090b26","type":"any","value":"","key":"seller_id"}]}},"response":[],"_postman_id":"9f709b30-789a-4086-adf2-008ffbc833c8"},{"name":"Recuperar transação pelo NSU","id":"b4e35863-33d4-487c-a880-3a11d3a83e38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/transactions/nsu/:nsu_id","description":"

Localiza uma transação de cartão pelo NSU (número sequencial único) retornado pela adquirente.

Adiciona ou substitui os metadados de uma transação. Use para guardar referências do seu sistema, como número do pedido.

Transação

\n\n

Quando o cliente informa o número do cartão sem apresentar o cartão físico, a compra é uma transação de cartão não presente (CNP), típica de internet e call center.

\n\n

O recurso de transação é usado para cobrar um cartão, gerar um boleto ou um Pix. Ele retorna um identificador que pode ser usado depois para estorno integral ou parcial. Você precisa de um comprador cadastrado e, para cartão, de um token de cartão ou de um cartão já associado ao comprador.

\n\n

O cartão pode ser informado como um token ainda não usado ou como um cartão já associado ao comprador. Para capturar uma pré-autorização, use o ID da transação pré-autorizada.

\n\n

O recurso da transação

\n\n

Atributos

\n\n

ID	Valor Identificador exclusivo para esta transação
resource	Valor: transaction
status	(new, pending, pre_authorized, succeeded, failed, reversed, canceled, refunded, dispute, charged_back) Estado atual da transação. Por exemplo, refunded significa que o valor foi totalmente reembolsado.
amount	> 0 Valor em centavos, ex.: \"1260\" para R$ 12,60.
original_amount	> 0 Valor em centavos
currency	Código da moeda no formato ISO 4217 (3 letras)
description	Texto livre que você pode anexar à 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, pix) Meio de pagamento da transação.
transaction_number	Número da transação exibido nos recibos enviados por e-mail.
refunds	Lista de reembolsos ou 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	Identificador do vendedor (pessoa física ou jurídica) dono da transação.
customer	Identificador do comprador cobrado na transação.
statement_descriptor	Nome que aparece na fatura do cartão do comprador. Ajuda o cliente a reconhecer a compra e reduz disputas.
payment_method	Um método de pagamento válido (cartão ou conta bancária).
installment_plan	Parcelamento em até 12 vezes no cartão de crédito, com ou sem juros.
mode	(interest_free, with_interest) Tipo de parcelamento. Em interest_free (sem juros) o vendedor recebe no mesmo número de parcelas. Em with_interest (com juros) os juros são aplicados ao preço, o comprador paga em parcelas e o vendedor recebe o valor total de uma vez.
number_installments	Número de parcelas acordado com o comprador no momento da compra.
fees	> 0 Valor em centavos com a taxa total aplicada à transação.
fee_details
currency	string Código da moeda no formato ISO 4217 (3 letras)
location_latitude	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) Estimativa, retornada na criação da transação, de quando o dinheiro estará disponível.
created_at	Data de criação no formato yyyy-mm-ddThh:mm:ssZ
updated_at	Data da última atualização no formato 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) - Criada por POST /transactions/card. A pré-autorização reserva o valor e precisa ser capturada com POST /transactions/:transaction_id/capture em até sete dias, ou expira automaticamente.
Sucesso (succeeded) - O pagamento foi autorizado e os fundos estarão disponíveis em depósito.
Falhou (failed) - A transação falhou.
Revertido (reversed) - Uma reversão ocorre antes que a transação tenha sido confirmada.
Cancelado (canceled) - O pagamento foi cancelado ou estornado pelo vendedor ou pela aplicação. As taxas cobradas também são anuladas.
Reembolsado (refunded) - A diferença entre estorno (void) e reembolso (refund) é se a transação já foi liquidada. Uma transação ainda não liquidada pode ser estornada; depois de liquidada, só pode ser reembolsada.
Disputa (dispute) - O titular do cartão contestou a transação junto ao banco emissor, que abre uma disputa com o vendedor e solicita a documentação de comprovação. Se a documentação for aceita, a disputa é recusada e a transação segue válida. Se não for, o valor é devolvido ao comprador e debitado do vendedor.
charged_back - O comprador contestou a compra e o valor 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 à AZ Pay que esta transação foi contestada pelo comprador;
A AZ Pay 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 AZ Pay 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 AZ Pay é 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íveis pendentes de pagamento;
Caso o retorno seja favorável ao comprador, ou a AZ Pay 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\"

","_postman_id":"81c56aea-82f0-4223-adc0-9d7bd6d7a7f2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}},{"name":"Cartão","item":[{"name":"Associar cartão ao comprador","id":"460dce20-e674-43b7-b8da-cd77d097c48f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["cards"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"460dce20-e674-43b7-b8da-cd77d097c48f"}],"id":"341a566d-d56f-4d97-8426-edb955c3bb2e","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 AZ Pay 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	Valor: card
description	Texto livre para descrever o cartão
first4_digits	Primeiros 4 dígitos do cartão
card_brand	Bandeira do cartão. Pode ser Visa, American Express, MasterCard, Discover, JCB, Diners Club ou 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	Identificador do vendedor (seller) ou do comprador (buyer) dono do cartão
is_active	Indica se o cartão está ativo (true) ou foi desativado (false). Valor padrão: true
is_verified	Indica se o cartão foi verificado durante a tokenização (por exemplo, se o código de segurança confere). Recomendamos não processar transações com cartões que falhem nessa verificação.
fingerprint	Impressão digital do cartão. Identifica de forma exclusiva um mesmo número de cartão entre tokens diferentes
verification_checklist
postal_code_check	Se o CEP foi informado, resultado da verificação: pass, fail ou unchecked
security_code_check	Se o código de segurança foi informado, resultado da verificação:pass, fail, ou unchecked
address_line1_check	Se o endereço (line1) foi informado, resultado da verificação: pass, fail, ou unchecked
created_at	Data de criação no formato yyyy-mm-ddThh:mm:ssZ
updated_at	Data da última atualização no formato yyyy-mm-ddThh:mm:ssZ

","_postman_id":"341a566d-d56f-4d97-8426-edb955c3bb2e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}},{"name":"Boleto","item":[{"name":"Cancelar boleto","id":"6d45986d-ffa5-4fab-ac6b-88c5a93a3574","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.azape.co/transactions/:transaction_id/boleto/cancel","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["transactions",":transaction_id","boleto","cancel"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"99b5b199-d3b8-4d7b-9e39-23589604772f","type":"any","value":"","key":"transaction_id"}]}},"response":[],"_postman_id":"6d45986d-ffa5-4fab-ac6b-88c5a93a3574"}],"id":"72065995-7e7d-4d07-8590-5cfc1fdc8df2","description":"

Boletos são criados por POST /transactions/boleto e consultados por GET /transactions/:transaction_id, que retorna a URL e a linha digitável em payment_method.

","_postman_id":"72065995-7e7d-4d07-8590-5cfc1fdc8df2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}},{"name":"Regra de Divisão - Split","item":[{"name":"Recuperar regra de divisão da transação","id":"1a9a85d8-cf57-4c90-a317-9e4b4f0b7802","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/transactions/:transaction_id/split_rules/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["transactions",":transaction_id","split_rules",":id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"f621d0ad-3b20-44c8-858c-985397c85a20","type":"any","value":"","key":"transaction_id"},{"id":"1d254333-ccba-4ee8-8b4f-032267c59683","type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"1a9a85d8-cf57-4c90-a317-9e4b4f0b7802"},{"name":"Criar regra de divisão na transação","id":"93c2667c-515c-42b7-9c53-77ed864dc82d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"recipient\": \"\", //Identificador do seller recebedor\n \"liable\": \"\", //Se o recebedor responde por estornos e chargebacks\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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["transactions",":transaction_id","split_rules"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"81ab011e-5453-4921-be98-bec538f8f662","type":"any","value":"","key":"transaction_id"}]}},"response":[],"_postman_id":"93c2667c-515c-42b7-9c53-77ed864dc82d"},{"name":"Alterar regra de divisão da transação","id":"907bca32-ecca-47c4-bf22-7745405cbad6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["transactions",":transaction_id","split_rules",":id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"50d65a39-0767-437b-9ba6-e99e15a8430c","type":"any","value":"","key":"transaction_id"},{"id":"48c58ce3-8f82-419c-b645-318ce6625550","type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"907bca32-ecca-47c4-bf22-7745405cbad6"},{"name":"Remover regra de divisão da transação","id":"b7091492-95fd-40d3-b2cb-12d744fc0e21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.azape.co/transactions/:transaction_id/split_rules/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["transactions",":transaction_id","split_rules",":id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"7ad4ee34-12c9-4a20-8797-9ac7d7ae216d","type":"any","value":"","key":"transaction_id"},{"id":"126e8902-a41c-4c5c-b9b8-dbcf8ac1b570","type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"b7091492-95fd-40d3-b2cb-12d744fc0e21"}],"id":"51b228b4-fd46-4e83-ac16-ead88d8b7860","description":"

Regras de divisão (split) definem como o valor de uma transação é repartido entre vendedores. Cada regra indica o recebedor, o valor fixo ou percentual, quem responde por estornos (liable) e quem paga a taxa de processamento (charge_processing_fee). As regras podem ser enviadas na criação da transação, no campo split_rules, ou gerenciadas depois por estes endpoints.

📘 Split e status de credenciamento do recebedor
O status de credenciamento (KYC) do recebedor não é validado na criação da regra de split nem na liquidação. O repasse ao recebedor ocorre quando a transação está paga, o recebedor existe no marketplace e possui conta bancária ativa de mesma titularidade. O status de credenciamento governa apenas a capacidade de o vendedor ser titular de transações (on_behalf_of): um vendedor não habilitado pode receber split, mas não pode originar cobranças próprias. Cabe ao marketplace decidir para quais vendedores direciona o split; o status de cada vendedor pode ser consultado em Consultar status de credenciamento do vendedor (GET /sellers/:seller_id/status).

","_postman_id":"51b228b4-fd46-4e83-ac16-ead88d8b7860","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}},{"name":"Recebíveis","item":[{"name":"Listar recebíveis da transação","id":"b21394b0-0e1c-4daf-bcab-833810293805","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/transactions/:transaction_id/receivables","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["transactions",":transaction_id","receivables"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"d8730293-57d3-4285-acb6-22929225edc0","type":"any","value":"","key":"transaction_id"}]}},"response":[],"_postman_id":"b21394b0-0e1c-4daf-bcab-833810293805"},{"name":"Listar recebíveis do vendedor","id":"0ea9e7f5-be4a-41da-bc9a-5dc4fe98bda8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/sellers/:seller_id/receivables","description":"

Lista os recebíveis do vendedor com o status de cada parcela e a data prevista de crédito no saldo.

Lista os recebíveis do vendedor filtrados pela data prevista de crédito, com totais do período.

Quantidade de registros por página (padrão 100)

\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"

Deslocamento para paginação

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

Ordenação: time-descending ou time-ascending

\n","type":"text/plain"},"key":"sort","value":"time-descending"},{"description":{"content":"

Data inicial no formato YYYY-MM-DD

\n","type":"text/plain"},"key":"date_range_gte","value":""},{"description":{"content":"

Data final no formato YYYY-MM-DD

\n","type":"text/plain"},"key":"date_range_lte","value":""}],"variable":[{"id":"2f9fec89-7eb3-49f2-94c7-3e715cef7adc","type":"any","value":"","key":"seller_id"}]}},"response":[],"_postman_id":"afef778a-f346-408f-a95e-c9e426525778"},{"name":"Simular antecipação de recebíveis","id":"9ff9fb44-8978-4516-b4f0-9ab5130e89ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"receivables\": [ //IDs dos recebíveis que se deseja antecipar\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/sellers/:seller_id/anticipate","description":"

Simula a antecipação dos recebíveis informados e retorna o valor líquido e a taxa. Nada é debitado nesta etapa.

Confirma a antecipação simulada. O valor líquido é creditado no saldo do vendedor.

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`	((pending, paid, canceled, refunded)) Indica o status atual deste recebível, por exemplo, pago significa que o dinheiro é creditado com sucesso no saldo do vendedor.
recipient `string`	Identificador do vendedor que recebe o valor.
transaction `string`	Identificador da transação que originou o recebível.
split_rule `string`	Identificador da regra de divisão (split_rule) que originou o recebível.
amount `integer`	>0(maior que zero) Valor em centavos que representam a quantidade líquida a receber, ex.: \"1260\" para R$ 12,60
liable `boolean`	Indica se o recebível é debitado em caso de estorno ou chargeback da transação.
installment `string`	Indica o número da parcela a ser paga neste recebimento.
paid_at `string`	Data de pagamento no formato yyyy-mm-ddThh:mm:ssZ
canceled_at `string`	Data de cancelamento no formato yyyy-mm-ddThh:mm:ssZ
expected_on `string`	Data prevista para o crédito no saldo do vendedor, no formato yyyy-mm-ddThh:mm:ssZ

","_postman_id":"e487ef9a-7339-4d78-a4ec-3d6eb95b87d4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}}],"id":"47d810fe-c7c6-48c5-8336-f464ae1572f8","description":"

Cobranças por cartão, boleto e Pix, cartões dos compradores, regras de divisão (split) e recebíveis gerados por cada venda.

","_postman_id":"47d810fe-c7c6-48c5-8336-f464ae1572f8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}},{"name":"Pagamentos e Transferências","item":[{"name":"Conta Bancária","item":[{"name":"Associar conta bancária ao cliente","id":"160e21ad-27e0-4f6c-809f-196f432d4d7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["bank_accounts"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"160e21ad-27e0-4f6c-809f-196f432d4d7f"},{"name":"Remover conta bancária","id":"087574aa-f152-4d9e-bb5b-d027d6eb4430","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":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["bank_accounts",":bank_account_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"0b01e6f4-10d4-4558-92b8-91a43e68ba30","type":"any","value":"","key":"bank_account_id"}]}},"response":[],"_postman_id":"087574aa-f152-4d9e-bb5b-d027d6eb4430"},{"name":"Recuperar conta bancária pelo ID","id":"3f0d6c48-004f-4e30-a7ac-8de55e07f3f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/bank_accounts/:bank_account_id","description":"

Retorna os dados de uma conta bancária associada a um vendedor ou comprador.

Ao cadastrar uma conta bancária, você pode fazer transferências sem informar os dados a cada operaçã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 AZ Pay 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_checklist	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 da última atualização no formato yyyy-mm-ddThh:mm:ssZ

","_postman_id":"f7d7d661-bc20-4da3-8165-e4db6c794707","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}},{"name":"Extrato","item":[{"name":"Listar extrato do vendedor","id":"b682aa05-b511-43f0-83ba-f8f567ccd72d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/sellers/:seller_id/balances/history","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["sellers",":seller_id","balances","history"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"aaa9c212-ca3f-4d92-b73f-0762ee80c60a","type":"any","value":"","key":"seller_id"}]}},"response":[],"_postman_id":"b682aa05-b511-43f0-83ba-f8f567ccd72d"},{"name":"Consultar saldo do vendedor","id":"9dcbb596-f2b5-44a5-97d3-3d790e116381","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/sellers/:seller_id/balances","description":"

Retorna o saldo atual do vendedor (current_balance) e o saldo a liberar (account_balance), em centavos.

Lista as movimentações do extrato do vendedor com filtros por período, tipo de operação e tipo financeiro.

Quantidade de registros por página (padrão 100)

\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"

Deslocamento para paginação

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

Data inicial no formato YYYY-MM-DD

\n","type":"text/plain"},"key":"created_date_range_gte","value":""},{"description":{"content":"

Data final no formato YYYY-MM-DD

\n","type":"text/plain"},"key":"created_date_range_lte","value":""},{"description":{"content":"

Tipo de operação, ex.: transaction, transfer, refund

\n","type":"text/plain"},"key":"operation_type","value":""},{"description":{"content":"

credit ou debit

\n","type":"text/plain"},"key":"financial_type","value":""}],"variable":[{"id":"7ff56700-566c-491e-af87-2c64da72036e","type":"any","value":"","key":"seller_id"}]}},"response":[],"_postman_id":"af56b1b4-872c-4fcd-b9ba-f88a3ec3616a"}],"id":"6fa3dc11-0c7a-49f5-ad5a-fe20eb0b6021","description":"

Saldo disponível e a liberar de cada vendedor, e o histórico de movimentações (créditos de vendas, transferências, estornos e taxas).

","_postman_id":"6fa3dc11-0c7a-49f5-ad5a-fe20eb0b6021","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}},{"name":"Transferências","item":[{"name":"Listar transferências do vendedor","id":"71fd13d5-f4d3-4e65-a893-72906ce3dda0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/sellers/:seller_id/transfers","description":"

Lista as transferências realizadas e agendadas do vendedor.

Lista as transferências do vendedor em um intervalo de datas.

Data inicial no formato YYYY-MM-DD

\n","type":"text/plain"},"key":"begin","value":""},{"description":{"content":"

Data final no formato YYYY-MM-DD

\n","type":"text/plain"},"key":"end","value":""}],"variable":[{"id":"39702d04-9820-4766-a36b-7594c376efec","type":"any","value":"","key":"seller_id"}]}},"response":[],"_postman_id":"3488b2c3-465d-4aa9-8e6c-87bd72aa54b7"},{"name":"Transferir saldo para conta bancária","id":"b6280391-b759-4ba1-99d9-235815b3bbd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": \"\", //Valor em centavos. Ex.: R$ 10,00 = 1000\n \"description\": \"\", //Descrição da transferência\n \"statement_descriptor\": \"\" //Nome exibido no extrato bancário do favorecido\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/bank_accounts/:bank_account_id/transfers","description":"

Transfere saldo do vendedor para a conta bancária informada. A conta precisa ser de mesma titularidade do vendedor.

Transfere saldo do vendedor owner para o vendedor receiver, ambos do mesmo marketplace.

Retorna os detalhes e o status de uma transferência.

Cancela uma transferência ainda não efetivada. Transferências já concluídas não podem ser canceladas.

Transferências de saldo do vendedor: saque para a conta bancária cadastrada, transferência entre vendedores do mesmo marketplace (P2P), consulta e cancelamento de transferências agendadas. Valor mínimo por transferência: R$ 1,00.

","_postman_id":"1cc4cbe0-0194-44a7-ad25-f596db5e8876","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}}],"id":"a490d09e-cd68-4695-be9b-3ab8923c3aa7","description":"

Contas bancárias dos vendedores, saldo e extrato, e transferências de saldo para conta bancária ou entre vendedores.

","_postman_id":"a490d09e-cd68-4695-be9b-3ab8923c3aa7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}},{"name":"Planos e Assinaturas","item":[{"name":"Planos","item":[{"name":"Recuperar plano pelo ID","id":"59dd5016-f910-44af-b1ea-a10730b746cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/plans/:plan_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["plans",":plan_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"0e3ee5bc-eb68-409c-b01d-326775cf9eed","type":"any","value":"","key":"plan_id"}]}},"response":[],"_postman_id":"59dd5016-f910-44af-b1ea-a10730b746cf"},{"name":"Criar plano","id":"42266399-ebec-44cf-b67b-7bcddf796233","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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íodo (dias) de carência para a primeira cobrança do plano\n \"tolerance_period\": \"\", //Período de tolerância em caso de 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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["plans"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"42266399-ebec-44cf-b67b-7bcddf796233"},{"name":"Alterar plano","id":"5dd96004-1c4e-4e05-b93e-f8459429cb62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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íodo (dias) de carência para a primeira cobrança do plano\n \"tolerance_period\": \"\", //Período de tolerância em caso de 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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["plans",":plan_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"33fd411b-8031-4a04-b761-410c7bf090e9","type":"any","value":"","key":"plan_id"}]}},"response":[],"_postman_id":"5dd96004-1c4e-4e05-b93e-f8459429cb62"},{"name":"Remover plano","id":"0ed555c3-8b30-487e-9fd0-5960b2fa4db1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.azape.co/plans/:plan_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["plans",":plan_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"31dd743c-726a-4140-9460-6cb2382fbf4b","type":"any","value":"","key":"plan_id"}]}},"response":[],"_postman_id":"0ed555c3-8b30-487e-9fd0-5960b2fa4db1"}],"id":"1f92b46c-919c-485a-b380-2e75d15f074b","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 do plano você informa a frequência (frequency) de cobrança, que pode ser diária, semanal, mensal ou anual, e o intervalo (interval) sobre essa frequência. Por exemplo, frequência mensal com intervalo 2 cobra a cada dois meses.

Os planos são gerenciados por vendedor. É possível criar vários planos com políticas diferentes: valor em centavos, formas de pagamento permitidas, carência para a primeira cobrança e tolerância em caso de atraso.

Os planos são utilizados exclusivamente em assinaturas com cobrança via cartão de crédito, não é possível criar ou usar um plano com cobrança por boleto.

\n\n

Tipos de Eventos

Eventos enviados no fluxo de planos

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

Campos e valores esperados

id	Valor
frequency - Obrigatório	String: frequência de cobrança do plano: ['daily', 'monthly', 'weekly', 'annually']
interval - Obrigatório	int32: intervalo entre cobranças, com base na frequência
amount - Obrigatório	int32: Um número inteiro positivo em centavos a cobrar em cada recorrência, ex.: '1260' para R$ 12,60
setup_amount	int32: Um número inteiro positivo em centavos cobrado uma única vez na adesão, ex.: '1260' para R$ 12,60. Não envie se não houver valor inicial.
description	String: Descrição do plano
name - Obrigatório	String: Nome do plano
grace_period	int32: carência, em dias, para a primeira cobrança.
tolerance_period	int32: tolerância, em dias, em caso de falha de pagamento
duration	int32: duração do plano, em número de períodos da frequência escolhida

","_postman_id":"1f92b46c-919c-485a-b380-2e75d15f074b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}},{"name":"Assinaturas","item":[{"name":"Recuperar assinatura pelo ID","id":"c74c0d04-0d76-4865-8b40-1e9620025f62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/subscriptions/:subscription_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["subscriptions",":subscription_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"ebf76659-65f6-4845-971e-6266d92dd362","type":"any","value":"","key":"subscription_id"}]}},"response":[],"_postman_id":"c74c0d04-0d76-4865-8b40-1e9620025f62"},{"name":"Criar assinatura","id":"83f2c153-f51f-4a21-909b-de7ce6914f3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"plan\": \"\", //ID de um plano existente\n \"on_behalf_of\": \"\", //ID de um vendedor existente\n \"customer\": \"\", //ID de um comprador existente\n \"due_date\": \"\", //Data da próxima cobrança \"YYYY-MM-DD\"\n \"due_since_date\": \"\", //Opcional. Data de referência para o cálculo dos vencimentos \"YYYY-MM-DD\"\n \"payment_method\": \"\", //Forma de pagamento: \"credit\"\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íodo (dias) de carência para a primeira cobrança da assinatura\n \"tolerance_period\": \"\" //Período de tolerância em caso de falha de pagamento\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/subscriptions","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["subscriptions"],"host":["https://api.azape.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"83f2c153-f51f-4a21-909b-de7ce6914f3e"},{"name":"Alterar assinatura","id":"8944b51a-91a5-464a-880e-890434095592","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"plan\": \"\", //ID de um plano existente\n \"on_behalf_of\": \"\", //ID de um vendedor existente\n \"customer\": \"\", //ID de um comprador existente\n \"due_date\": \"\", //Data da próxima cobrança \"YYYY-MM-DD\"\n \"due_since_date\": \"\", //Opcional. Data de referência para o cálculo dos vencimentos \"YYYY-MM-DD\"\n \"payment_method\": \"\", //Forma de pagamento: \"credit\"\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íodo (dias) de carência para a primeira cobrança da assinatura\n \"tolerance_period\": \"\" //Período de tolerância em caso de falha de pagamento\n}","options":{"raw":{"language":"json"}}},"url":"https://api.azape.co/subscriptions/:subscription_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["subscriptions",":subscription_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"5c076aa7-7acb-452d-8126-2966a60e5dd7","type":"any","value":"","key":"subscription_id"}]}},"response":[],"_postman_id":"8944b51a-91a5-464a-880e-890434095592"},{"name":"Remover assinatura","id":"87024572-5c74-4450-a001-a27b3cd6fe77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.azape.co/subscriptions/:subscription_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["subscriptions",":subscription_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"d024db0b-acae-4ef0-b74b-18972c62cda3","type":"any","value":"","key":"subscription_id"}]}},"response":[],"_postman_id":"87024572-5c74-4450-a001-a27b3cd6fe77"},{"name":"Listar faturas da assinatura","id":"e879b16c-9433-4ef1-b01b-e66ff861cea2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/subscriptions/:subscription_id/invoices","description":"

Lista todas as faturas geradas para uma assinatura, com status e datas de vencimento e pagamento.

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 da assinatura é obrigatório informar o plano e o comprador. Também é possível definir a data da primeira cobrança (due_date) e a data final da assinatura (expiration_date).

A cada período do plano, uma fatura é gerada automaticamente para a assinatura, que passa ao estado pending até a fatura ser paga.

Cobrança automática de assinaturas pendentes de pagamento

Quando uma fatura está pendente e o comprador tem cartão de crédito como forma padrão de pagamento, é feita uma tentativa de cobrança por dia, e a transação criada fica associada à fatura. Se a cobrança tem sucesso, a fatura passa a paid; se não houver outra fatura pendente, a assinatura também passa a paga e o evento subscription.paid é disparado.

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

Tipos de Eventos

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

Campos e valores esperados

id	Valor
plan - Obrigatório	String: ID de um plano existente
on_behalf_of - Obrigatório	String: ID de um vendedor existente.
customer - Obrigatório	String: ID de um comprador existente.
due_date - Obrigatório	String: Data da primeira cobrança. Formato YYYY-MM-DD, ex.: '2026-10-25'
expiration_date	String: Data final da assinatura se existir. Formato YYYY-MM-DD, ex.: '2026-10-25'
amount	int32: Valor em centavos cobrado como valor inicial, ex.: '1260' para R$ 12,60.
grace_period	int32: carência, em dias, para a primeira cobrança.
tolerance_period	int32: tolerância, em dias, em caso de falha de pagamento

","_postman_id":"d9faf48c-06ac-4b22-a514-4754490860b4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}},{"name":"Faturas","item":[{"name":"Recuperar fatura pelo ID","id":"09ce538a-b7a4-452a-8dcb-ba2edb40f286","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.azape.co/invoices/:invoice_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}},"urlObject":{"path":["invoices",":invoice_id"],"host":["https://api.azape.co"],"query":[],"variable":[{"id":"ed0ef5be-a937-49d9-aedd-faa7cf10acfc","type":"any","value":"","key":"invoice_id"}]}},"response":[],"_postman_id":"09ce538a-b7a4-452a-8dcb-ba2edb40f286"},{"name":"Criar fatura avulsa","id":"84b24a67-7b35-49df-ae2a-33ac3ebfe966","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"subscription\": \"\", //Referência a uma assinatura existente\n \"on_behalf_of\": \"\", //ID de um vendedor existente\n \"customer\": \"\", //ID de 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 em caso de falha no pagamento\n \"grace_period\": \"\", //Carência, em dias, para a primeira cobrança\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":"

Cria uma fatura avulsa, independente de assinatura, ligada diretamente ao comprador.

Estorna uma fatura paga, processando o estorno na forma de pagamento usada para pagá-la.

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 pela estrutura de recorrência da AZ Pay, 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 servem para cobrar qualquer valor não recorrente. É possível configurar política de retentativa, prazo de vencimento, comprador, formas de pagamento, URL de retorno e pagamento após o vencimento com multa diária.

Suspensão de cobrança quando as tentativas são excedidas

Quando o número de retentativas de cobrança de uma fatura é excedido, a fatura e a assinatura são marcadas como expired e não há novas tentativas de cobrança.

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

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":"f20e71e3-8f4d-4cb1-a2ab-c1fca34926b1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}}],"id":"38fc5a54-35b9-42ea-be27-cca125b4d42a","description":"

Cobrança recorrente: planos definem a regra de cobrança, assinaturas vinculam um comprador a um plano e faturas registram cada cobrança, recorrente ou avulsa.

","_postman_id":"38fc5a54-35b9-42ea-be27-cca125b4d42a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}},{"name":"Notificações e Eventos","item":[{"name":"Webhook","item":[{"name":"Criar ou atualizar webhook","id":"4b57f589-f156-4335-9dcd-56e944d8a2dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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 cadastrar um webhook para um evento que já possui webhook, o anterior é substituído automaticamente.

A resposta inclui o campo secret, exibido apenas neste momento. Guarde-o para validar o cabeçalho X-Webhook-Signature das notificações (veja \"Assinatura das notificações\" na descrição desta pasta). Cada novo cadastro gera um novo secret.

Ao cadastrar um webhook para um evento que já possui webhook, o anterior é substituído automaticamente.

"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"on_behalf_of\": \"\",\n \"url\": \"https://sua-aplicacao.com/webhooks/azpay\",\n \"event\": \"transactions\",\n \"description\": \"Notificações de transações\",\n \"status\": \"active\",\n \"secret\": \"f3a9c2…(64 caracteres hexadecimais)\"\n}"}],"_postman_id":"4b57f589-f156-4335-9dcd-56e944d8a2dc"}],"id":"3b867eae-5b0f-497c-b9ad-0fce216f420c","description":"

O recurso webhook

Webhooks (callbacks) permitem que você receba notificações de eventos em uma URL da sua escolha. Você pode criar um webhook por evento.

Quando um evento acontece (por exemplo, uma transação é aprovada), enviamos a notificação para a URL cadastrada.

Se o seu sistema responder com status 200, consideramos o evento entregue e não o reenviamos. Mesmo assim, um evento pode ser disparado mais de uma vez, então trate a idempotência na sua aplicação.

\n\n

Atributos

id	string Identificador exclusivo para este webhook
resource	string Valor: webhook
url	string URL pública que receberá o evento. O conteúdo é enviado como JSON no corpo de uma requisição POST.
description	string Texto livre que você pode anexar ao webhook
event	string Tipo de evento monitorado por este webhook. Cada webhook monitora um evento. Os eventos disponíveis são: `sellers`, `transactions`, `subscriptions` e `receivables`
secret	string Chave usada para assinar as notificações enviadas a este webhook. Retornada apenas uma vez, na resposta do cadastro.
createdAt	string Data de criação no formato yyyy-mm-ddThh:mm:ssZ
updatedAt	string Data da última atualização no formato yyyy-mm-ddThh:mm:ssZ

Assinatura das notificações

Ao cadastrar um webhook, a resposta inclui um secret. Cada notificação enviada a esse webhook inclui o cabeçalho X-Webhook-Signature, com o HMAC-SHA256 do corpo bruto da requisição calculado com o secret:

X-Webhook-Signature: sha256=<hmac_sha256_hex(corpo, secret)>

Valide a assinatura antes de processar o evento. Exemplo em Node.js:

const crypto = require(\"crypto\");\n\nfunction isValid(rawBody, header, secret) {\n  const expected = \"sha256=\" + crypto.createHmac(\"sha256\", secret).update(rawBody).digest(\"hex\");\n  return header.length === expected.length && crypto.timingSafeEqual(Buffer.from(header), Buffer.from(expected));\n}

Use o corpo bruto da requisição (antes de qualquer parse de JSON), pois qualquer alteração de espaços ou ordem de campos invalida o HMAC.

📘 Webhook sem secret
Se as notificações do seu webhook não trazem o cabeçalho X-Webhook-Signature, cadastre o webhook novamente com POST /webhook: o cadastro anterior do mesmo evento é substituído e um secret é gerado.

\n","_postman_id":"3b867eae-5b0f-497c-b9ad-0fce216f420c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}}],"id":"257c3a43-767b-49ef-9004-e6ca509282b4","description":"

Webhooks para receber, na sua URL, os eventos de vendedores, transações, assinaturas e recebíveis.

","_postman_id":"257c3a43-767b-49ef-9004-e6ca509282b4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","id":"cc7bed68-1ef1-4955-bbc9-ec4318d53f25","name":"AZ Pay","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"837afba1-231c-4a22-a003-ec161e51d82c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b1bdd227-a17c-4730-b48f-7083c66031a4"}}],"variable":[{"key":"baseUrl","value":"https://api.azape.co"},{"key":"baseStagingUrl","value":"https://api.azape.dev"},{"key":"baseUrlNew","value":"https://api.azpay.me"},{"key":"baseStagingUrlNew","value":"https://api.staging.azpay.me"},{"key":"token","value":""}]}