Buscar Entrada de Instrumento de Pagamento por Chave

A busca de entrada de instrumento de pagamento por chave retornará os detalhes completos de uma entrada específica, incluindo todos os itens da fatura relacionados.

Request

ENDPOINT

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

MÉTODO

GET

Path Parameters

Campo	Tipo	Descrição	Caracteres
wallet_key	uuidv4	Chave única da carteira no formato UUID v4	36
payment_instrument_key	uuidv4	Chave única do instrumento de pagamento no formato UUID v4	36
payment_instrument_entry_key	uuidv4	Chave única da entrada no formato UUID v4	36

Response

STATUS

200

Response Body: Detalhes da entrada de instrumento de pagamento

{
  "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": "3571e292-3a83-4011-904d-20ee963022ef",
      "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

Campo	Tipo	Descrição	Caracteres
payment_instrument_entry_key *	uuidv4	Chave única de identificação da entrada no formato uuid v4	36
payment_instrument_entry_amount *	number	Valor da entrada	-
payment_instrument_entry_type *	string	Tipo da entrada do instrumento de pagamento	Enumeradores payment_instrument_entry_type
payment_instrument_entry_status *	string	Status da entrada do instrumento	Enumeradores payment_instrument_entry_status
invoice_items *	object array	Itens da fatura relacionados	Objeto invoice_item
payment_instrument_entry_data	object	Dados do adicionais	Objeto payment_instrument_entry_data
created_at *	string	Data de criação (formato ISO 8601 UTC)	-

Objeto payment_instrument_entry_data (purchase | withdraw)

Campo	Tipo	Descrição	Caracteres
merchant_name *	string	Nome do estabelecimento comercial	-
merchant_country *	string	País do estabelecimento comercial	-
merchant_postal_code *	string	Código postal do estabelecimento comercial	-
merchant_city *	string	Cidade do estabelecimento comercial	-
merchant_street *	string	Rua do estabelecimento comercial	-

Objeto payment_instrument_entry_data (postpaid_card_issuance)

Campo	Tipo	Descrição	Caracteres
postpaid_card_issuance_name *	string	Nome da emissão do cartão pós-pago	-
payment_instrument_key *	string	Chave única do instrumento de pagamento no formato UUID v4	36
postpaid_card_key *	string	Chave única do cartão pós-pago no formato UUID v4	36

Observação

Esta entrada existe apenas para cartões de carteira de cartão consignado.

Enumeradores payment_instrument_entry_type

Enumerador	Descrição
purchase	Compra
withdraw	Saque
postpaid_card_issuance	Emissão de cartão pós-pago

Enumeradores payment_instrument_entry_status

Enumerador	Descrição
processing_conclusion	Entrada em processamento de conclusão
processing_cancellation	Entrada em processamento de cancelamento
concluded	Entrada concluída
canceled	Entrada cancelada

Observação

A entrada do instrumento de pagamento pode transicionar diretamente de processing_conclusion para processing_cancellation e canceled. Nesse caso, nenhum invoice item é criado.

Objeto invoice_item

Campo	Tipo	Descrição	Caracteres
invoice_item_key *	uuidv4	Chave única de identificação do item da fatura no formato uuid v4	36
invoice_key *	uuidv4	Chave única de identificação da fatura no formato uuid v4	36
wallet_entry_key	uuidv4	Chave única de identificação da entrada da carteira no formato uuid v4	36
payment_instrument_entry_key	uuidv4	Chave única de identificação da entrada do instrumento de pagamento no formato uuid v4	36
installment_number *	integer	Número da parcela	-
invoice_description *	string	Descrição do item da fatura	-
amount *	number	Valor do item	-
used_limit *	number	Limite utilizado	-
invoice_item_status *	string	Status do item da fatura	Enumeradores invoice_item_status
invoice_item_due_date *	string	Data de vencimento do item (formato YYYY-MM-DD)	10
created_at *	string	Data de criação (formato ISO 8601 UTC)	-

Enumeradores invoice_item_status

Enumerador	Descrição
concluded	Item concluído (fatura ao qual o mesmo pertence não foi paga)
canceled	Item cancelado

Error Response

STATUS

4xx

Response Body: Error

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

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (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