Banking API
Search…
Pagamentos Pix
Nesta seção serão descritas e mantidas todas as APIs de interação com o produto de pagamentos/recebimentos de banking para o PIX que são expostas para nossos clientes finais.

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

Não se deve usar o 2FA em sandbox.
post
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/pix/holders/:holder_id/accounts/:account_id/payments/manual-entry
Criar pagamento de debito Pix com dados manuais
post
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/pix/holders/:holder_id/accounts/:account_id/payments/dict
Criar pagamento de debito Pix com chave DICT
post
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/pix/holders/:holder_id/accounts/:account_id/payments/init
Criar pagamento de debito Pix
post
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/pix/holders/:holder_id/accounts/:account_id/payments/:paymentId/create
Criar Pix pelo id do pagamento
post
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/pix/holders/:holder_id/accounts/:account_id/payments/:paymentId/confirm
Confirmar pagamento Pix
post
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/pix/holders/:holder_id/accounts/:account_id/payments/:paymentId/cancel
Cancelar pagamento Pix
post
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/pix/holders/:holder_id/accounts/:account_id/payments/:paymentId/refunds
Devolver recebimento de Pix
{
"amount": 12000,
"reason": {
"additional_information": "envio errado",
"code": "AM05"
}
}
get
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/pix/holders/:holder_id/accounts/:account_id/payments/:paymentId
Consultar pagamento Pix
get
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/pix/holders/:holder_id/accounts/:account_id/payments/scheduled
Consultar pagamentos agendados Pix
get
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/pix/holders/:holder_id/accounts/:account_id/payments/:paymentId/refunds/:refund_id
Consultar devolução
get
https://api.zoop.ws
/v3/marketplaces/:marketplace_id/banking/pix/holders/:holder_id/accounts/:account_id/payments/:paymentId/refunds
Listar devoluções