Lock

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Realiza o cálculo e a reserva do valor disponível de cashback para ser utilizado em uma determinada compra. O cálculo é feito baseado na regra de resgate estabelecida pela marca, considerando o valor da compra.

Para utilizar este endpoint, você precisa fornecer o identificador do cliente e o valor da compra. O identificador do cliente deve ser o mesmo usado na integração com a Dito.

Se o cliente tiver saldo disponível, ele será retornado junto com um lock_token. Este token é exigido nas rotas de commit e rollback.

Há a possibilidade, também, de fornecer outras informações referente à compra (storeId, sellerId, source, orderVoucher, sellerVoucher, orderDiscount e informações de produtos). Estas informações são utilizadas para eventuais casos de uso em que a regra de resgate é formada por filtros mais específicos e complexos.

Somente rewards disponíveis são considerados candidatos para compor o saldo de cashback. Rewards em outros estados (indisponível, disponível, usado, expirado) serão desconsideradas.

ATENÇÃO: Todos os atributos das respostas desta rota que representam uma data estão padronizados no horário de Brasilia (GMT-3).

Body Params
string
required
length between 1 and 320

The customer identifier must be the same as that sent to Dito.

string
required
0.01 to 99999999.99

Total value of the customer order.

customData
object

Custom data, a map of string to string value.

string

The store identifier must be the same as that sent to Dito.

string

The seller identifier must be the same as that sent to Dito.

string

The source represents where the redemption request comes from (e.g., pdv, ecommerce, mobile).

string

The order voucher is the code of the voucher used in the order.

string

The seller voucher is the code of the voucher used in the order.

string
≤ 99999999.99

The order discount is the total discount applied to the order.

products
array of objects

The products represents the details of the products included in the order.

products
Headers
string
required

The brand label provided by us.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json