- 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
Recuperar todos os fluxos paginado
número da página
quantidade de itens por página
usado para filtrar os fluxos por merchantId
usado para filtrar os fluxos por método de pagamento
curl --request GET \
--url https://api.malga.io/v1/flows \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>'
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "identificador único do fluxo"
},
"paymentMethod": {
"type": "string",
"description": "método de pagamento a qual aquele fluxo é relacionado"
},
"clientId": {
"type": "string",
"description": "identificador do cliente dono do fluxo"
},
"merchants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "identificador do merchant relacionado ao fluxo"
}
}
}
},
"parentId": {
"type": "string",
"description": "identificador do fluxo que originou o novo"
},
"restoredFrom": {
"type": "string",
"description": "identificador do fluxo do qual este foi restaurado"
},
"createdAt": {
"type": "string",
"description": "data e hora em que o fluxo foi criado (UTC)"
},
"flow": {
"type": "object",
"description": "dados do fluxo que será cadastrado"
}
},
"example": {
"id": "b4ced0dd-2136-4bce-a231-364e93554073",
"merchants": [
{
"merchantId": "z1babb21-6a4c-987d-89db-11d3af737ee1"
}
],
"paymentMethod": "credit",
"clientId": "f1babb21-6a4c-323d-12db-69d3af407ee1",
"parentId": "g1babb21-6a4c-987d-89db-11d3af737ee1",
"createdAt": "2023-03-22T20:45:06.020Z",
"flow": {
"version": "0.0.0",
"root": [
{
"rule": "provider",
"id": "z1babb21-6a4c-987d-89db-11d3af737ee1"
}
]
},
"restoredFrom": "df601922-e024-6394-8f12-af21ec4218b1"
}
}
]
}
},
"meta": {
"allOf": [
{
"properties": {
"itemCount": {
"type": "integer",
"description": "quantidade de itens na página"
},
"totalItems": {
"type": "integer",
"description": "quantidade total de itens na consulta (esse valor é mantido em cache por 5 minutos para melhorar a performance da API)"
},
"itemsPerPage": {
"type": "integer",
"description": "quantidade de itens por página"
},
"totalPages": {
"type": "integer",
"description": "quantidade total de páginas"
},
"currentPage": {
"type": "integer",
"description": "página atual"
}
}
}
]
}
},
"example": {
"items": [
{
"id": "b4ced0dd-2136-4bce-a231-364e93554073",
"paymentMethod": "credit",
"clientId": "f1babb21-6a4c-323d-12db-69d3af407ee1",
"merchants": [
{
"merchantId": "z1babb21-6a4c-987d-89db-11d3af737ee1"
}
],
"parentId": "g1babb21-6a4c-987d-89db-11d3af737ee1",
"createdAt": "2023-03-22T20:45:06.020Z",
"flow": {
"version": "0.0.0",
"root": [
{
"rule": "provider",
"id": "z1babb21-6a4c-987d-89db-11d3af737ee1"
}
]
},
"restoredFrom": "df601922-e024-6394-8f12-af21ec4218b1"
}
],
"meta": {
"itemCount": 10,
"totalItems": 20,
"itemsPerPage": 10,
"totalPages": 5,
"currentPage": 2
}
}
}
Authorizations
Query Parameters
número da página
quantidade de itens por página
usado para filtrar os fluxos por merchantId
usado para filtrar os fluxos por método de pagamento
Response
identificador único do fluxo
método de pagamento a qual aquele fluxo é relacionado
identificador do cliente dono do fluxo
identificador do merchant relacionado ao fluxo
identificador do fluxo que originou o novo
identificador do fluxo do qual este foi restaurado
data e hora em que o fluxo foi criado (UTC)
dados do fluxo que será cadastrado
quantidade de itens na página
quantidade total de itens na consulta (esse valor é mantido em cache 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/flows \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>'
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "identificador único do fluxo"
},
"paymentMethod": {
"type": "string",
"description": "método de pagamento a qual aquele fluxo é relacionado"
},
"clientId": {
"type": "string",
"description": "identificador do cliente dono do fluxo"
},
"merchants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "identificador do merchant relacionado ao fluxo"
}
}
}
},
"parentId": {
"type": "string",
"description": "identificador do fluxo que originou o novo"
},
"restoredFrom": {
"type": "string",
"description": "identificador do fluxo do qual este foi restaurado"
},
"createdAt": {
"type": "string",
"description": "data e hora em que o fluxo foi criado (UTC)"
},
"flow": {
"type": "object",
"description": "dados do fluxo que será cadastrado"
}
},
"example": {
"id": "b4ced0dd-2136-4bce-a231-364e93554073",
"merchants": [
{
"merchantId": "z1babb21-6a4c-987d-89db-11d3af737ee1"
}
],
"paymentMethod": "credit",
"clientId": "f1babb21-6a4c-323d-12db-69d3af407ee1",
"parentId": "g1babb21-6a4c-987d-89db-11d3af737ee1",
"createdAt": "2023-03-22T20:45:06.020Z",
"flow": {
"version": "0.0.0",
"root": [
{
"rule": "provider",
"id": "z1babb21-6a4c-987d-89db-11d3af737ee1"
}
]
},
"restoredFrom": "df601922-e024-6394-8f12-af21ec4218b1"
}
}
]
}
},
"meta": {
"allOf": [
{
"properties": {
"itemCount": {
"type": "integer",
"description": "quantidade de itens na página"
},
"totalItems": {
"type": "integer",
"description": "quantidade total de itens na consulta (esse valor é mantido em cache por 5 minutos para melhorar a performance da API)"
},
"itemsPerPage": {
"type": "integer",
"description": "quantidade de itens por página"
},
"totalPages": {
"type": "integer",
"description": "quantidade total de páginas"
},
"currentPage": {
"type": "integer",
"description": "página atual"
}
}
}
]
}
},
"example": {
"items": [
{
"id": "b4ced0dd-2136-4bce-a231-364e93554073",
"paymentMethod": "credit",
"clientId": "f1babb21-6a4c-323d-12db-69d3af407ee1",
"merchants": [
{
"merchantId": "z1babb21-6a4c-987d-89db-11d3af737ee1"
}
],
"parentId": "g1babb21-6a4c-987d-89db-11d3af737ee1",
"createdAt": "2023-03-22T20:45:06.020Z",
"flow": {
"version": "0.0.0",
"root": [
{
"rule": "provider",
"id": "z1babb21-6a4c-987d-89db-11d3af737ee1"
}
]
},
"restoredFrom": "df601922-e024-6394-8f12-af21ec4218b1"
}
],
"meta": {
"itemCount": 10,
"totalItems": 20,
"itemsPerPage": 10,
"totalPages": 5,
"currentPage": 2
}
}
}