Baraka Pay DOCS

← Voltar à documentação

Vales

Um registo partilhado de códigos que um comerciante emite e qualquer das suas aplicações pode gastar.

Resgatar não movimenta dinheiro

Esta é a parte que vale a pena ler duas vezes. Resgatar um vale não lança nada no livro-razão nem movimenta qualquer saldo. Autoriza a aplicação QUE CHAMA a creditar a sua própria conta, exactamente uma vez, por um montante indicado — o crédito é consigo.

Todas as rotas estão limitadas ao comerciante por detrás da chave de API e ao ambiente dessa chave, pelo que um código de sandbox não vale nada em Live e nenhum comerciante pode ler ou gastar os códigos de outro.

O código é um título ao portador

Os códigos em texto simples são devolvidos quando o lote é emitido e nunca mais. A Baraka Pay guarda-os cifrados por hash; não há nenhum endpoint que leia um código de volta. Trate a resposta de emissão como trataria uma palavra-passe de utilização única.

O resgate é de utilização única mesmo em concorrência: dois resgates simultâneos do mesmo código produzem exactamente um sucesso e uma recusa, não dois créditos.

Endpoints

Emitir um lote, listá-los, validar um código sem o gastar, resgatá-lo, pedir a entrega de um lote a um destinatário, ou anular um código por gastar.

POST /v1/vouchers issue a batch GET /v1/vouchers list, by status or batch POST /v1/vouchers/validate check without spending POST /v1/vouchers/redeem spend, once POST /v1/vouchers/{id}/void withdraw an unspent code