Banking API
Search…
Credenciamento
Esta seção tem como objetivo descrever as etapas do processo de cadastramento de um portador (holder). Serão visitadas as APIs necessárias, as informações necessárias e o fluxo de negócio.

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

Portador de conta de pagamentos

post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders
Cadastrar portador pessoa física
{
"type":"individual",
"name":"João da Silva",
"email":"[email protected]",
"national_registration":"10057698007",
"revenue":5500.50,
"birthday":"1985-08-20",
"mothers_name":"Maria da Silva",
"identity_card":"156022898",
"pep":false,
"cbo":212405
}
put
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId
Alterar cadastro de pessoa física
{
"revenue":100.00,
"birthday":"1999-04-03",
"mothers_name":"Maria da Silva de souza",
"cbo":"848515",
}
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders
Cadastrar portador pessoa jurídica
{
"type":"business",
"name":"Teste",
"email":"[email protected]",
"national_registration":"67053773000107",
"revenue":15000.50,
"cnae":"0111301",
"legal_name":"Teste Comercio de Alimentos Ltda.",
"establishment":{
"format":"LTDA",
"date":"2001-03-05"
}
put
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId
Alterar cadastro de pessoa jurídica
{
"revenue":100.0,
"legal_name":"Mbv Comercio de Alimentos Ltda 2",
"cnae":"0133404",
"establishment_date":"2020-12-29",
}
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/phones
Cadastrar telefone do portador
{
"area_code": "21",
"country_code": "55",
"number": "33093829"
}
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/addresses
Cadastrar endereço do portador
{
"street": "Av da América",
"number": "100",
"city": "Rio de Janeiro",
"complement": "Do lado Cittar América",
"state": "Rio de Janeiro",
"neighborhood": "Barra da Tijuca",
"postal_code": "22783450",
"country": "Brasil"
}
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/documents?type=:type
Cadastrar documentos do portador
curl --location --request POST 'https://apigw-sandbox.zoop.ws/v2/marketplaces/19b2d3baf08f49cfbc292ae9b1990f25/banking/accreditation/holders/f8dfd0e3fcac44408d994e599c157a7c/documents?type=RG_FRENTE' \
--header 'Content-Type: image/jpeg' \
--data-binary '@/D:/Imagens/Selfie_icon.svg.png'
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/approval
Solicitar aprovação do cadastro do portador
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders
Consultar portadores do marketplace
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId
Consultar portador por id
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/documents/:document_id
Consultar documento do portador por id
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/documents/
Consultar documentação do portador
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/addresses
Consultar endereço do portador
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/addresses/:address_id
Consultar endereço do portador por id
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/phones
Consultar telefone do portador
put
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/phones/:phone_id
Alterar telefone do portador
{
"area_code": "21",
"country_code": "55",
"number": "33093829"
}
delete
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/phones/:phone_id
Excluir telefone do portador
delete
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/documents/:document_id
Excluir documento do portador
put
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/addresses/:address_id
Alterar endereço do portador
{
"street": "Av da América",
"number": "100",
"city": "Rio de Janeiro",
"complement": "Do lado Cittar América",
"state": "Rio de Janeiro",
"neighborhood": "Barra da Tijuca",
"postal_code": "22783450",
"country": "Brasil"
}
delete
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/addresses/:address_id
Excluir endereço do portador

Sócio

Todo portador PJ (business holder) deve cadastrar todos os sócios da empresa. Para isso utilize os passos abaixo.
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/partners
Cadastrar sócio
Para um individual partner (sócio pessoa física) :
{
"type":"individual",
"name":"João da Silva",
"email":"[email protected]",
"national_registration":"10057698007",
"revenue":5500.50,
"birthday":"1985-08-20",
"mothers_name":"Maria da Silva",
"identity_card":"156022898",
"pep":false,
"cbo":212405,
"percentage": 100,
"adm":true
}
Para um business partner (sócio pessoa jurídica) :
{
"type":"business",
"name":"China in Box",
"email":"[email protected]",
"national_registration":"67053773000107",
"revenue":15000.50,
"cnae":"0111301",
"owner":null,
"legal_name":"Mbv Comercio de Alimentos Ltda.",
"establishment":{
"format":"LTDA",
"date":"2001-03-05"
},
"percentage": 100,
"adm": true
}
put
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/partners/:partnerid
Alterar cadastro do sócio
{
"adm": true,
"email": "string",
"name": "string",
"owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"percentage": 0,
"revenue": 0,
"type": "BUSINESS"
}
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/partners/:partnerId/phones
Cadastrar telefone de sócio
{
"area_code": "21",
"country_code": "55",
"number": "33093829"
}
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/partners/:partnerId/addresses
Cadastrar endereço de sócio
{
"street": "Av da América",
"number": "100",
"city": "Rio de Janeiro",
"complement": "Do lado Cittar América",
"state": "Rio de Janeiro",
"neighborhood": "Barra da Tijuca",
"postal_code": "22783450",
"country": "Brasil"
}
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/partners/:partnerId/documents
Cadastrar documento de sócio
curl --location --request POST 'httcurl --location --request POST 'https://apigw-sandbox.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1/partners/e9d7c42c661b4e76bd6b77a9c09e82c1/documents?type=SELFIE' \
--header 'Content-Type: image/jpeg' \
--data-binary '@/D:/Imagens/Selfie_icon.svg.png'
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/partners/:partner_id
Consultar sócio por id
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/partners?page=0&size=20
Consultar sócios de um portador
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/partners/:partner_id/documents/
Consultar documentação do sócio
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/partners/:partner_id/documents/:document_id
Consultar documento do sócio por id
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/partner/:partner_id/address/:address_id
Consultar endereço de sócio por id
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/partenrs/:partenrId/addresses
Consultar endereços do sócio
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/partners/:partner_id/phones/:phone_id
Consultar telefone do sócio por id
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/partners/:partner_id/phones
Consultar telefones do sócio
delete
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/partners/:partner_id/documents/:document_id
Excluir documento do Sócio
put
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/partners/:partner_id/addresses/:address_id
Alterar endereço do sócio
{
"street": "Av da América",
"number": "100",
"city": "Rio de Janeiro",
"complement": "Do lado Cittar América",
"state": "Rio de Janeiro",
"neighborhood": "Barra da Tijuca",
"postal_code": "22783450",
"country": "Brasil"
}
delete
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/partners/:partner_id/addresses/:address_id
Excluir endereço do sócio
put
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/partners/:partner_id/phones/:phone_id
Alterar telefone do sócio
{
"area_code": "21",
"country_code": "55",
"number": "33093829"
}
delete
https://api-beta.zoop.ws
/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/partners/:partner_id/phones/:phone_id
Excluir telefone do sócio

Associado

Representa a lista de pessoas físicas que por efeito de procuração são representantes legais do holder e podem movimentar suas contas digitais.
Um holder PJ pode não ter associados.
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates
Cadastrar associado
{
"birthday": "2021-10-07",
"cbo": "string",
"email": "string",
"identity_card": "string",
"mothers_name": "string",
"name": "string",
"national_registration": "string",
"pep": true,
"revenue": 0
}
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId/addresses
Cadastrar endereço do associado
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId/phones
Cadastrar telefone do associado
post
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId/documents
Cadastrar documentos do associado
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates
Consultar associados do marketplace
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId
Consultar associados por id
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId/addresses
Consultar endereço do associado
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId/addresses/:addressId
Consultar endereço do associado por id
get
https://api-beta.zoop.ws
/v2​/marketplaces​/:marketplaceId​/banking​/accreditation​/holders​/:holderId/associates​/:associateId/phones
Consultar telefone do associado
get
https://api-beta.zoop.ws
/v2​/marketplaces​/:marketplaceId​/banking​/accreditation​/holders​/:holderId/associates​/:associateId/phones/:phoneId
Consultar telefone do associado por id
get
https://api-beta.zoop.ws
/v2​/marketplaces​/:marketplaceId​/banking​/accreditation​/holders​/:holderId/associates​/:associateId​/documents
Consultar documentos do associado
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId/documents/:documentId
Consultar documentos do associado por id
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId/documents/:documentId/download
Baixar documentos do associado
put
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId
Alterar dados do associado
put
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId/addresses/:addressId
Alterar endereço do associado por id
put
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId/addresses/:addressId/main
Alterar endereço do associado principal
put
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId/phones/:phoneId
Alterar telefone do associado por id
put
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId/phones/:phoneId/main
Alterar telefone do associado principal
delete
https://api-beta.zoop.ws
/v2/marketplaces/{marketplaceId}/banking/accreditation/holders/{holderId}/associates/{associateId}
Deletar associado por id
delete
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId/phones/:phoneId
Deletar telefone do associado
delete
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/associates/:associateId/addresses/:addressId
Deletar endereço do associado por id
delete
https://api-beta.zoop.ws
/v2​/marketplaces​/:marketplaceId​/banking​/accreditation​/holders​/:holderId:​/associates​/:associateId/documents​/:documentId
Deletar documentos do associado por id

Informações complementares

get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/cbos
Consultar CBO
get
https://api-beta.zoop.ws
/v2/marketplaces/:marketplaceId/banking/accreditation/cnaes
Consultar CNAEs
Copy link
Outline
Portador de conta de pagamentos
post
Cadastrar portador pessoa física
put
Alterar cadastro de pessoa física
post
Cadastrar portador pessoa jurídica
put
Alterar cadastro de pessoa jurídica
post
Cadastrar telefone do portador
post
Cadastrar endereço do portador
post
Cadastrar documentos do portador
post
Solicitar aprovação do cadastro do portador
get
Consultar portadores do marketplace
get
Consultar portador por id
get
Consultar documento do portador por id
get
Consultar documentação do portador
get
Consultar endereço do portador
get
Consultar endereço do portador por id
get
Consultar telefone do portador
put
Alterar telefone do portador
delete
Excluir telefone do portador
delete
Excluir documento do portador
put
Alterar endereço do portador
delete
Excluir endereço do portador
Sócio
post
Cadastrar sócio
put
Alterar cadastro do sócio
post
Cadastrar telefone de sócio
post
Cadastrar endereço de sócio
post
Cadastrar documento de sócio
get
Consultar sócio por id
get
Consultar sócios de um portador
get
Consultar documentação do sócio
get
Consultar documento do sócio por id
get
Consultar endereço de sócio por id
get
Consultar endereços do sócio
get
Consultar telefone do sócio por id
get
Consultar telefones do sócio
delete
Excluir documento do Sócio
put
Alterar endereço do sócio
delete
Excluir endereço do sócio
put
Alterar telefone do sócio
delete
Excluir telefone do sócio
Associado
post
Cadastrar associado
post
Cadastrar endereço do associado
post
Cadastrar telefone do associado
post
Cadastrar documentos do associado
get
Consultar associados do marketplace
get
Consultar associados por id
get
Consultar endereço do associado
get
Consultar endereço do associado por id
get
Consultar telefone do associado
get
Consultar telefone do associado por id
get
Consultar documentos do associado
get
Consultar documentos do associado por id
get
Baixar documentos do associado
put
Alterar dados do associado
put
Alterar endereço do associado por id
put
Alterar endereço do associado principal
put
Alterar telefone do associado por id
put
Alterar telefone do associado principal
delete
Deletar associado por id
delete
Deletar telefone do associado
delete
Deletar endereço do associado por id
delete
Deletar documentos do associado por id
Informações complementares
get
Consultar CBO
get
Consultar CNAEs