- Dashboard
- Nosso Blog
- Status Page
- POSTCriar um novo token
- GETListar cobranças
- POSTRealizar nova cobrança
- GETRecuperar detalhes de cobrança
- POSTAlterar o status de uma cobrança no ambiente de sandbox
- PATCHAlterar o status do antifraude no ambiente de sandbox
- POSTCapturar cobrança pre-autorizada
- POSTEstornar cobrança aprovada
- POSTCriar nova sessão
- GETRecuperar detalhes de uma sessão
- PATCHAtualizar o status de uma sessão
- POSTPagar uma sessão
- POSTCancelar uma sessão
- GETRecuperar o histórico da sessão
- GETRecupera sessão com os dados das configurações da empresa
- GETListagem de merchants cadastrados
- POSTCriação de novo merchant para cobrança
- GETRecuperar detalhes de merchant pelo id
- DELDeletar merchant pelo id
- PATCHAtualizar configurações de merchant
- GETListagem de customers cadastrados
- POSTCriação de novo customer para cobrança
- GETRecuperar detalhes de customer
- DELDeletar customer pelo id
- PATCHAtualizar customer pelo id
- GETListagem dos cartões do customer
- POSTAdicionar cartão de crédito ao customer
- GETListagem de webhooks cadastrados
- POSTCriação de novo webhook para notificação
- GETRecuperar detalhes de webhook
- DELDeletar webhook pelo id
- PATCHAtualizar webhook pelo id
- POSTCriação de um novo recebedor
- GETConsultar um recebedor pelo ID
- GETConsultar um recebedor por listagem paginada
- DELDeletar recebedor por ID
- PATCHAtualização de recebedor pelo ID
Tokens
Charges
Sessions
Merchants
Customers
Webhooks
Sellers
Consultar um recebedor por listagem paginada
Identificador do seller
E-mail do seller
Status do seller
Limite de itens retornados na consulta
Páginas da consulta
curl --request GET \
--url 'https://api.malga.io/v1/sellers?id=&email=&status=&limit=&page=' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>'{
"summary": "Exemplo resposta paginada de seller",
"value": {
"items": [
{
"id": "ea115e44-7048-11ed-a1eb-0242ac120002",
"providers": [
{
"providerType": "PLUG_SANDBOX",
"externalStatus": "active",
"externalStatusReason": "ok",
"status": "pending",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:39.536Z"
}
],
"merchantId": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
"clientId": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
"business": {
"id": "72a574b8-e97e-409c-8402-04208f63e027",
"updatedAt": "2023-05-15T22:27:48.267Z",
"createdAt": "2023-05-15T22:27:48.267Z",
"name": "Seller test",
"phoneNumber": "21 98889999099",
"email": "seller@gmail.com",
"website": null,
"description": "description",
"facebooks": null,
"twitter": null,
"openingDate": "1995-01-27"
},
"mcc": 4040
}
],
"meta": {
"totalItems": 16,
"itemCount": 1,
"itemsPerPage": 1,
"totalPages": 2,
"currentPage": 1
}
}
}Authorizations
Query Parameters
Identificador do seller
E-mail do seller
Status do seller
Limite de itens retornados na consulta
Páginas da consulta
Response
Identificação do merchant
Nome do recebedor
E-mail do recebedor
Telefone de contato do recebedor
Data de nascimento do recebedor em ISO-Date, ex 1996-01-31
Tipo de documento, consultar tabela de tipos suportados
Número do documento formato conforme tipo selecionado
Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA Nome da rua/avenida/travessa
Número onde se localiza o endereço
Complemento onde se localiza o endereço, caso exista
Codigo postal CEP
Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA Estado onde se localiza o endereço
Cidade onde se localiza o endereço
Bairro onde se localiza o endereço
Ponto de referência do endereço
Receita mensal do recebedor
Ocupação profissional do recebedor
Indica se recebedor é representante legal do negócio
Nome do estabelecimento do recebedor
Telefone de contato do estabelecimento do recebedor
E-mail do estabelecimento do recebedor
Site do estabelecimento do recebedor
Descrição do estabelecimento do recebedor
Facebook do estabelecimento do recebedor
Twitter do estabelecimento do recebedor
Data de abertura do estabelecimento do recebedor em ISO-Date, ex 2017-01-31
Nome da rua/avenida/travessa
Número onde se localiza o endereço
Complemento onde se localiza o endereço, caso exista
Codigo postal CEP
Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA Estado onde se localiza o endereço
Cidade onde se localiza o endereço
Bairro onde se localiza o endereço
Ponto de referência do endereço
Tipo de documento, consultar tabela de tipos suportados
Número do documento formato conforme tipo selecionado
Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA Receita anual do negócio
Código de segmento do lojista no adquirente
Nome de identificador do portador da conta bancária
identifica se é pessoa física ou jurídica. aceita os valores 'individual' ou 'company'
individual, company Documento do portador da conta bancária
Código do banco
Número da agência bancária
Código verificador da agência bancária
Número da conta bancária
Número verificador da conta bancária
Tipo de conta
conta_corrente, conta_poupanca, conta_corrente_conjunta, conta_poupanca_conjunta Identificador da informação adicional
Descritivo da informação adicional
Dia em que o parceiro será pago. Depende do transfer_interval - se for daily, enviar 1. Se for weekly pode ser de 1 (segunda) a 5 (sexta). Se for monthly, pode ser de 1 a 31. Além disso, se for daily e o provedor for Pagarme, o valor é 0.
Determina se as transferências estão autorizadas a acontecer ou não.
Intervalo entre as transferências.
daily, weekly, monthly Indica se o recebedor receberá antecipações automaticamente
Indica a porcentagem do volume passível de ser antecipado para o recebedor
Indica o tipo de antecipação automática que será configurado para a conta do recebedor
Indica a quantidade de dias de antecipação automática
Indica a quantidade de dias que serão desconsiderados na contabilização do valor passível de ser antecipado. A contagem de dias é realizada a partir do dia da antecipação para trás
curl --request GET \
--url 'https://api.malga.io/v1/sellers?id=&email=&status=&limit=&page=' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>'{
"summary": "Exemplo resposta paginada de seller",
"value": {
"items": [
{
"id": "ea115e44-7048-11ed-a1eb-0242ac120002",
"providers": [
{
"providerType": "PLUG_SANDBOX",
"externalStatus": "active",
"externalStatusReason": "ok",
"status": "pending",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:39.536Z"
}
],
"merchantId": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
"clientId": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
"business": {
"id": "72a574b8-e97e-409c-8402-04208f63e027",
"updatedAt": "2023-05-15T22:27:48.267Z",
"createdAt": "2023-05-15T22:27:48.267Z",
"name": "Seller test",
"phoneNumber": "21 98889999099",
"email": "seller@gmail.com",
"website": null,
"description": "description",
"facebooks": null,
"twitter": null,
"openingDate": "1995-01-27"
},
"mcc": 4040
}
],
"meta": {
"totalItems": 16,
"itemCount": 1,
"itemsPerPage": 1,
"totalPages": 2,
"currentPage": 1
}
}
}