Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Automatic Pix data

Get payment order

Get payment order information with end-to-end ID, the Pix transaction identifier from the Central Bank of Brazil (BACEN)

get/inst-pull-pay/v1/pix/automatic/payment/order/{end_to_end_id}

Path parameters

end_to_end_idstring required

Transaction end-to-end ID. This field is a Brazil Central Bank (BCB) requirement to track all Pix transaction steps.

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Response

OK

account_idinteger

Account ID

recurrence_idstring

BACEN recurrence ID

end_to_end_idstring

This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction 2. Confirm a transaction The end_to_end_id is sent to the BCB in both steps in order to identify all transaction information.

status'PENDING' | 'WAITING_CUSTOMER' | 'REGISTERED' | 'ACTIVE' | 'CANCELLED' | 'CANCELLING' | 'EXPIRED' | 'REJECTED' | 'CONCLUDED'

Payment order status:

  • PENDING - Payment order exists in the database.
  • WAITING_CUSTOMER- Waiting on the payee to update the payment order amount. Refer to the Update order endpoint.
  • REGISTERED - Payment order was registered to SPI instant payment system.
  • ACTIVE - Payer PSP accepted payment order.
  • REJECTED - Payer PSP rejected payment order. Check reason.code and reason.description.
  • CANCELLING - Payment order was previously accepted, cancel process has begun. and it's waiting on counterparty acknowledgement.
  • CANCELLED - Payment order was previously accepted and then cancelled. Check reason.code and reason.description.
  • EXPIRED - Pix transaction was not found by the due date. Will trigger retry if applicable to the recurrence.
  • CONCLUDED - Pix transaction was found and payment order is concluded.
transaction_identificationstring

Transaction ID from a successful payment. REQUIRED for the AUT3 journey.

amountnumber double

Fee amount.

dynamic_amountboolean

Does recurrence have a dynamic amount?

If true, min_payment_amount is REQUIRED.

If false, amount is REQUIRED. Default is false.

additional_informationstring

Additional information

max_payment_amountnumber

Payer-defined maximum payment amount for dynamic amount recurrences.

min_amount_allowednumber

Minimum payment amount for dynamic amount recurrences, defined by payee.

created_atstring date-time

Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.

updated_atstring date-time

Datetime program calendar strategy was updated. Format = YYYY-MM-DDTHH:MM:SS:MM

Example response

{
  "account_id": 6912345,
  "recurrence_id": "RN000000012025050500012345678",
  "end_to_end_id": "E3030629420200808195101608910248",
  "status": "PENDING",
  "transaction_identification": "ttx2020010300000000000000000000001",
  "calendar": {
    "due_date": "2030-10-10"
  },
  "amount": 215,
  "max_payment_amount": 86753.09,
  "min_amount_allowed": 10.09,
  "reason": {
    "code": "ACCT",
    "description": "Paying user's account has been closed."
  },
  "payer": {
    "document_number": "7777888hh",
    "document_type": "NATURAL_PERSON",
    "name": "Paul Bearer",
    "bank": "237",
    "branch": "011",
    "account_number": "98765432",
    "account_type": "TRAN",
    "city_code": "3550308"
  },
  "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"
  },
  "created_at": "2024-09-12T16:46:16.43663522",
  "updated_at": "2024-09-12T16:46:16.43663522",
  "taxes": {
    "tax_identifier": "IS0435879820240605bcdb1fhn43a",
    "records": [
      {
        "tax_type": "IBS",
        "tax_category": "INF",
        "amount": 1050.44
      }
    ]
  }
}