Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Transaction types

Get transaction type

Get a transaction type, given the transaction type ID.

get/v1/transaction-type/{transactionTypeId}

Path parameters

transactionTypeIdinteger required

Transaction type ID.

Response

OK

'TRANSFER' | 'CHANGE' | 'WITHDRAWAL' | 'REFUND_AUTOMATIC_PIX' | 'REFUND' required

Type of transaction the QR Code validation generates.

  • TRANSFER - Standard immediate transfer payment.
  • CHANGE - Occurs when the QR Code validation returns CHANGE. For example, the customer buys something and pays more than the product value to receive the difference in cash.
  • WITHDRAWAL - Occurs when the QR Code validation returns WITHDRAWAL with withdrawal object values.
  • REFUND_AUTOMATIC_PIX - Total or partial to the PSP payer user within the Automatic Pix MED (Pix return mechanism) scope (only when initiated by a MANUAL).
  • REFUND = Total or partial refund to the paying user within the scope of MED 2.0, when this refund occurs from the PI Account of the user's PSP who participated in the distribution chain of the resources of the original transaction (only when initiated by a MANUAL)

Example response

"TRANSFER"