PIpismo
Merchant transaction

Get merchant transaction

Get transaction details using merchant transaction ID

get/v2/merchants/{merchantId}/transactions/{merchantTransactionId}

Request

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

Path parameters

merchantIdinteger required
Example:1

Merchant ID

merchantTransactionIdinteger required
Example:1

Merchant Transaction ID

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

idinteger

Merchant transaction ID

authorization_idstring

Authorization ID

parent_authorization_idstring

Parent authorization ID

typestring

Transaction type. Examples of transaction types include cash-in and cash-out. See <a href="https://developers.pismo.io/pismo-docs/docs/transactions-overview#transaction-types">Transaction types</a> for the list of transaction types on the Pismo platform.

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

Transaction status

merchant_idinteger

Merchant ID

org_operation_idinteger

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>.

creditor_idinteger

Creditor ID

installmentinteger

Installment number of transaction

number_of_installmentsinteger

Number of installments

amountnumber double

Transaction total (gross) amount

mdr_amountnumber double

Merchant discount rate (MDR) amount

mdr_taxnumber double

Merchant discount rate (MDR) tax amount

transaction_feenumber double

Fixed transaction fee

mdr_without_feenumber

Merchant discount rate (MDR) minus transaction fee

advancement_discountnumber double

Advancement discount

advanced_amountnumber double

Advanced amount

event_datestring datetime

The transaction event date and time (sale or refund). UTC date/time - format: yyyy-MM-ddThh:mm:ssZ

scheduled_payment_datestring date

Scheduled payment date. Format = yyyy-mm-dd.

origin_transaction_idinteger

ID of parent merchant transaction. If sale, this is null. If refund, this is the transaction ID of the sale.

marketplace_idinteger

Marketplace ID

discount_amountnumber double

Total discount amount applied to the transaction

Example response

{
  "id": 123456,
  "authorization_id": "992023",
  "parent_authorization_id": "992022",
  "type": "SALE",
  "status": "PENDING",
  "merchant_id": 13,
  "org_operation_id": 51,
  "creditor_id": 80,
  "installment": 1,
  "number_of_installments": 3,
  "amount": 155.5,
  "mdr_amount": 5.5,
  "mdr_tax": 0,
  "transaction_fee": 0.6,
  "mdr_without_fee": 4.9,
  "advancement_discount": 0,
  "advanced_amount": 0,
  "event_date": "2023-08-26T12:58:32Z",
  "scheduled_payment_date": "2023-09-10",
  "origin_transaction_id": 123455,
  "marketplace_id": 21,
  "discount_amount": 5.5,
  "discount_details": [
    {
      "name": "MDR",
      "amount": 4.9
    },
    {
      "name": "FEE",
      "amount": 0.6
    }
  ]
}

Changes

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