Listar compras de um cartão
https://api.zypfy.com/api/v1/cards/{cardId}/transactionsParâmetros de caminho
cardIdstring (uuid)obrigatórioIdentificador público do cartão retornado na emissão.
Parâmetros de consulta
pageintegerlimitintegersyncbooleanForça sincronização imediata com a adquirente.
Respostas
200Compras e estornos, aprovados ou recusados.
transactionsarray de objectcampos de transactions
idstring (uuid)obrigatóriocardIdstring (uuid)obrigatóriocardLast4string | nullexemplo:4242cardNicknamestring | nullexemplo:MarketingtypestringobrigatórioISSUEemissão ·LOADcarga ·PURCHASEcompra ·REFUNDestorno ·VERIFICATIONchecagem de R$ 0,00 feita por uma plataforma ao cadastrar o cartão ·SETTLEMENTliquidação de uma compra que já está na lista ·ISSUER_FEEIOF/spread da compra internacional. Trate a lista como aberta: tipos novos podem entrar.exemplo:PURCHASEsourcestring | nullISSUERevento do cartão na rede ·GATEWAYoperação sua sobre o cartão.valores:ISSUERGATEWAYstatusstringCOMPLETE·DECLINED(recusada pela rede) ·PENDING/FAILED(operação em curso ou que não se concretizou).exemplo:COMPLETEdirectionstring | nullSinal do lançamento.
amountCentsé sempre positivo.valores:DEBITCREDITNONEaffectsBalancebooleanSe ESTA linha move o saldo do cartão. Some só as linhas com
true.exemplo:trueaccountDebitCentsintegerQuanto 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:80feeChargedFromstring | nullTarifa Zypfy nunca é debitada do cartão, e sim do saldo da conta.
exemplo:ACCOUNT_BALANCEdescriptionstring | nullTexto pronto da linha.
exemplo:META PLATFORMSamountCentsintegerobrigatórioSempre positivo; quem dá o sentido é
direction.exemplo:12990authorizedAmountCentsinteger | nullDifere de
amountCentsquando a loja captura menos do que autorizou (hotel, posto).originalAmountCentsinteger | nullValor de ORIGEM, só quando houve conversão (compra internacional).
exemplo:580originalCurrencystring | nullexemplo:USDcurrencystringobrigatórioCódigo numérico ISO 4217 (986 = BRL).
exemplo:986billingCurrencystring | nullMoeda em que o cartão foi debitado.
exemplo:BRLapprovedbooleanobrigatóriofalseem compra ou verificação recusada — a recusa aparece no extrato como qualquer outra linha, não move saldo e não gera tarifa.exemplo:truedeclineReasonstring | nullresponseCodestring | nullResultado da tentativa no padrão ISO 8583.
exemplo:0responseMessagestring | nullexemplo:AprovadamerchantNamestring | nullDescritor real informado pela bandeira; nunca substituído por rótulo nosso.
exemplo:META PLATFORMSmerchantCitystring | nullexemplo:SAO PAULOmerchantCountrystring | nullexemplo:BRAmccstring | nullexemplo:7311merchantCategorystring | nullexemplo:Publicidade e anúnciosentryModestring | nullexemplo:Compra onlinerecurringboolean | nulltrueem cobrança recorrente (assinatura).acquirerMerchantIdstring | nullacquirerCountrystring | nullexemplo:SGPauthorizationCodestring | nullCódigo da compra na rede — é o que se informa numa contestação.
clearedboolean | nullreversedboolean | nullfeeCentsintegerobrigatórioTarifa 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:80relatedToobject | nullDe qual lançamento este é consequência.
campos de relatedTo
relationstringvalores:SETTLEMENT_OFFEE_OFidstring (uuid)merchantNamestring | nullamountCentsinteger
localTimestring (date-time) | nullHora informada pela loja; pode diferir de
occurredAt.settledAtstring (date-time) | nullupdatedAtstring (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
paginationobjectcampos de pagination
pageintegerexemplo:1limitintegerexemplo:50totalintegerexemplo:3pagesintegerexemplo:1