PIpismo
Merchant transaction

Get transactions summary [beta]

Returns the transactions totals summarized by status and/or date. When the groupBy is provided with the values date or dateAndStatus the date range between startPaymentDate and endPaymentDate must not exceed 30 days.

get/v2/merchants/{merchantId}/transactions-totals

Request

  • Base URL
    https://sandbox.pismolabs.io/merchants
  • URL
    https://sandbox.pismolabs.io/merchants/v2/merchants/{merchantId}/transactions-totals
  • Auth
    HTTP bearer

Path parameters

merchantIdinteger required
Example:1

Merchant ID

Query parameters

startPaymentDatestring date required
Example:2020-01-01

Initial scheduled payment date used to filter the transactions. Format yyyy-mm-dd. Finds scheduled payments between this date and endPaymentDate.

endPaymentDatestring date required
Example:2020-01-02

Final scheduled payment date used to filter the transactions. Format yyyy-mm-dd. Finds scheduled payments between startPaymentDate and this date.

marketplaceIdinteger
Example:12

Marketplace ID used as filter. When provided, it returns the values of the transactions belonging only to the marketplace. When not provided, it returns the values of all transactions for the provided Merchant ID.

statusstring
Example:SCHEDULED

Transaction status used as a filter. When provided, it returns the values of the transactions matching this status.

groupBy'status' | 'date' | 'dateAndStatus'
Example:status

Group the returned entries by this criteria. The default value is status.

  • For the status value, returns one item per different status in the response.
  • For the date value, returns one item per day between the startPaymentDate and endPaymentDate that have transaction values for the filters. The response is ordered by day in ascending order.
  • For the dateAndStatus value, returns one item per day and status. The response is ordered by day and status in ascending order.

Headers

Authorizationstring
Example:Bearer 1JI12J39182H39182JDIOAWJ%=

Authorization token. This is a regular access token, which does not need to include an account ID.

Response

OK

Example response

{
  "items": [
    {
      "gross_amount": "200.0",
      "net_amount": "200.0",
      "discount_amount": "0.0",
      "status": "PENDING",
      "scheduled_payment_date": "2024-03-20"
    },
    {
      "gross_amount": "50.0",
      "net_amount": "35.5",
      "discount_amount": "14.5",
      "status": "SCHEDULED",
      "scheduld_payment_date": "2024-03-20"
    }
  ],
  "totals": {
    "gross_amount": "250.0",
    "discount_amount": "14.5",
    "net_amount": "235.5"
  }
}

Changes

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