Emitir cartão virtual
https://api.zypfy.com/api/v1/cardsEmite um cartão e cobra a tarifa de emissão. initialLoadCents é opcional;
quando informado, adiciona limite no mesmo fluxo e cobra também a tarifa
de carga. Use Idempotency-Key em toda tentativa e retentativa.
Cabeçalhos
Idempotency-KeystringobrigatórioChave única da operação. Reutilize a mesma chave somente ao repetir a mesma tentativa.
Corpo da requisição
holderNamestringobrigatórioexemplo:João da Silvanicknamestringexemplo:MarketingsingleUsebooleanpadrão:falseinitialLoadCentsinteger | nullCarga inicial opcional, de R$ 5,00 a R$ 50.000,00.
exemplo:25000mín. 500 · máx. 5000000webhookUrlstring (uri) | nullAtalho: cadastra um destino de webhook já com escopo deste cartão, e a resposta da emissão traz o
secret. Assim você não perde nem ocard.issued. Mesmas regras de URL do cadastro avulso (https, host público, portas 443/8443).exemplo:https://seusistema.com/webhooks/cartao
Respostas
201Cartão emitido.
cardobjectcampos de card
idstring (uuid)obrigatórioexemplo:0f53a5e2-0b13-45c9-80cc-1d1c21335bb3panMaskedstring | nullexemplo:**** **** **** 4242last4string | nullexemplo:4242expiryDatestring | nullexemplo:08/29holderNamestringobrigatórioexemplo:JOAO SILVAnicknamestring | nullexemplo:Anúnciosstatusstringobrigatóriovalores:ACTIVEBLOCKEDCANCELEDexemplo:ACTIVEsingleUsebooleanobrigatórioexemplo:falseriskHoldobjectGarantia operacional; a carga permanece no cartão e nenhum crédito é criado na carteira.
campos de riskHold
blockedbooleanexemplo:falseheldCentsintegerexemplo:0reasonstring | nullvalores:MEDACCOUNT_NEGATIVEPIX_OUT_DISABLEDblockedAtstring (date-time) | null
totalsobjectobrigatóriocampos de totals
loadedCentsintegerexemplo:50000spentCentsintegerexemplo:12990refundedCentsintegerexemplo:0returnedCentsintegerexemplo:0
balanceobject | nullcampos de balance
availableCentsintegerexemplo:37010pendingCentsintegerexemplo:0
createdAtstring (date-time)obrigatóriocanceledAtstring (date-time) | null
issueFeeCentsintegerexemplo:200loadobject | nullcampos de load
amountCentsintegerexemplo:25000feeCentsintegerexemplo:500
webhook| nullPresente apenas quando
webhookUrlfoi enviado. Repetir a emissão com a mesmaIdempotency-Keydevolve o destino sem osecret.campos de webhook
idstringexemplo:12urlstring (uri)labelstring | nullcardIdstring (uuid) | nullPreenchido quando o destino é de um cartão só.
eventsarray de stringnull= todos.activebooleanhealthobjectcampos de health
lastSuccessAtstring (date-time) | nulllastFailureAtstring (date-time) | nulllastFailureErrorstring | nullconsecutiveFailuresintegerexemplo:0
createdAtstring (date-time)
secretstringAparece UMA única vez. É com ele que você confere a assinatura das entregas.
exemplo:9f2c1e0b7a5d43c8...
202Operação aceita e em conciliação segura.
400Dados inválidos ou saldo insuficiente.
messagestringMensagem humana descrevendo o erro.
exemplo:Invalid amount.codestring | nullCódigo opcional de erro para roteamento no seu sistema.
min_amountnumber (float) | nullPresente em erros de valor abaixo do mínimo configurado.
max_amountnumber (float) | nullPresente em erros de valor acima do máximo absoluto.
limitnumber (float) | nullPresente em erros de limite diário por transação excedido.
retry_after_secondsinteger | nullPresente em erros
WITHDRAWAL_COOLDOWN/ 429.