Cashback - novo tipo de pagamento

Pedidos com meio de pagamento Cashback no OMS

O que é cashback?
Uma conta digital de meio de pagamento. Para pagamentos, a plataforma garante cashback (dinheiro de volta) para o comprador. É possível acumular os créditos e transferir dinheiro para outro usuário.

No processo de integração de pedidos no OMS, existem duas estruturas diferentes para definição dos pagamentos do mesmo. O order.payment, estrutura original e padrão do OMS e a order.paymentList, uma nova estrutura canônica onde também é possível enviar detalhes dos pagamentos de um pedido.

As duas estruturas funcionam de forma retrocompatível, ou seja, por mais que futuramente será incentivado que se utilize a última estrutura citada, ambas seguem funcionando normalmente.

Que informações são necessárias no pedido?

  • Enviar os dados principais que são necessários para um pagamento na estrutura padrão OMS;
  • Enviar um tipo de pagamento (type) cashback;
  • Exemplo de corpo de uma requisição (body) para criar um pedido com tipo de pagamento cashback.

Documentação publica API: https://app.swaggerhub.com/apis-docs/linx-oms/Order/

campo API

Descrição

adspaceId

ID campanha

clientPromisedCommission

Comissão de cliente valor R$

commissionPercentage

Comissão de cliente porcentagem %

externalLoadId

Identificador externo

name

Nome do programa

amount

Valor da compra, pagamento R$

storeId

Identificador da loja

id

Identificador interno do pagamento

paymentOperatorNumber

CNPJ de quem esta fazendo o processamento de pagamento

currency

Moeda

billingDate

data e hora do pagamento

captureDate

data e hora da captura do pagamento

type

Cashback

status

Parcial, completo, cancelado (para estrutura de paymentList)

Exemplo do modelo JSON:

{
    "type": "cashback",
    "paymentOperatorNumber": "foo-cnpj",
     "adspaceId": "foo-ad-id",
     "clientPromisedCommission": 10.0,
     "commissionPercentage": 10.5,
     "externalLoadId": "foo-load-id",
     "name": "foo name",
     "amount": 10.0,
     "storeId": "foo-store-id",
     "id": "foo-id",
     "grossCommission": 10.0,
}
{
"paymentType": "CASHBACK",
"paymentOperatorNumber": "foo-cnpj",
"cashback": {
     "adspaceId": "foo-ad-id",
     "clientPromisedCommission": 10.0,
     "commissionPercentage": 10.5,
     "externalLoadId": "foo-load-id",
     "name": "foo name",
     "amount": 10.0,
     "storeId": "foo-store-id",
     "id": "foo-id",
     "grossCommission": 10.0,
  }
}

Did this page help you?