Skip to navigation
Referência da APITransactions Pbm

Efetiva de pedido (effective) para o PBM

Chamada pelo frontend no fechamento ou criação do pedido na loja (efetivação no PBM, alinhada ao processamento interno de pedidos). Monta paymentRoll, transaction (código derivado ou transactionCode enviado), providerCode a partir de orderNumber/operationId, product[] e control padrão por ambiente.

Obrigatório: CPF em document ou consumerDocument, e products ou items (cada linha com EAN).
Obrigatório um identificador de pedido: orderNumber ou operationId, ou apenas transactionCode se o PBM já tiver sido iniciado antes.

Opcional: attendanceHash, paymentRoll, createdAt, consumer, control (merge), transactionCode / transaction.transactionCode.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
documentstringRequired
consumerDocumentstringOptional
orderNumberstringOptional
operationIdstringOptional
transactionCodestringOptional
attendanceHashstringOptional
createdAtstringOptional
productslist of maps from strings to anyOptional
itemslist of maps from strings to anyOptional
consumermap from strings to anyOptional
paymentRollmap from strings to anyOptional
controlmap from strings to anyOptional

Response

Resposta do PBM após efetivação.

successboolean
dataanyOptional
messagestringOptional
_metaobjectOptional

Errors

400
Bad Request Error
500
Internal Server Error