PIpismo
Merchant transactions

Create merchant transaction

Create a new merchant transaction (sale) for a specific merchant associated with a marketplace.

This endpoint allows for the creation of merchant sale transactions with installment support, MDR calculations, and scheduled payment dates. The default status is SCHEDULED. However, if the merchant is a marketplace scheduler, the transaction will automatically be set to WAITING_SPLIT status.

This endpoint generates a Merchant transaction created event.

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

Request

  • Base URL
    https://sandbox.pismolabs.io/sellers
  • URL
    https://sandbox.pismolabs.io/sellers/v1/marketplaces/{marketplaceId}/merchants/{merchantId}/transactions
  • Auth
    HTTP bearer

Path parameters

marketplaceIdinteger required

Marketplace ID

merchantIdinteger required

Merchant ID

Headers

Authorizationstring required

Authorization token

Request body

event_datestring datetime required

Event datetime. The datetime format follows the ISO 8601 format (UTC).

amountnumber float required

Merchant transaction amount

installmentsinteger required

Number of installments

processing_codestring required

Processing code.<br> For more information, refer to Processing codes.

currency_codestring

Represents the currency with an ISO-4217 alphabetic or numeric (3 characters) string. For example, you represent Brazilian real with either BRL or 986. If you don't provide this code, the system uses the currency from the merchant program.

authorization_idnumber nullable

Authorization identifier

transaction_status'PENDING' | 'SCHEDULED' | 'SETTLED' | 'CANCELED' | 'WAITING_SPLIT' nullable

Defines the status of the merchant transaction request.

  • The default value is SCHEDULED for merchant schedulers, or WAITING_SPLIT for marketplace schedulers.
  • The WAITING_SPLIT status should only be used when the transaction needs to wait for split request processing, and only if the merchant_id provided is the schedule_id.
  • The schedule_id can be obtained through the marketplace query API.

Example request

{
  "event_date": "2023-01-01T12:00:00Z",
  "installments": 1,
  "processing_code": "999999",
  "currency_code": "BRL"
}

Response

Successfully list merchant transactions

Example response

{
  "items": [
    {
      "merchant_id": 1,
      "installment": 1,
      "number_of_installments": 1,
      "event_date": "2023-01-01T12:00:00Z",
      "scheduled_payment_date": "2023-01-02",
      "marketplace_id": 1,
      "currency_code": "BRL",
      "discount_amount": 1.99,
      "discount_details": [
        {
          "name": "EMISSION_FEE",
          "amount": 10
        }
      ]
    }
  ]
}

Changes

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