Banking API
Search…
Cartão Pré-Pago
Nesta seção estão descritas as APIs que gerenciam o ciclo de vida do produto de cartão pré-pago de banking.

A rota da API para sandbox é: https://apigw-sandbox.zoop.ws

Politica de Embossamento

A politica de embossamento permite que o sistema de gestão de cartões ofereça a seus usuários uma forma de configurar os parâmetros de embossamento de cartões. Com ela é possível definir design de cartões diferentes para o mesmo marketplace.
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/cards/embossing/policies
Cadastrar politica de embossamento
{
"business_source_id": 0,
"card_design_id": 0,
"default": true,
"name": "string",
"product_id": 0
}
put
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/cards/embossing/policies/:policyId/default
Alterar politica de embossamento padrão
{
"business_source_id": 0,
"card_design_id": 0,
"default": true,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"marketplace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"product_id": 0
}
delete
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/cards/embossing/policies/:policyId
Remover politica de embossamento
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/cards/embossing/policies
Listar politicas de embossamento
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/cards/embossing/policies/:policyId
Obter dados de uma politica de embossamento

Cartão Físico

post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/holders/:holderId/cards/requests
Realizar pedido de cartão físico
{
"address_id":"9cfee57804574dd0a5de65357f69ac55",
"phone_id":"508ed1dc69fd492fb0f295ab0e73c2f4",
"account_id":"825ae4c8d132402e858bbdf5031108fd",
"printed_card_name":"Maria da Silva",
"password":"1010"
}
Para testes em sandbox, após a realização do pedido do cartão a API coloca os cartões com holders com CPF/CNPJ com final impar no status de WAITING_ANALYSIS e entra no fluxo de aprovação interno. Para a utilização do endpoint de ativação, recomendamos utilizar holders com CPF/CNPJ com final par, já que a API coloca o status do cartão como PENDING, possibilitando a ativação.
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/activate
Ativar cartão
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/block
Bloquear um cartão
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/unblock
Desbloquear um cartão
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/cancel
Cancelar um cartão
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/reissue
Solicitar segunda via de um cartão
{
"mailing_address": {
"complement": "Apt 1600",
"postal_code": "22793380",
"street": "Av das Américas",
"number": 150,
"neighborhood": "Barra da Tijuca",
"reference_point": "",
"city": "Rio de Janeiro",
"state": "Rio de Janeiro",
"country": "Brasil"
}
}
Ao solicitar a segunda via de cartão, a primeira via será automaticamente cancelada quando a segunda for ativa, não é necessário chamar o serviço de cancelamento para a primeira via.
put
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/password
Troca de senha
put
https://api.zoop.ws
/v3/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/password-reset
Resetar senha em caso de esquecimento
Para utilizar esse endpoint é necessário a utilização do autenticador de duas fases 2FA.
{
"password": 1357
}
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/holders/:holderId/accounts/:accountId/cards
Listar cartões de uma conta
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey
Obter dados de um cartão
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/delivery
Obter dados do processo de impressão do cartão

Cartão Virtual

Todos os endpoints de cartão virtual necessitam da utilização do autenticador de duas fases 2FA.
post
https://api.zoop.ws
/v3/marketplaces/:marketplaceId/holders/:holderId/cards/requests/virtual
Solicitar cartão virtual
{
"account_id": "825ae4c8d132402e858bbdf5031108fd",
"address_id": "9cfee57804574dd0a5de65357f69ac55",
"card_type": "string",
"embossing_policy_id": "3fa85f6457174562b3fc2c963f66afa6",
"phone_id": "508ed1dc69fd492fb0f295ab0e73c2f4",
"printed_card_name": "Maria Silva"
}
post
https://api.zoop.ws
/v3/marketplaces/:​marketplaceId​/holders/:​holderId​/cards/:​externalKey​/activate/virtual
Ativar cartão virtual
post
https://api.zoop.ws
/v3/marketplaces/:​marketplaceId​/holders/:​holderId​/cards/:externalKey​/cancel/virtual
Cancelar cartão virtual
{
observation: string
}
post
https://api.zoop.ws
/v3/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/block/virtual
Bloquear cartão virtual
{
"observation": "string"
}
post
https://api.zoop.ws
/v3/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/unblock/virtual
Desbloquear cartão virtual
get
https://api.zoop.ws
/v3/marketplaces/:marketplaceId​/holders/:​holderId​/cards/:​externalKey​/virtual
Buscar cartão virtual