ZypfyDocs Acessar painel
Cartões Virtuais

Emitir cartão virtual

POSThttps://api.zypfy.com/api/v1/cards

Emite 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

Corpo da requisição

Respostas

201Cartão emitido.
  • cardobject
    campos de card
    • idstring (uuid)obrigatório
      exemplo: 0f53a5e2-0b13-45c9-80cc-1d1c21335bb3
    • panMaskedstring | null
      exemplo: **** **** **** 4242
    • last4string | null
      exemplo: 4242
    • expiryDatestring | null
      exemplo: 08/29
    • holderNamestringobrigatório
      exemplo: JOAO SILVA
    • nicknamestring | null
      exemplo: Anúncios
    • statusstringobrigatório
      valores: ACTIVE BLOCKED CANCELED
      exemplo: ACTIVE
    • singleUsebooleanobrigatório
      exemplo: false
    • riskHoldobject

      Garantia operacional; a carga permanece no cartão e nenhum crédito é criado na carteira.

      campos de riskHold
      • blockedboolean
        exemplo: false
      • heldCentsinteger
        exemplo: 0
      • reasonstring | null
        valores: MED ACCOUNT_NEGATIVE PIX_OUT_DISABLED
      • blockedAtstring (date-time) | null
    • totalsobjectobrigatório
      campos de totals
      • loadedCentsinteger
        exemplo: 50000
      • spentCentsinteger
        exemplo: 12990
      • refundedCentsinteger
        exemplo: 0
      • returnedCentsinteger
        exemplo: 0
    • balanceobject | null
      campos de balance
      • availableCentsinteger
        exemplo: 37010
      • pendingCentsinteger
        exemplo: 0
    • createdAtstring (date-time)obrigatório
    • canceledAtstring (date-time) | null
  • issueFeeCentsinteger
    exemplo: 200
  • loadobject | null
    campos de load
    • amountCentsinteger
      exemplo: 25000
    • feeCentsinteger
      exemplo: 500
  • webhook | null

    Presente apenas quando webhookUrl foi enviado. Repetir a emissão com a mesma Idempotency-Key devolve o destino sem o secret.

    campos de webhook
    • idstring
      exemplo: 12
    • urlstring (uri)
    • labelstring | null
    • cardIdstring (uuid) | null

      Preenchido quando o destino é de um cartão só.

    • eventsarray de string

      null = todos.

    • activeboolean
    • healthobject
      campos de health
      • lastSuccessAtstring (date-time) | null
      • lastFailureAtstring (date-time) | null
      • lastFailureErrorstring | null
      • consecutiveFailuresinteger
        exemplo: 0
    • createdAtstring (date-time)
    • secretstring

      Aparece 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.
  • messagestring

    Mensagem humana descrevendo o erro.

    exemplo: Invalid amount.
  • codestring | null

    Código opcional de erro para roteamento no seu sistema.

  • min_amountnumber (float) | null

    Presente em erros de valor abaixo do mínimo configurado.

  • max_amountnumber (float) | null

    Presente em erros de valor acima do máximo absoluto.

  • limitnumber (float) | null

    Presente em erros de limite diário por transação excedido.

  • retry_after_secondsinteger | null

    Presente em erros WITHDRAWAL_COOLDOWN / 429.