Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Transactions

Get transaction (transaction banking)

Gets transaction using transaction ID.

get/corporate/v1/corporate-transactions/{transactionId}

Path parameters

transactionIdinteger required

Transaction ID

Response

OK

idstring

Transaction ID

program_idinteger

Program ID. This is a client-provided ID.

account_idinteger

Account ID

external_account_idstring

Custom account ID. Used as the key for all operations (manage accounts, transactions, etc.) on the corporate layer.

This field is:

  • Unique within the Organization
  • Immutable: The field cannot be updated.
  • Not recyclable: You can't reuse an external account ID, even if the account that was using it has been canceled.
soft_descriptorstring

Brief description that helps to identify a particular transaction on the bank statement.

processing_codestring

Processing code for the debit transaction.

If split_transaction is false (the default), each installment payment is recorded as one debit transaction equal to the installment amount minus the discount, and processing_code is the processing code for that transaction.

If split_transaction is true, each installment payment is recorded as two transactions: a debit transaction for the installment amount and a credit transaction for the discount. In this case, processing_code is the processsing code for the debit transaction, and second_processing_code is the processing code for the credit transaction.

processing_descriptionstring

Processing code description

amountnumber double

Fee amount.

event_datestring yyyy-mm-dd hh:mm:ss

Date and time when the event was received in the Protection Bulletin.

payment_datestring date-time

Date and time of the payment. Specifying a payment_datetime value impacts the account balance history.<br> <b>Notes</b>:

  • The payment datetime is in ISO 8601 format.
  • You can backdate payments a maximum of 390 calendar days. You can postdate payments a maximum of 10 calendar days.
created_atstring date-time

Transaction creation date in format ISO 8601

transaction_type'TRANSFER' | 'CHANGE' | 'WITHDRAWAL' | 'REFUND_AUTOMATIC_PIX' | 'REFUND'

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)
metadatastring

Any data object with key/value pairs. No limit on length.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

Example response

{
  "id": "E9999901012341234123412345678900",
  "program_id": 2222,
  "account_id": 6912345,
  "external_account_id": "b993ba96-b3e8-4ef7-9cf7-7eee5ddafdab",
  "soft_descriptor": "ACME Inc. - Invoice 2938",
  "processing_code": "99066",
  "processing_description": "Hold Funds",
  "amount": 215,
  "event_date": "2025-04-22 20:31:50",
  "payment_date": "2023-03-10T19:05:56.743Z",
  "created_at": "2023-04-27T12:01:24Z",
  "transaction_type": "TRANSFER",
  "authorization": {
    "id": 1099901,
    "role_type": "SECONDARY_INSTALLMENT",
    "created_at": "2024-09-12T16:46:16.43663522",
    "updated_at": "2024-09-12T16:46:16.43663522",
    "account_id": 6912345,
    "recurrence_id": "RN000000012025050500012345678",
    "expiration_date": "2803",
    "provider_created_at": "2024-09-12T16:46:16.43663522",
    "provider_updated_at": "2024-09-12T16:46:16.43663522",
    "max_payment_amount": 86753.09,
    "reason_code": "AC01",
    "payer": {
      "document_number": "7777888hh",
      "document_type": "NATURAL_PERSON",
      "name": "Paul Bearer",
      "bank": "237",
      "branch": "011",
      "account_number": "98765432",
      "account_type": "TRAN",
      "city_code": "3550308"
    },
    "rec_payload": {
      "recurrence_id": "RN000000012025050500012345678",
      "contract_id": "5509-uroo-78944-9987",
      "description": "Gym membership",
      "amount": 215,
      "min_payment_amount": 10.09,
      "frequency_type": "MONTH",
      "first_payment_date": "2025-04-25",
      "payee": {
        "name": "Paul Bearer",
        "document_number": "7777888hh",
        "document_type": "NATURAL_PERSON",
        "bank": "237",
        "branch": "011",
        "account_number": "98765432",
        "account_type": "TRAN"
      },
      "debtor": {
        "document_number": "7777888hh",
        "document_type": "NATURAL_PERSON",
        "name": "Paul Bearer"
      }
    }
  },
  "metadata": "{ \"key\": \"value\"}"
}