{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/security:malga/clienttoken-create-public-key":{"post":{"operationId":"security_malga_clienttoken_create_public_key","summary":"Criar nova chave pública para uso no client-side","description":"POST /v1/auth","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/create-token":{"post":{"operationId":"security_malga_create_token","summary":"Criar um novo token","description":"POST /v1/tokens","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/cards-list":{"get":{"operationId":"security_malga_cards_list","summary":"Listar cartões","description":"GET /v1/cards","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"page","in":"query","required":false,"description":"número da página","schema":{"type":"number","description":"número da página"}},{"name":"limit","in":"query","required":false,"description":"quantidade de itens por página","schema":{"type":"number","description":"quantidade de itens por página"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/cards-create-new-card-from-token":{"post":{"operationId":"security_malga_cards_create_new_card_from_token","summary":"Criar novo cartão a partir de token","description":"POST /v1/cards","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/cards-get-card-details":{"get":{"operationId":"security_malga_cards_get_card_details","summary":"Recuperar detalhes de cartão","description":"GET /v1/cards/{id}","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":true,"description":"ID do cartão","schema":{"type":"string","description":"ID do cartão"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/charges-list":{"get":{"operationId":"security_malga_charges_list","summary":"Listar cobranças","description":"GET /v1/charges","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"page","in":"query","required":false,"description":"numero da pagina ativa","schema":{"type":"number","description":"numero da pagina ativa"}},{"name":"limit","in":"query","required":false,"description":"quantidade de registros por página 1-100","schema":{"type":"number","description":"quantidade de registros por página 1-100"}},{"name":"sort","in":"query","required":false,"description":"tipo de ordenação decrescente ou crescente","schema":{"type":"string","enum":["ASC","DESC"],"description":"tipo de ordenação decrescente ou crescente"}},{"name":"merchantId","in":"query","required":false,"description":"id do merchant processado na cobrança","schema":{"type":"string","description":"id do merchant processado na cobrança"}},{"name":"id","in":"query","required":false,"description":"id da cobrança","schema":{"type":"string","description":"id da cobrança"}},{"name":"originalAmount","in":"query","required":false,"description":"valor em centavos da cobrança","schema":{"type":"number","description":"valor em centavos da cobrança"}},{"name":"status","in":"query","required":false,"description":"status da cobrança","schema":{"type":"string","enum":["pending","pre_authorized","authorized","voided","refund_pending","canceled","charged_back","capture_pending"],"description":"status da cobrança"}},{"name":"paymentType","in":"query","required":false,"description":"tipo de pagamento","schema":{"type":"string","enum":["credit","pix","boleto"],"description":"tipo de pagamento"}},{"name":"orderId","in":"query","required":false,"description":"id da cobrança gerado pelo cliente","schema":{"type":"string","description":"id da cobrança gerado pelo cliente"}},{"name":"created","in":"query","required":false,"description":"registros criados em uma data específica","schema":{"type":"string","description":"registros criados em uma data específica"},"example":"2022-03-12T12:43:53"},{"name":"created.gt","in":"query","required":false,"description":"registros com data maior que","schema":{"type":"string","description":"registros com data maior que"},"example":"2022-03-12T12:43:53"},{"name":"created.lt","in":"query","required":false,"description":"registros com data menor que","schema":{"type":"string","description":"registros com data menor que"},"example":"2022-03-12T12:43:53"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/charges-create-new-charge":{"post":{"operationId":"security_malga_charges_create_new_charge","summary":"Realizar nova cobrança","description":"POST /v1/charges","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/charges-get-details-by-id":{"get":{"operationId":"security_malga_charges_get_details_by_id","summary":"Recuperar detalhes de cobrança","description":"GET /v1/charges/{id}","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":true,"description":"id da cobrança que deseja recuperar","schema":{"type":"string","description":"id da cobrança que deseja recuperar"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/charges-update-status-by-id":{"post":{"operationId":"security_malga_charges_update_status_by_id","summary":"Alterar o status de uma cobrança no ambiente de sandbox","description":"POST /v1/charges/{id}","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"id da cobrança que deseja alterar no sandbox"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/charges-alter-antifraud-status":{"post":{"operationId":"security_malga_charges_alter_antifraud_status","summary":"Alterar o status do antifraude no ambiente de sandbox","description":"PATCH /v1/charges/{id}/antifraud","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"id da cobrança que deseja alterar no sandbox"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/charges-capture-charge":{"post":{"operationId":"security_malga_charges_capture_charge","summary":"Capturar cobrança pre-autorizada","description":"POST /v1/charges/{id}/capture","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"id da cobrança que deseja capturar"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/charges-void-approved-charge":{"post":{"operationId":"security_malga_charges_void_approved_charge","summary":"Estornar cobrança aprovada","description":"POST /v1/charges/{id}/void","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"id da cobrança que deseja estornar"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/sessions-create-new-session":{"post":{"operationId":"security_malga_sessions_create_new_session","summary":"Criar nova sessão","description":"POST /v1/sessions","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/sessions-get-details-by-id":{"get":{"operationId":"security_malga_sessions_get_details_by_id","summary":"Recuperar detalhes de uma sessão","description":"GET /v1/sessions/{id}","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":true,"description":"Identificação da sessão a ser recuperada","schema":{"type":"string","description":"Identificação da sessão a ser recuperada"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/sessions-update-status":{"post":{"operationId":"security_malga_sessions_update_status","summary":"Atualizar o status de uma sessão","description":"PATCH /v1/sessions/{id}","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identificação da sessão a ser alterada"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/sessions-charge-post":{"post":{"operationId":"security_malga_sessions_charge_post","summary":"Pagar uma sessão","description":"POST /v1/sessions/{id}/charge","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identificação da sessão a ser paga"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/sessions-cancelar-sessao":{"post":{"operationId":"security_malga_sessions_cancelar_sessao","summary":"Cancelar uma sessão","description":"POST /v1/sessions/{id}/cancel","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identificação da sessão a ser cancelada"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/sessions-get-history":{"get":{"operationId":"security_malga_sessions_get_history","summary":"Recuperar o histórico da sessão","description":"GET /v1/sessions/{id}/history","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":true,"description":"Identificação da sessão a ser recuperada","schema":{"type":"string","description":"Identificação da sessão a ser recuperada"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/sessions-get-link":{"get":{"operationId":"security_malga_sessions_get_link","summary":"Recupera sessão com os dados das configurações da empresa","description":"GET /v1/sessions/{id}/link","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":true,"description":"Identificação da sessão a ser recuperada","schema":{"type":"string","description":"Identificação da sessão a ser recuperada"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/merchants-list-registered-merchants":{"get":{"operationId":"security_malga_merchants_list_registered_merchants","summary":"Listagem de merchants cadastrados","description":"GET /v1/merchants","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"page","in":"query","required":false,"description":"número da página","schema":{"type":"number","description":"número da página"}},{"name":"limit","in":"query","required":false,"description":"quantidade de itens por página","schema":{"type":"number","description":"quantidade de itens por página"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/merchants-create-new-merchant":{"post":{"operationId":"security_malga_merchants_create_new_merchant","summary":"Criação de novo merchant para cobrança","description":"POST /v1/merchants","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/merchants-get-details-by-id":{"get":{"operationId":"security_malga_merchants_get_details_by_id","summary":"Recuperar detalhes de merchant pelo id","description":"GET /v1/merchants/{id}","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":true,"description":"id do merchant","schema":{"type":"string","description":"id do merchant"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/merchants-atualizar-configuracoes":{"post":{"operationId":"security_malga_merchants_atualizar_configuracoes","summary":"Atualizar configurações de merchant","description":"PATCH /v1/merchants/{id}","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"id do merchant"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/merchants-delete-by-id":{"post":{"operationId":"security_malga_merchants_delete_by_id","summary":"Deletar merchant pelo id","description":"DELETE /v1/merchants/{id}","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"id do merchant"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/customers-listagem-cadastrados":{"get":{"operationId":"security_malga_customers_listagem_cadastrados","summary":"Listagem de customers cadastrados","description":"GET /v1/customers","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"page","in":"query","required":false,"description":"número da página","schema":{"type":"number","description":"número da página"}},{"name":"limit","in":"query","required":false,"description":"quantidade de itens por página","schema":{"type":"number","description":"quantidade de itens por página"}},{"name":"sort","in":"query","required":false,"description":"ordenação dos itens","schema":{"type":"string","enum":["ASC","DESC"],"description":"ordenação dos itens"}},{"name":"id","in":"query","required":false,"description":"identificador de um customer","schema":{"type":"string","description":"identificador de um customer"}},{"name":"document.type","in":"query","required":false,"description":"tipo de documento","schema":{"type":"string","description":"tipo de documento"}},{"name":"document.number","in":"query","required":false,"description":"numero do documento","schema":{"type":"string","description":"numero do documento"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/customers-create-new-customer":{"post":{"operationId":"security_malga_customers_create_new_customer","summary":"Criação de novo customer para cobrança","description":"POST /v1/customers","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/customers-recuperar-detalhes":{"get":{"operationId":"security_malga_customers_recuperar_detalhes","summary":"Recuperar detalhes de customer","description":"GET /v1/customers/{id}","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":true,"description":"id do customers que deseja recuperar","schema":{"type":"string","description":"id do customers que deseja recuperar"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/customers-update-by-id":{"post":{"operationId":"security_malga_customers_update_by_id","summary":"Atualizar customer pelo id","description":"PATCH /v1/customers/{id}","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"id do customers que deseja alterar"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/customers-delete-by-id":{"post":{"operationId":"security_malga_customers_delete_by_id","summary":"Deletar customer pelo id","description":"DELETE /v1/customers/{id}","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"id do customers que deseja deletar"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/customers-list-cards":{"get":{"operationId":"security_malga_customers_list_cards","summary":"Listagem dos cartões do customer","description":"GET /v1/customers/{customer_id}/cards","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"customer_id","in":"query","required":true,"description":"id do customers que deseja alterar","schema":{"type":"string","description":"id do customers que deseja alterar"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/customers-add-credit-card":{"post":{"operationId":"security_malga_customers_add_credit_card","summary":"Adicionar cartão de crédito ao customer","description":"POST /v1/customers/{customer_id}/cards","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customer_id","body"],"properties":{"customer_id":{"type":"string","description":"id do customers que deseja alterar"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/webhooks-list-webhooks":{"get":{"operationId":"security_malga_webhooks_list_webhooks","summary":"Listagem de webhooks cadastrados","description":"GET /v1/webhooks","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"page","in":"query","required":false,"description":"número da página","schema":{"type":"number","description":"número da página"}},{"name":"limit","in":"query","required":false,"description":"quantidade de itens por página","schema":{"type":"number","description":"quantidade de itens por página"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/webhooks-create-new-notification":{"post":{"operationId":"security_malga_webhooks_create_new_notification","summary":"Criação de novo webhook para notificação","description":"POST /v1/webhooks","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/webhooks-get-details-by-id":{"get":{"operationId":"security_malga_webhooks_get_details_by_id","summary":"Recuperar detalhes de webhook","description":"GET /v1/webhooks/{id}","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":true,"description":"id do webhook que deseja recuperar","schema":{"type":"string","description":"id do webhook que deseja recuperar"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/webhooks-atualizar-pelo-id":{"post":{"operationId":"security_malga_webhooks_atualizar_pelo_id","summary":"Atualizar webhook pelo id","description":"PATCH /v1/webhooks/{id}","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"id do webhook que deseja alterar"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/webhooks-delete-by-id":{"post":{"operationId":"security_malga_webhooks_delete_by_id","summary":"Deletar webhook pelo id","description":"DELETE /v1/webhooks/{id}","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"id do webhook que deseja deletar"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/sellers-create-new":{"post":{"operationId":"security_malga_sellers_create_new","summary":"Criação de um novo recebedor","description":"POST /v1/sellers","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/sellers-consult-by-id":{"get":{"operationId":"security_malga_sellers_consult_by_id","summary":"Consultar um recebedor pelo ID","description":"GET /v1/sellers/{id}","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":true,"description":"Identificador do seller","schema":{"type":"string","description":"Identificador do seller"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/sellers-list-paged":{"get":{"operationId":"security_malga_sellers_list_paged","summary":"Consultar um recebedor por listagem paginada","description":"GET /v1/sellers?id&email&status&limit&page","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":false,"description":"Identificador do seller","schema":{"type":"string","description":"Identificador do seller"}},{"name":"email","in":"query","required":false,"description":"E-mail do seller","schema":{"type":"string","description":"E-mail do seller"}},{"name":"status","in":"query","required":false,"description":"Status do seller","schema":{"type":"string","description":"Status do seller"}},{"name":"limit","in":"query","required":false,"description":"Limite de itens retornados na consulta","schema":{"type":"number","description":"Limite de itens retornados na consulta"}},{"name":"page","in":"query","required":false,"description":"Páginas da consulta","schema":{"type":"number","description":"Páginas da consulta"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/sellers-update-by-id":{"post":{"operationId":"security_malga_sellers_update_by_id","summary":"Atualização de recebedor pelo ID","description":"PATCH /v1/sellers?id","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identificador do seller"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/sellers-delete-by-id":{"post":{"operationId":"security_malga_sellers_delete_by_id","summary":"Deletar recebedor por ID","description":"DELETE /v1/sellers?id","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"ID do seller"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/flows-get-paged":{"get":{"operationId":"security_malga_flows_get_paged","summary":"Recuperar todos os fluxos paginado","description":"GET /v1/flows","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"page","in":"query","required":false,"description":"número da página","schema":{"type":"number","description":"número da página"}},{"name":"limit","in":"query","required":false,"description":"quantidade de itens por página","schema":{"type":"number","description":"quantidade de itens por página"}},{"name":"merchantId","in":"query","required":false,"description":"usado para filtrar os fluxos por merchantId","schema":{"type":"string","description":"usado para filtrar os fluxos por merchantId"}},{"name":"paymentMethod","in":"query","required":false,"description":"usado para filtrar os fluxos por método de pagamento","schema":{"type":"string","description":"usado para filtrar os fluxos por método de pagamento"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/flows-consultar-pelo-id":{"get":{"operationId":"security_malga_flows_consultar_pelo_id","summary":"Consultar um fluxo pelo id","description":"GET /v1/flows/{id}","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":true,"description":"flow id","schema":{"type":"string","description":"flow id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/reports-export-base-data":{"post":{"operationId":"security_malga_reports_export_base_data","summary":"Exportar dados da base","description":"POST /v1/reports","tags":["security"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"accept-language":{"type":"string","enum":["en-US","pt-BR"],"default":"en-US","description":"Idioma da exportação"},"X-User-Timezone":{"type":"string","default":"America/Sao_Paulo","description":"Timezone local do cliente no formato tz database"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:malga/reports-get-details-by-id":{"get":{"operationId":"security_malga_reports_get_details_by_id","summary":"Recuperar detalhes de uma exportação","description":"GET /v1/reports/{id}","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":true,"description":"Id da exportação","schema":{"type":"string","description":"Id da exportação"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:malga/reports-download-file":{"get":{"operationId":"security_malga_reports_download_file","summary":"Fazer download de um arquivo","description":"GET /v1/reports/{id}/files/{pageNumber}","tags":["security"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":true,"description":"Id da exportação","schema":{"type":"string","description":"Id da exportação"}},{"name":"pageNumber","in":"query","required":true,"description":"Número da página","schema":{"type":"string","description":"Número da página"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}