PIpismo
Merchant transaction

List merchant transactions (V2)

List merchants transactions filtered using query parameters.

<b>NOTE</b>: By default, the endpoint returns only 60 days of merchant transactions. If you want a longer period (up to 365 days), you must provide the saleAuthorizationId parameter, and specify a desired date in both startEventDate and endEventDate.

get/v2/merchants/{merchantId}/transactions

Request

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

Path parameters

merchantIdinteger required
Example:1

Merchant ID

Query parameters

originTransactionIdinteger
Example:1

Merchant's original transaction ID. If it's a sale, then it's null; if it's a refund, then it refers to the transaction ID of a sale.

authorizationIdinteger
Example:112345

Authorization ID. Automatically generated unique identifier used in any flow where a transaction is created, whether sale, resale or cancellation.

saleAuthorizationIdinteger
Example:112345

Authorization ID of sale. This refers to the authorization ID of a transaction to which the current transaction is tied. For example, when you cancel a transaction, saleAuthorizationId is the authorizationId of the transaction that you are cancelling.

Example of a sale: authorizationId: 101011

Cancelling this sale: authorizationId: 101012, saleAuthorizationId : 101011

orderIdinteger
Example:1

Marketplace authorization (external or internal) ID

status'PENDING' | 'SCHEDULED' | 'BLOCKED' | 'SETTLED' | 'PAID' | 'ADVANCED' | 'CANCELED' | 'RETURNED'
Example:SCHEDULED

Transaction status

startEventDatestring date
Example:2020-01-01

Date authorization is generated (and associated event emitted). Format is yyyy-mm-dd.

endEventDatestring date
Example:2020-01-02

End date of transaction event. Format is yyyy-mm-dd.

startPaymentDatestring date
Example:2020-01-01

Scheduled payment start date. Find scheduled payments between this date and endPaymentDate. Format = yyyy-mm-dd.

endPaymentDatestring date
Example:2020-01-02

Scheduled payment end date. Format = yyyy-mm-dd. Find scheduled payments between startPaymentDate and this date.

startReceiptDatestring date
Example:2020-01-01

Start date of merchant transaction settlement. Format is yyyy-mm-dd.

endReceiptDatestring date
Example:2020-01-02T00:00:00.000Z

End date of merchant transaction settlement. Format is yyyy-mm-dd.

operationinteger
Example:1

Transaction operation description

orgOperationIdinteger
Example:1

Processing code. See <a href="https://developers.pismo.io/pismo-docs/docs/processing-codes-and-transaction-types" target="_blank">Processing codes and transaction types</a>.

grossValuenumber float
Example:12.01

Gross amount of the transaction. startEventDate and endEventDate must be on the same date. For example: grossValue: 100, startEventDate: 2023-03-01, endEventDate: 2023-03-01,

netValuenumber float
Example:10.01

Net amount of the transaction. startEventDate and endEventDate must be on the same date. For example: netValue: 101, startEventDate: 2023-04-01, endEventDate: 2023-04-01

pageinteger
Example:1

Page number. Default is 1.

perPageinteger
Example:10

Items per page. Default is 10.

Headers

Content-Typestring
Example:application/json

Content type

Authorizationstring
Example:Bearer 1JI12J39182H39182JDIOAWJ%=

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

Response

OK

total_itemsinteger

Total number of items

per_pageinteger

Number of items per page

pagesinteger

Number of pages

current_pageinteger

Current page number

Example response

{
  "total_items": 74,
  "per_page": 10,
  "pages": 8,
  "current_page": 1,
  "items": [
    {
      "id": 2,
      "origin_transaction_id": 1,
      "authorization_id": "13387693",
      "sale_authorization_id": "13387693",
      "order_id": 1,
      "type": "SALES",
      "number_of_installments": 3,
      "installment": 2,
      "gross_value": 3600.02,
      "net_value": 3582.02,
      "discount": -18,
      "advanced_amount": 0.1,
      "operation_type": 89,
      "operation": "Credit card without quotas",
      "event_date": "2020-07-14T00:41:29Z",
      "payment_date": "2020-07-16",
      "receipt_date": "2020-07-16",
      "received_value": 0.1,
      "status": "SCHEDULED",
      "meta": [
        {
          "name": "MarketplaceAuthorization",
          "value": "ashga-jwjh-huahu-wquiqw"
        },
        {
          "name": "MarketplaceTransaction",
          "value": "wquiqw-jwjh-huahu-ashga"
        }
      ]
    }
  ],
  "tax": {
    "mdr": [
      {
        "description": "Merchant Discount Rate",
        "operation_type": 1,
        "mdr": 0.03,
        "days_to_payment": 30
      }
    ]
  }
}

Changes

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