Search Payment Instrument Entry by Key

The payment instrument entry search by key will return the complete details of a specific entry, including all related invoice items.

Request

ENDPOINT

/wallet/WALLET_KEY/payment_instrument/PAYMENT_INSTRUMENT_KEY/payment_instrument_entry/PAYMENT_INSTRUMENT_ENTRY_KEY

METHOD

GET

Path Parameters

Field	Type	Description	Characters
wallet_key	uuidv4	Unique wallet key in UUID v4 format	36
payment_instrument_key	uuidv4	Unique payment instrument key in UUID v4 format	36
payment_instrument_entry_key	uuidv4	Unique entry key in UUID v4 format	36

Response

STATUS

200

Response Body: Payment instrument entry details

{
  "payment_instrument_entry_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "payment_instrument_entry_amount": 150.00,
  "payment_instrument_entry_type": "purchase",
  "payment_instrument_entry_status": "concluded",
  "payment_instrument_entry_data": {
    "merchant_name": "Merchant Name",
    "merchant_country": "Merchant Country",
    "merchant_postal_code": "Merchant Postal Code",
    "merchant_city": "Merchant City",
    "merchant_street": "Merchant Street"
  },
  "invoice_items": [
    {
      "invoice_item_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "invoice_key": "f2cad6b4-2a68-9572-99a7-2849c8d6ecf8",
      "wallet_entry_key": null,
      "payment_instrument_entry_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "installment_number": 1,
      "invoice_description": "Compra no estabelecimento XYZ",
      "amount": 150.00,
      "used_limit": 150.00,
      "invoice_item_status": "concluded",
      "invoice_item_due_date": "2024-02-15",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "created_at": "2024-01-15T10:30:00Z"
}

Response Body Params

Field	Type	Description	Characters
payment_instrument_entry_key *	uuidv4	Unique entry identification key in uuid v4 format	36
payment_instrument_entry_amount *	number	Entry amount	-
payment_instrument_entry_type *	string	Payment instrument entry type	payment_instrument_entry_type Enumerators
payment_instrument_entry_status *	string	Payment instrument entry status	payment_instrument_entry_status Enumerators
invoice_items *	object array	Related invoice items	invoice_item Object
payment_instrument_entry_data	object	Additional data	payment_instrument_entry_data Object
created_at *	string	Creation date (ISO 8601 UTC format)	-

payment_instrument_entry_data Object (purchase | withdraw)

Field	Type	Description	Characters
merchant_name *	string	Merchant establishment name	-
merchant_country *	string	Merchant establishment country	-
merchant_postal_code *	string	Merchant establishment postal code	-
merchant_city *	string	Merchant establishment city	-
merchant_street *	string	Merchant establishment street	-

payment_instrument_entry_data Object (postpaid_card_issuance)

Field	Type	Description	Characters
postpaid_card_issuance_name *	string	Postpaid card issuance name	-
payment_instrument_key *	string	Unique payment instrument key in UUID v4 format	36
postpaid_card_key *	string	Unique postpaid card key in UUID v4 format	36

Note

This entry exists only for consigned card wallet cards.

payment_instrument_entry_type Enumerators

Enumerator	Description
purchase	Purchase
withdraw	Withdrawal
postpaid_card_issuance	Postpaid card issuance

payment_instrument_entry_status Enumerators

Enumerator	Description
processing_conclusion	Entry in processing conclusion
processing_cancellation	Entry in processing cancellation
concluded	Concluded entry
canceled	Canceled entry

Note

The payment instrument entry can transition directly from processing_conclusion to processing_cancellation and canceled. In this case, no invoice item is created.

invoice_item Object

Field	Type	Description	Characters
invoice_item_key *	uuidv4	Unique invoice item identification key in uuid v4 format	36
invoice_key *	uuidv4	Unique invoice identification key in uuid v4 format	36
wallet_entry_key	uuidv4	Unique wallet entry identification key in uuid v4 format	36
payment_instrument_entry_key	uuidv4	Unique payment instrument entry identification key in uuid v4 format	36
installment_number *	integer	Installment number	-
invoice_description *	string	Invoice item description	-
amount *	number	Item amount	-
used_limit *	number	Used limit	-
invoice_item_status *	string	Invoice item status	invoice_item_status Enumerators
invoice_item_due_date *	string	Item due date (YYYY-MM-DD format)	10
created_at *	string	Creation date (ISO 8601 UTC format)	-

invoice_item_status Enumerators

Enumerator	Description
concluded	Concluded item (invoice to which it belongs has not been paid)
canceled	Canceled item

Error Response

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

HTTP Code status	QI Code code	Title title	Description (eng) description	Description (pt-br) translation
404	CIN000007	Wallet not Found	Wallet with key: abeca0d0-a09d-4b3b-a495-40b553422ced was not found	Carteira com a chave: abeca0d0-a09d-4b3b-a495-40b553422ced não foi encontrado
404	CIN000017	Payment Instrument Not Found	Payment instrument was not found	Instrumento de pagamento não foi encontrado
404	CIN000086	Not Found	Payment instrument entry was not found	Transação para instrumento de pagamento não foi encontrada