v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Listar cobranças

get/charges/

Query parameters

codestring

Código de referência da cobrança no sistema da loja

statusstring

Status da cobrança. Valores possíveis: pending, paid, canceled, processing, failed, overpaid ou underpaid

payment_methodstring

Meio de pagamento. Valores possíveis: credit_card, boleto, bank_transfer, safetypay ou voucher

customer_idstring

Código do cliente.

order_idstring

Código do pedido.

created_sincestring date

Data de início do período de criação a ser listado.

created_untilstring date

Data de final do período de criação a ser listado.

pageinteger

Página atual.

sizeinteger

Quantidade de itens por página.

Response

200

Example response

{
  "data": [
    {
      "id": "ch_NLJjZ99IoHXKgk38",
      "code": "N1OJFMGA0M",
      "amount": 1490,
      "paid_amount": 1490,
      "status": "paid",
      "currency": "BRL",
      "payment_method": "credit_card",
      "paid_at": "2019-01-22T14:49:45Z",
      "created_at": "2019-01-22T14:49:44Z",
      "updated_at": "2019-01-22T14:49:44Z",
      "customer": {
        "id": "cus_PYwJvWgOTmiqvW8m",
        "name": "Tony Stark",
        "email": "toinhodalua@nasa.com",
        "created_at": "2019-01-18T11:50:37Z",
        "updated_at": "2019-01-18T15:46:38Z"
      },
      "last_transaction": {
        "id": "tran_DvedVaeSWLfKDwXj",
        "transaction_type": "credit_card",
        "funding_source": "prepaid",
        "gateway_id": "775844a3-5c04-4ad2-a8d7-86cdcb42e8e7",
        "amount": 1490,
        "status": "captured",
        "success": true,
        "installments": 1,
        "statement_descriptor": "AVENGERS",
        "acquirer_tid": "30e4f16b-5cf9-4173-aa0b-756cbbd5af35",
        "acquirer_nsu": "30e4f16b-5cf9-4173-aa0b-756cbbd5af35",
        "acquirer_auth_code": "859",
        "acquirer_message": "Transação capturada com sucesso",
        "acquirer_return_code": "00",
        "operation_type": "auth_and_capture",
        "card": {
          "id": "card_jdK2O53TqfnxwRDY",
          "first_six_digits": "400000",
          "last_four_digits": "0010",
          "brand": "Visa",
          "holder_name": "Tony Stark",
          "exp_month": 1,
          "exp_year": 2030,
          "status": "active",
          "type": "credit",
          "created_at": "2019-01-18T12:25:41Z",
          "updated_at": "2019-01-22T14:39:01Z",
          "billing_address": {
            "zip_code": "90265",
            "city": "Malibu",
            "state": "CA",
            "country": "US",
            "line_1": "10880, Malibu Point, Malibu Central"
          }
        },
        "created_at": "2019-01-22T14:49:44Z",
        "updated_at": "2019-01-22T14:49:44Z",
        "gateway_response": {
          "code": "200"
        }
      },
      "metadata": {
        "code": "123"
      }
    }
  ],
  "paging": {
    "total": 80,
    "next": "https://api.mundipagg.com/core/v1/charges?page=2&size=2"
  }
}