- 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
- GETListagem de vendedores paginada
- POSTCriação de um novo vendedor
- PATCHAtualizar um vendedor
- GETRecuperar detalhes de um vendedor
- DELDeletar vededor pelo id
Tokens
Charges
Sessions
Merchants
Customers
Webhooks
Sellers
Vendors
Listar cobranças
numero da pagina ativa
quantidade de registros por página 1-100
tipo de ordenação decrescente ou crescente
id do merchant processado na cobrança
id da cobrança
valor em centavos da cobrança
status da cobrança
tipo de pagamento
id da cobrança gerado pelo cliente
registros criados em uma data específica
registros com data maior que
registros com data menor que
curl --request GET \
--url https://api.malga.io/v1/charges \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>'
{
"meta": {
"itemCount": 10,
"totalItems": 20,
"itemsPerPage": 10,
"totalPages": 5,
"currentPage": 2
},
"items": [
{
"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"currency": "BRL",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"isDispute": false,
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"paymentMethod": {
"paymentType": "credit",
"installments": 1
},
"paymentSource": {
"sourceType": "card",
"cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
},
"transactionRequests": [
{
"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
"providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
"providerType": "STRIPE",
"transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
"amount": 1500,
"authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
"requestStatus": "success",
"requestType": "authorization",
"responseTs": "2633ms",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:42.212Z",
"providerAuthorization": {
"networkAuthorizationCode": "00",
"networkResponseCode": ""
}
}
],
"appInfo": {
"platform": {
"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {
"name": "iOS",
"version": "10.12"
},
"system": {
"name": "VTEX",
"version": "13.12"
}
}
}
]
}
Authorizations
Query Parameters
numero da pagina ativa
quantidade de registros por página 1-100
tipo de ordenação decrescente ou crescente
ASC
, DESC
id do merchant processado na cobrança
id da cobrança
valor em centavos da cobrança
status da cobrança
pending
, pre_authorized
, authorized
, voided
, refund_pending
, canceled
, charged_back
, capture_pending
tipo de pagamento
credit
, pix
, boleto
id da cobrança gerado pelo cliente
registros criados em uma data específica
registros com data maior que
registros com data menor que
Response
quantidade de itens na página
quantidade total de itens na consulta (esse valor é cacheado por 5 minutos para melhorar a performance da API)
quantidade de itens por página
quantidade total de páginas
página atual
curl --request GET \
--url https://api.malga.io/v1/charges \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>'
{
"meta": {
"itemCount": 10,
"totalItems": 20,
"itemsPerPage": 10,
"totalPages": 5,
"currentPage": 2
},
"items": [
{
"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"currency": "BRL",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"isDispute": false,
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"paymentMethod": {
"paymentType": "credit",
"installments": 1
},
"paymentSource": {
"sourceType": "card",
"cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
},
"transactionRequests": [
{
"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
"providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
"providerType": "STRIPE",
"transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
"amount": 1500,
"authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
"requestStatus": "success",
"requestType": "authorization",
"responseTs": "2633ms",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:42.212Z",
"providerAuthorization": {
"networkAuthorizationCode": "00",
"networkResponseCode": ""
}
}
],
"appInfo": {
"platform": {
"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {
"name": "iOS",
"version": "10.12"
},
"system": {
"name": "VTEX",
"version": "13.12"
}
}
}
]
}