GET
/
v1
/
charges
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

X-Client-Id
string
headerrequired
X-Api-Key
string
headerrequired

Query Parameters

page
number

numero da pagina ativa

limit
number

quantidade de registros por página 1-100

sort
enum<string>

tipo de ordenação decrescente ou crescente

Available options:
ASC,
DESC
merchantId
string

id do merchant processado na cobrança

id
string

id da cobrança

originalAmount
number

valor em centavos da cobrança

status
enum<string>

status da cobrança

Available options:
pending,
pre_authorized,
authorized,
voided,
refund_pending,
canceled,
charged_back,
capture_pending
paymentType
enum<string>

tipo de pagamento

Available options:
credit,
pix,
boleto
orderId
string

id da cobrança gerado pelo cliente

created
string

registros criados em uma data específica

created.gt
string

registros com data maior que

created.lt
string

registros com data menor que

Response

200 - application/json
meta
object
items
any[]