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
Cadastrar politica de embossamento

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/cards/embossing/policies
Os campos business_id, card_design_id e product_id são informados pela Dock após a aprovação do card design.
Request
Response
Request
Path Parameters
marketplaceId
required
string
Id do marketplace
Body Parameters
business_source_id
required
number
Id da politica de embossamento
card_design_id
required
number
Id do card design
default
required
boolean
Indica se é a politica principal
name
required
string
O nome da politica de embossamento (Máximo de 100 caracteres)
product_id
required
number
Id do produto
Response
200: OK
{
"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
}
{
"business_source_id": 0,
"card_design_id": 0,
"default": true,
"name": "string",
"product_id": 0
}

put
Alterar politica de embossamento padrão

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/cards/embossing/policies/:policyId/default
Altera para ser a politica de embossamento padrão do marketplace. Somente uma politica pode ser a padrão por vez.
Request
Response
Request
Path Parameters
marketplaceId
required
string
Id do marketplace
poilicyId
required
string
Id da politica de embossamento
Response
200: OK
{
"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
Remover politica de embossamento

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/cards/embossing/policies/:policyId
Request
Response
Request
Path Parameters
marketplaceId
required
string
Id do marketplace
policyId
required
string
Id da politica de embossamento
Response
200: OK
{
"message": "Politica de embossamento removida com sucesso"
}

get
Listar politicas de embossamento

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/cards/embossing/policies
Request
Response
Request
Path Parameters
marketplaceId
required
string
Id do marketplace
Response
200: OK
[
{
"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
}
]

get
Obter dados de uma politica de embossamento

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/cards/embossing/policies/:policyId
Request
Response
Request
Path Parameters
marketplaceId
required
string
Id do marketplace
policyId
required
string
Id da politica de embossamento
Response
200: OK
{
"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
}

Cartão Físico

post
Realizar pedido de cartão físico

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/holders/:holderId/cards/requests
Este endpoint destina-se a solicitar um cartão pré-pago para um holder.
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do dono da conta
Body Parameters
card_type
required
string
Informar o tipo do cartão solicitado PHYSICAL ou VIRTUAL
embossing_policy_id
required
string
Id da politica de embossamento
address_id
required
string
ID do endereço do holder
phone_id
required
string
ID do telefone do holder
account_id
required
string
ID da conta do holder
printed_card_name
required
string
Nome a ser impresso no cartão (máximo de 20 caracteres)
password
optional
string
Senha do cartão a ser criado (4 dígitos não sequenciais)
Response
201: Created
{
"external_key": "037d9fe32bab48ff815c26bd5deda824",
"account_id": "bc0f948a02ee452da75f51db3fc04bd0",
"holder_id": "a6d7c42c661b4e76bd6b77a9c09e82e1",
"marketplace_id": "f8c2bfb884e4486c8e0eee15be5c3ab1",
"card_type": "PHYSICAL"
"printed_card_name": "Anderson Silva",
"status": "PENDING",
"created_at": "2020-11-06T12:54:11.336975",
"updated_at": "2020-11-06T12:54:12.701393",
"uri": "/marketplaces/f8c2bfb8-84e4-486c-8e0e-ee15be5c3ab1/holders/a6d7c42c-661b-4e76-bd6b-77a9c09e82e1/cards/037d9fe3-2bab-48ff-815c-26bd5deda824"
}
{
"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
Ativar cartão

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/activate
Este endpoint se destina a realizar a ativação do cartão. Todo cartão só pode ser utilizado após o processo de ativação. Neste momento qualquer outro cartão ativo associado na mesma conta do cartão alvo será cancelado.
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do portador que possui o cartão
externalKey
required
string
ID do cartão alvo
Body Parameters
password
optional
number
senha do cartão (4 dígitos não sequenciais)
Response
200: OK
{
"account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"created_at": "2021-03-09T16:15:51.773Z",
"embossing_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiration_date": "2021-03-09",
"external_key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"holder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"marketplace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"pan": "string",
"reason": "string",
"status": "string",
"updated_at": "2021-03-09T16:15:51.773Z",
"uri": "string"
}

post
Bloquear um cartão

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/block
Este endpoint é usado para realizar bloqueio de um cartão. Enquanto o cartão está bloqueado não é possível realizar operações com ele.
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do portador do cartão
externalKey
required
string
ID do cartão alvo
Body Parameters
observation
required
string
Motivo do bloqueio (máximo 100 caracteres)
Response
200: OK
{
"external_key": "037d9fe32bab48ff815c26bd5deda824",
"account_id": "bc0f948a02ee452da75f51db3fc04bd0",
"holder_id": "a6d7c42c661b4e76bd6b77a9c09e82e1",
"marketplace_id": "f8c2bfb884e4486c8e0eee15be5c3ab1",
"embossing_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"pan": "9999********9999",
"expiration_date": "2040-11-06",
"status": "BLOCKED",
"reason": "string",
"created_at": "2020-11-06T12:54:11.336975",
"updated_at": "2020-11-06T14:42:28.848207",
"uri": "/marketplaces/f8c2bfb8-84e4-486c-8e0e-ee15be5c3ab1/holders/a6d7c42c-661b-4e76-bd6b-77a9c09e82e1/cards/037d9fe3-2bab-48ff-815c-26bd5deda824"
}

post
Desbloquear um cartão

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/unblock
Este endpoint se destina a debloquear um cartão que previamente esteja bloqueado. Após o processo de desbloqueio o cartão pode ser usado novamente para realização de operações.
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do portador do cartão
externalKey
required
string
ID do cartão alvo
Response
200: OK
{
"external_key": "037d9fe32bab48ff815c26bd5deda824",
"account_id": "bc0f948a02ee452da75f51db3fc04bd0",
"embossing_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"holder_id": "a6d7c42c661b4e76bd6b77a9c09e82e1",
"marketplace_id": "f8c2bfb884e4486c8e0eee15be5c3ab1",
"pan": "9999********9999",
"expiration_date": "2040-11-06",
"status": "ACTIVE",
"reason": "string",
"created_at": "2020-11-06T12:54:11.336975",
"updated_at": "2020-11-06T14:43:26.192698",
"uri": "/marketplaces/f8c2bfb8-84e4-486c-8e0e-ee15be5c3ab1/holders/a6d7c42c-661b-4e76-bd6b-77a9c09e82e1/cards/037d9fe3-2bab-48ff-815c-26bd5deda824"
}

post
Cancelar um cartão

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/cancel
Este endpoint se destina a cancelar um cartão. Esta operação é irreversível e a partir do fim do processo o cartão não poderá mais ser mais utilizado em transações ou em qualquer outro fluxo exposto nesta seção.
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do portador do cartão
externalKey
required
string
ID do cartão alvo
Body Parameters
observation
required
string
Motivo do cancelamento (máximo 100 caracteres)
Response
200: OK
{
"observation": "string"
}

post
Solicitar segunda via de um cartão

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/reissue
Este endpoint se destina a permitir a solicitação de uma segunda via do cartão alvo. Este processo inicia a impressão de um novo cartão que será enviado ao domicilio do cliente.
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do portador do cartão
externalKey
required
string
ID do cartão alvo
Body Parameters
reference_point
optional
string
Ponto de referência do endereço
country
required
string
País do endereço. 20 caracteres.
city
required
string
Cidade do endereço. 20 caracteres.
neighborhood
required
string
Bairro do endereço
number
required
string
Número do endereço. Somente numéricos.
street
required
string
Logradouro do endereço. Máximo com 40 caracteres.
postal_code
optional
number
CEP do endereço. 8 dígitos.
complement
optional
string
Complemento do endereço de entrega. Deve ter no máximo 30 caracteres.
mailing_address
optional
object
Endereço onde será entregue o cartão. Caso não seja informado o cartão será enviado para o endereço de entrega definido anteriormente no cartão alvo.
Response
200: OK
{
"account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"created_at": "2021-03-11T12:44:02.133Z",
"embossing_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiration_date": "2021-03-11",
"external_key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"holder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"marketplace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"pan": "string",
"reason": "string",
"status": "string",
"updated_at": "2021-03-11T12:44:02.133Z",
"uri": "string"
}
{
"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
Troca de senha

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/password
Este endpoint realiza troca de senha de um cartão.
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do portador do cartão
externalKey
required
string
ID do cartão alvo
Body Parameters
old_password
required
number
Senha antiga do cartão que será trocada.
password
required
number
Nova senha do cartão. Só pode conter valores numéricos não sequenciais no tamanho de 4 dígitos.
Response
200: OK

put
Resetar senha em caso de esquecimento

https://api.zoop.ws/v3/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/password-reset
Este endpoint realiza o reset da senha em ocasião de esquecimento da mesma.
Request
Response
Request
Path Parameters
marketplaceId
required
string
Id do marketplace
holderId
required
string
Id do portador do cartão
externalKey
required
string
Id do cartão alvo
Body Parameters
password
required
number
Senha nova a ser resetada. A senha deve ter 4 caracteres numéricos, onde eles não podem ser sequenciais (ex. 1234, 0123) e nem repetidos (ex. 0000, 9999).
Response
200: OK
Password reset succesfully
400: Bad Request
The requested password does not follow security rules
412: Precondition Failed
The card is in a state that cannot reset password

Para utilizar esse endpoint é necessário a utilização do autenticador de duas fases 2FA.

{
"password": 1357
}

get
Listar cartões de uma conta

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/holders/:holderId/accounts/:accountId/cards
Este endpoint realiza a listagem dos cartões vinculados a uma conta.
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do portador dos cartões
accountId
required
string
ID da conta digital cujos cartões estão vinculados
Response
200: OK
[
{
"external_key": "037d9fe32bab48ff815c26bd5deda824",
"account_id": "bc0f948a02ee452da75f51db3fc04bd0",
"holder_id": "a6d7c42c661b4e76bd6b77a9c09e82e1",
"marketplace_id": "f8c2bfb884e4486c8e0eee15be5c3ab1",
"pan": "9999********9999",
"expiration_date": "2040-11-06",
"status": "ACTIVE",
"created_at": "2020-11-06T12:54:11.336975",
"updated_at": "2020-11-06T14:43:26.192698",
"uri": "/marketplaces/f8c2bfb8-84e4-486c-8e0e-ee15be5c3ab1/holders/a6d7c42c-661b-4e76-bd6b-77a9c09e82e1/cards/037d9fe3-2bab-48ff-815c-26bd5deda824"
}
]

get
Obter dados de um cartão

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey
Este endpoint realiza a busca de dados de um cartão especifico.
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do portador do cartão
externalKey
required
string
ID do cartão alvo
Response
200: OK
{
"external_key": "037d9fe32bab48ff815c26bd5deda824",
"account_id": "bc0f948a02ee452da75f51db3fc04bd0",
"holder_id": "a6d7c42c661b4e76bd6b77a9c09e82e1",
"marketplace_id": "f8c2bfb884e4486c8e0eee15be5c3ab1",
"pan": "9999********9999",
"expiration_date": "2040-11-06",
"status": "ACTIVE",
"created_at": "2020-11-06T12:54:11.336975",
"updated_at": "2020-11-06T14:43:26.192698",
"uri": "/marketplaces/f8c2bfb8-84e4-486c-8e0e-ee15be5c3ab1/holders/a6d7c42c-661b-4e76-bd6b-77a9c09e82e1/cards/037d9fe3-2bab-48ff-815c-26bd5deda824"
}

get
Obter dados do processo de impressão do cartão

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/delivery
Este endpoint realiza a busca de dados sobre o andamento do processo de impressão do cartão.
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do portador do cartão
externalKey
required
string
ID do cartão alvo
Response
200: OK
{
"holder_id": "a6d7c42c661b4e76bd6b77a9c09e82e1",
"card_key": "037d9fe32bab48ff815c26bd5deda824",
"marketplace_id": "f8c2bfb884e4486c8e0eee15be5c3ab1",
"status": "RECEIVED",
"updated_at": "2020-11-06T15:18:47.342199",
"mailing_address": {
"postal_code": "22783450",
"street": "Av da América",
"number": 100,
"complement": "Do lado Cittar América",
"reference_point": "",
"neighborhood": "Barra da Tijuca",
"city": "Rio de Janeiro",
"state": "Rio de Janeiro",
"country": "Brasil"
},
"uri": "/marketplaces/f8c2bfb8-84e4-486c-8e0e-ee15be5c3ab1/holders/a6d7c42c-661b-4e76-bd6b-77a9c09e82e1/cards/037d9fe3-2bab-48ff-815c-26bd5deda824/delivery"
}

Cartão Virtual

Todos os endpoints de cartão virtual necessitam da utilização do autenticador de duas fases 2FA.

post
Solicitar cartão virtual

https://api.zoop.ws/v3/marketplaces/:marketplaceId/holders/:holderId/cards/requests/virtual
Request
Response
Request
Path Parameters
marketplaceId
required
string
Id do marketplace
holderId
required
string
Id do portador do cartão
Body Parameters
account_id
required
string
Id da conta digital
address_id
required
string
id do endereço do portador
card_type
required
string
Tipo do cartão
embossing_policy_id
required
string
Id da politica de embossamento
phone_id
required
string
Id do telefone do portador do cartão
printed_card_name
required
string
Nome impresso no cartão
Response
200: OK
{
"external_key": "bab06abb9ebf44ec924dade0c04c0de8",
"account_id": "cf245b18890a4ea4b23b27390a02bebc",
"holder_id": "83593676f28b470da41160269a54060c",
"marketplace_id": "f71a8951368a4cc085cf7875ff44e61c",
"printed_card_name": "EXAMPLE CARD",
"status": "PENDING",
"created_at": "2021-06-28T10:51:33.7675467",
"updated_at": "2021-06-28T10:51:33.8447605",
"uri": "/marketplaces/f71a8951-368a-4cc0-85cf-7875ff44e61c/holders/83593676-f28b-470d-a411-60269a54060c/cards/bab06abb-9ebf-44ec-924d-ade0c04c0de8",
"embossing_policy_id": "7710a903853b41bba678a347a1adcc6e",
"card_type": "VIRTUAL"
}
404: Not Found
O marketplaceId ou holderId ou política de embossamento não foram encontrados
{
"account_id": "825ae4c8d132402e858bbdf5031108fd",
"address_id": "9cfee57804574dd0a5de65357f69ac55",
"card_type": "string",
"embossing_policy_id": "3fa85f6457174562b3fc2c963f66afa6",
"phone_id": "508ed1dc69fd492fb0f295ab0e73c2f4",
"printed_card_name": "Maria Silva"
}

post
Ativar cartão virtual

https://api.zoop.ws/v3/marketplaces/:​marketplaceId​/holders/:​holderId​/cards/:​externalKey​/activate/virtual
Request
Response
Request
Path Parameters
marketplaceId
required
string
Id do marketplace
holderId
required
string
Id do portador do cartão
externalKey
required
string
Id do cartão virtual
Response
200: OK
{
"external_key": "bab06abb9ebf44ec924dade0c04c0de8",
"account_id": "cf245b18890a4ea4b23b27390a02bebc",
"holder_id": "83593676f28b470da41160269a54060c",
"marketplace_id": "f71a8951368a4cc085cf7875ff44e61c",
"pan": "4475********3676",
"expiration_date": "2026-12-31",
"status": "ACTIVE",
"created_at": "2021-06-28T10:51:33.767547",
"updated_at": "2021-06-28T11:02:19.5645215",
"uri": "/marketplaces/f71a8951-368a-4cc0-85cf-7875ff44e61c/holders/83593676-f28b-470d-a411-60269a54060c/cards/bab06abb-9ebf-44ec-924d-ade0c04c0de8",
"embossing_policy_id": "7710a903853b41bba678a347a1adcc6e",
"card_type": "VIRTUAL"
}
404: Not Found
O marketplaceId, holderId ou o externalKey não representam um cartão virtual.
412: Precondition Failed
Uma condição prévia falhou, como uma conta bancária inválida ou o cartão não estava no status PENDING ao chamar o endpoint

post
Cancelar cartão virtual

https://api.zoop.ws/v3/marketplaces/:​marketplaceId​/holders/:​holderId​/cards/:externalKey​/cancel/virtual
Request
Response
Request
Path Parameters
marketplaceId
required
string
Id do marketplace
holderId
required
string
Id do portador do cartão
externalKey
required
string
Id do cartão virtual
Body Parameters
observation
required
string
Observação sobre o cancelamento
Response
200: OK
{
"external_key": "bab06abb9ebf44ec924dade0c04c0de8",
"account_id": "cf245b18890a4ea4b23b27390a02bebc",
"holder_id": "83593676f28b470da41160269a54060c",
"marketplace_id": "f71a8951368a4cc085cf7875ff44e61c",
"pan": "4475********3676",
"expiration_date": "2026-12-31",
"status": "CANCELLED",
"created_at": "2021-06-28T10:51:33.767547",
"updated_at": "2021-06-28T11:05:40.114192",
"uri": "/marketplaces/f71a8951-368a-4cc0-85cf-7875ff44e61c/holders/83593676-f28b-470d-a411-60269a54060c/cards/bab06abb-9ebf-44ec-924d-ade0c04c0de8",
"embossing_policy_id": "7710a903853b41bba678a347a1adcc6e",
"card_type": "VIRTUAL"
}
400: Bad Request
Se a requisição não conter o body de requisição
requisição não conter o body de requisição
404: Not Found
O marketplaceId, holderId ou o externalKey não representam um cartão virtual
412: Precondition Failed
Uma pré-condição falhou, como o cartão estando em um estado que não pode ser cancelado.
{
observation: string
}

post
Bloquear cartão virtual

https://api.zoop.ws/v3/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/block/virtual
Request
Response
Request
Path Parameters
marketplaceId
required
string
Id do marketplace
holderId
required
string
Id do portador do cartão
externalKey
required
string
Id do cartão virtual
Response
200: OK
{
"external_key": "70f5710822ba4642985a2b0bd9b30820",
"account_id": "cf245b18890a4ea4b23b27390a02bebc",
"holder_id": "83593676f28b470da41160269a54060c",
"marketplace_id": "f71a8951368a4cc085cf7875ff44e61c",
"pan": "4475********4867",
"expiration_date": "2026-12-31",
"status": "BLOCKED",
"created_at": "2021-06-28T11:06:10.924589",
"updated_at": "2021-06-28T11:07:09.2961585",
"uri": "/marketplaces/f71a8951-368a-4cc0-85cf-7875ff44e61c/holders/83593676-f28b-470d-a411-60269a54060c/cards/70f57108-22ba-4642-985a-2b0bd9b30820",
"embossing_policy_id": "7710a903853b41bba678a347a1adcc6e",
"card_type": "VIRTUAL"
}
404: Not Found
An invalid virtual card was requested, or an otherwise invalid request was made.
412: Precondition Failed
A precondition has failed, such as an invalid banking account or the card was not previously blocked.
{
"observation": "string"
}

post
Desbloquear cartão virtual

https://api.zoop.ws/v3/marketplaces/:marketplaceId/holders/:holderId/cards/:externalKey/unblock/virtual
Request
Response
Request
Path Parameters
marketplaceId
required
string
Id do marketplace
holderId
required
string
Id do portador do cartão
externalKey
required
string
Id do cartão virtual
Response
202: Accepted
{
"external_key": "70f5710822ba4642985a2b0bd9b30820",
"account_id": "cf245b18890a4ea4b23b27390a02bebc",
"holder_id": "83593676f28b470da41160269a54060c",
"marketplace_id": "f71a8951368a4cc085cf7875ff44e61c",
"pan": "4475********4867",
"expiration_date": "2026-12-31",
"status": "ACTIVE",
"created_at": "2021-06-28T11:06:10.924589",
"updated_at": "2021-06-28T11:07:42.2776369",
"uri": "/marketplaces/f71a8951-368a-4cc0-85cf-7875ff44e61c/holders/83593676-f28b-470d-a411-60269a54060c/cards/70f57108-22ba-4642-985a-2b0bd9b30820",
"embossing_policy_id": "7710a903853b41bba678a347a1adcc6e",
"card_type": "VIRTUAL"
}
400: Bad Request
An invalid virtual card was requested, or an otherwise invalid request was made.
412: Precondition Failed
A precondition has failed, such as an invalid banking account or the card was not previously blocked.

get
Buscar cartão virtual

https://api.zoop.ws/v3/marketplaces/:marketplaceId​/holders/:​holderId​/cards/:​externalKey​/virtual
Request
Response
Request
Path Parameters
marketplaceId
required
string
Id do marketplace
holderId
required
string
Id do portador do cartão virtual
externalKey
required
string
Id do cartão virtual
Response
200: OK
{
"external_key": "70f5710822ba4642985a2b0bd9b30820",
"account_id": "cf245b18890a4ea4b23b27390a02bebc",
"holder_id": "83593676f28b470da41160269a54060c",
"marketplace_id": "f71a8951368a4cc085cf7875ff44e61c",
"pan": "4475********4867",
"status": "ACTIVE",
"created_at": "2021-06-28T11:06:10.924589",
"updated_at": "2021-06-28T11:10:48.1243127",
"uri": "/marketplaces/f71a8951-368a-4cc0-85cf-7875ff44e61c/holders/83593676-f28b-470d-a411-60269a54060c/cards/70f57108-22ba-4642-985a-2b0bd9b30820",
"embossing_policy_id": "7710a903853b41bba678a347a1adcc6e",
"card_type": "VIRTUAL",
"expiration_date": "2026-12-31T00:00:00.000Z",
"cvv": "***",
"card_number": "4475590003414867",
"plastic_name": "EXAMPLECARDTWO"
}
400: Bad Request
An invalid virtual card was requested, or an otherwise invalid request was made.
412: Precondition Failed
A precondition has failed, such as an invalid banking account or the card was not previously blocked.