PIpismo
Split requests

Get split request details

Get the details of a specific split request in a marketplace.

get/v1/marketplaces/{marketplaceId}/split-requests/{splitId}

Request

  • Base URL
    https://sandbox.pismolabs.io/sellers
  • URL
    https://sandbox.pismolabs.io/sellers/v1/marketplaces/{marketplaceId}/split-requests/{splitId}
  • Auth
    HTTP bearer

Path parameters

splitIdinteger required

Split request ID

marketplaceIdinteger required

Marketplace ID

Headers

Authorizationstring required

Authorization token

Response

Successfully get split request totals

idinteger

Split request ID

event_datestring datetime

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

amountnumber float

Split request amount

currency_codestring

ISO-4217 alphabetic (3 characters) currency code

installmentsinteger

Number of installments

processing_codestring

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

merchant_transaction_idinteger

Merchant transaction identifier

marketplace_idinteger

Marketplace ID

parent_idinteger nullable

Parent ID assigned to the child split request

type'SALES' | 'CANCELLATION'

Split request type

status'PENDING' | 'PROCESSED' | 'ERROR'

Split request status

messagestring nullable

Message associated with the split request

Example response

{
  "event_date": "2023-01-01T12:00:00Z",
  "currency_code": "BRL",
  "installments": 1,
  "processing_code": "999999",
  "marketplace_id": 1,
  "definitions": [
    {
      "merchant_id": 1,
      "transaction_status": "SCHEDULED",
      "processing_code": "999999"
    }
  ]
}

Changes

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