PrePayment
Create a pre-payment on order. Returns a settlementUid, and is handled at the settlements/{settlementUid} endpoint
Accesstoken recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Create a new settlement
in cents, e.g. 1,50 as 150
External reference for the settlement
^[A-Za-z0-9-_]+Example response
Example response
POST /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/pre-payments HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124
{
"amount": 1,
"externalId": "text",
"settlementCode": "text",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settlementUid": "text"
}{
"amount": 1,
"createdAt": "2025-12-08T23:55:52.348Z",
"displayMessages": [
{
"key": "text",
"message": "text",
"timestamp": "2025-12-08T23:55:52.348Z"
}
],
"externalId": "text",
"externalPaymentReference": "text",
"idMethod": "NO_CVM_RULE_PERFORMED",
"lastModifiedAt": "2025-12-08T23:55:52.348Z",
"ledgerNumber": "text",
"ledgerType": "LEDGER",
"parameters": [
{
"key": "text",
"value": "text"
}
],
"settledAt": "2025-12-08T23:55:52.348Z",
"settlementCode": "text",
"settlementUid": "text",
"settlementName": "text",
"state": "NOT_STARTED",
"status": "NEW",
"storeSettlementIssuerUid": "text",
"tenantUserDisplayName": "text",
"tenantUserUid": "text",
"storePaymentMethodUid": "text",
"currency": {
"amount": 1,
"code": "text",
"exchangeRate": 1
},
"additionalDetails": [
{
"key": "text",
"value": "text"
}
],
"paymentCount": 1,
"paymentAmount": 1,
"orderReceiptUid": "text"
}