POSPOS Sale

Prepare EFT Payment

Creates an EFT transaction request for the sale. Uses the POS unit’s self-service profile to resolve the EFT payment method. Requires the POS unit to be of type UNATTENDED with a self-service profile configured. If amount is omitted, the remaining balance of the sale is used.

Authentication

x-np-api-keystring
API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

saleIdUUIDRequired
The id of a POS sale. This can be provided by the API consumer when creating a new sale.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Request

This endpoint expects an object.
amountdoubleOptional
Payment amount. If omitted, the remaining balance of the sale is used.

Response

This endpoint returns an object.
transactionIdUUID

System-generated identifier for an EFT transaction request, used for polling status and cancellation.

statusenum
Status of an EFT transaction through its lifecycle
Allowed values: