PIpismo
Merchant advancement transaction

List transactions

Search for the balance of future schedules, consolidated by expected settlement date. In a head (centralizing) and branch (centralized) scenario, the transaction sum from all merchant branches is listed.

get/v1/marketplaces/{marketplaceId}/merchants/{merchantId}/transactions

Request

  • Base URL
    https://sandbox.pismolabs.io/merchants
  • URL
    https://sandbox.pismolabs.io/merchants/v1/marketplaces/{marketplaceId}/merchants/{merchantId}/transactions
  • Auth
    none declared. Required headers: Authorization

Path parameters

marketplaceIdinteger required

Marketplace ID

merchantIdinteger required

Merchant ID

Query parameters

startPaymentDatestring date

If not sent, the default value for the start date is the next day.<br> The date format used is ISO8601. minLength: 10 maxLength: 10

Date from which to search for a transaction

endPaymentDatestring date

If not sent, the default end date value is the start day plus seven days.<br> The date format used is ISO8601. minLength: 10 maxLength: 10

End date for searching transactions

Headers

Authorizationstring required

Authorization token

Example:<your_token>

Response

OK

currency_codestring

ISO-4217 alphabetic (3 characters) currency code.

Example response

{
  "currency_code": "BRL",
  "items": [
    {
      "scheduled_payment_date": "2023-10-29",
      "gross_value": 250,
      "discount": 8.25,
      "net_value": 241.75,
      "details": [
        {
          "merchant_id": 40305,
          "merchant_name": "Merchant Name",
          "gross_value": 250,
          "discount": 8.25,
          "net_value": 241.75,
          "tax": {
            "discount_rate": 0.05,
            "maximum_advancement_percentage": 1
          }
        }
      ]
    }
  ],
  "totals": {
    "gross_value": 650,
    "discount": 8.25,
    "net_value": 641.75
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.