Listar Entradas de Instrumentos de Pagamento

A listagem de entradas de instrumentos de pagamento retornará todas as entradas de um instrumento de pagamento específico que se enquadrarem nos query parameters enviados na request.

Request

ENDPOINT

/wallet/WALLET_KEY/payment_instrument/PAYMENT_INSTRUMENT_KEY/payment_instrument_entries

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

Query Parameters

Campo	Tipo	Descrição	Caracteres
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
page	integer	Número da página para paginação	-
page_size	integer	Quantidade de itens por página	-

Validações

• Paginação: Valores de página e tamanho devem ser inteiros válidos
• Tamanho da página: Máximo de 100 itens por página

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.

Response

STATUS

200

Response Body: Lista de entradas de instrumentos de pagamento

{
  "data": [
    {
      "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"
      },
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "payment_instrument_entry_key": "9db81efb-0ac1-5b79-0683-00b8395a9e7",
      "payment_instrument_entry_amount": 200.00,
      "payment_instrument_entry_type": "withdraw",
      "payment_instrument_entry_status": "canceled",
      "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"
      },
      "created_at": "2024-01-14T14:45:00Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 100
  }
}

Response Body Params

Campo	Tipo	Descrição	Caracteres
data *	object array	Entradas de instrumentos de pagamento	Objeto payment_instrument_entry
pagination *	object	Informações de paginação	Objeto pagination

Objeto payment_instrument_entry

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 *	float	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
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.

Objeto pagination

Campo	Tipo	Descrição	Caracteres
current_page *	integer	Página atual	-
rows_per_page *	integer	Itens por página	-

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
400	CIN000069	Bad Request	Invalid integer value for page or size query string parameters	Valor inválido para parâmetros de página ou tamanho de página
400	CIN000084	Bad Request	Invalid query payment instrument entry status	Status de consulta de instrumento de pagamento inválido
400	CIN000085	Bad Request	Invalid query payment instrument entry type	Tipo de consulta de instrumento de pagamento inválido
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