ZypfyDocs Acessar painel
Cartões Virtuais

Listar compras de um cartão

GEThttps://api.zypfy.com/api/v1/cards/{cardId}/transactions

Parâmetros de caminho

Parâmetros de consulta

Respostas

200Compras e estornos, aprovados ou recusados.
  • transactionsarray de object
    campos de transactions
    • idstring (uuid)obrigatório
    • cardIdstring (uuid)obrigatório
    • cardLast4string | null
      exemplo: 4242
    • cardNicknamestring | null
      exemplo: Marketing
    • typestringobrigatório

      ISSUE emissão · LOAD carga · PURCHASE compra · REFUND estorno · VERIFICATION checagem de R$ 0,00 feita por uma plataforma ao cadastrar o cartão · SETTLEMENT liquidação de uma compra que já está na lista · ISSUER_FEE IOF/spread da compra internacional. Trate a lista como aberta: tipos novos podem entrar.

      exemplo: PURCHASE
    • sourcestring | null

      ISSUER evento do cartão na rede · GATEWAY operação sua sobre o cartão.

      valores: ISSUER GATEWAY
    • statusstring

      COMPLETE · DECLINED (recusada pela rede) · PENDING/FAILED (operação em curso ou que não se concretizou).

      exemplo: COMPLETE
    • directionstring | null

      Sinal do lançamento. amountCents é sempre positivo.

      valores: DEBIT CREDIT NONE
    • affectsBalanceboolean

      Se ESTA linha move o saldo do cartão. Some só as linhas com true.

      exemplo: true
    • accountDebitCentsinteger

      Quanto esta linha tirou do saldo da sua carteira Zypfy (não do cartão). Na compra é só a tarifa; na carga é valor + tarifa. Negativo quando o dinheiro voltou.

      exemplo: 80
    • feeChargedFromstring | null

      Tarifa Zypfy nunca é debitada do cartão, e sim do saldo da conta.

      exemplo: ACCOUNT_BALANCE
    • descriptionstring | null

      Texto pronto da linha.

      exemplo: META PLATFORMS
    • amountCentsintegerobrigatório

      Sempre positivo; quem dá o sentido é direction.

      exemplo: 12990
    • authorizedAmountCentsinteger | null

      Difere de amountCents quando a loja captura menos do que autorizou (hotel, posto).

    • originalAmountCentsinteger | null

      Valor de ORIGEM, só quando houve conversão (compra internacional).

      exemplo: 580
    • originalCurrencystring | null
      exemplo: USD
    • currencystringobrigatório

      Código numérico ISO 4217 (986 = BRL).

      exemplo: 986
    • billingCurrencystring | null

      Moeda em que o cartão foi debitado.

      exemplo: BRL
    • approvedbooleanobrigatório

      false em compra ou verificação recusada — a recusa aparece no extrato como qualquer outra linha, não move saldo e não gera tarifa.

      exemplo: true
    • declineReasonstring | null
    • responseCodestring | null

      Resultado da tentativa no padrão ISO 8583.

      exemplo: 0
    • responseMessagestring | null
      exemplo: Aprovada
    • merchantNamestring | null

      Descritor real informado pela bandeira; nunca substituído por rótulo nosso.

      exemplo: META PLATFORMS
    • merchantCitystring | null
      exemplo: SAO PAULO
    • merchantCountrystring | null
      exemplo: BRA
    • mccstring | null
      exemplo: 7311
    • merchantCategorystring | null
      exemplo: Publicidade e anúncios
    • entryModestring | null
      exemplo: Compra online
    • recurringboolean | null

      true em cobrança recorrente (assinatura).

    • acquirerMerchantIdstring | null
    • acquirerCountrystring | null
      exemplo: SGP
    • authorizationCodestring | null

      Código da compra na rede — é o que se informa numa contestação.

    • clearedboolean | null
    • reversedboolean | null
    • feeCentsintegerobrigatório

      Tarifa Zypfy deste lançamento. Cobram tarifa a compra e a verificação; não cobram estorno, recusa, liquidação nem o encargo da compra internacional.

      exemplo: 80
    • relatedToobject | null

      De qual lançamento este é consequência.

      campos de relatedTo
      • relationstring
        valores: SETTLEMENT_OF FEE_OF
      • idstring (uuid)
      • merchantNamestring | null
      • amountCentsinteger
    • localTimestring (date-time) | null

      Hora informada pela loja; pode diferir de occurredAt.

    • settledAtstring (date-time) | null
    • updatedAtstring (date-time) | null

      Última vez que a rede reprocessou o lançamento. Reconcilie por este campo, não só por occurredAt.

    • occurredAtstring (date-time)obrigatório
  • paginationobject
    campos de pagination
    • pageinteger
      exemplo: 1
    • limitinteger
      exemplo: 50
    • totalinteger
      exemplo: 3
    • pagesinteger
      exemplo: 1