PrePayment

PrePayment

Create a pre-payment on order

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/pre-payments

Create a pre-payment on order. Returns a settlementUid, and is handled at the settlements/{settlementUid} endpoint

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+

Body

application/json

Create a new settlement

amountintegerRequired

in cents, e.g. 1,50 as 150

externalIdstringOptional

External reference for the settlement

settlementCodestringRequired

settlementUidstringOptionalPattern: ^[A-Za-z0-9-_]+

Responses

201

Example response

application/json

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/pre-payments

HTTPcURLJavaScriptPython

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"
}

201

Example response

{
  "amount": 1,
  "createdAt": "2025-12-16T00:01:37.837Z",
  "displayMessages": [
    {
      "key": "text",
      "message": "text",
      "timestamp": "2025-12-16T00:01:37.837Z"
    }
  ],
  "externalId": "text",
  "externalPaymentReference": "text",
  "idMethod": "NO_CVM_RULE_PERFORMED",
  "lastModifiedAt": "2025-12-16T00:01:37.837Z",
  "ledgerNumber": "text",
  "ledgerType": "LEDGER",
  "parameters": [
    {
      "key": "text",
      "value": "text",
      "name": "text",
      "type": "TEXT"
    }
  ],
  "settledAt": "2025-12-16T00:01:37.837Z",
  "settlementCode": "text",
  "settlementUid": "text",
  "settlementName": "text",
  "state": "NOT_STARTED",
  "status": "NEW",
  "storeSettlementIssuer": {
    "storeSettlementIssuerUid": "text",
    "name": "text",
    "code": "text"
  },
  "tenantUserDisplayName": "text",
  "tenantUserUid": "text",
  "storePaymentMethodUid": "text",
  "currency": {
    "amount": 1,
    "code": "text",
    "exchangeRate": 1
  },
  "additionalDetails": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "creditCount": 1,
  "creditAmount": 1,
  "paymentCount": 1,
  "paymentAmount": 1,
  "orderReceiptUid": "text"
}

Create a pre-payment refund on order

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/pre-payments/refund

Create a pre-payment refund on order. Returns a settlementUid, and is handled at the settlements/{settlementUid} endpoint

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+

Body

application/json

Create a new settlement refund

amountintegerRequired

in cents, e.g. 1,50 as 150

externalIdstringOptional

External reference for the settlement

settlementCodestringRequired

settlementUidstringOptional

The settlement uid

Pattern: ^[A-Za-z0-9-_]+

referencingSettlementUidstringRequired

The settlement that is being refunded

Pattern: ^[A-Za-z0-9-_]+

Responses

201

Example response

application/json

post

/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/pre-payments/refund

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/pre-payments/refund HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "amount": 1,
  "externalId": "text",
  "settlementCode": "text",
  "parameters": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "settlementUid": "text",
  "referencingSettlementUid": "text"
}

201

Example response

{
  "amount": 1,
  "createdAt": "2025-12-16T00:01:37.837Z",
  "displayMessages": [
    {
      "key": "text",
      "message": "text",
      "timestamp": "2025-12-16T00:01:37.837Z"
    }
  ],
  "externalId": "text",
  "externalPaymentReference": "text",
  "idMethod": "NO_CVM_RULE_PERFORMED",
  "lastModifiedAt": "2025-12-16T00:01:37.837Z",
  "ledgerNumber": "text",
  "ledgerType": "LEDGER",
  "parameters": [
    {
      "key": "text",
      "value": "text",
      "name": "text",
      "type": "TEXT"
    }
  ],
  "settledAt": "2025-12-16T00:01:37.837Z",
  "settlementCode": "text",
  "settlementUid": "text",
  "settlementName": "text",
  "state": "NOT_STARTED",
  "status": "NEW",
  "storeSettlementIssuer": {
    "storeSettlementIssuerUid": "text",
    "name": "text",
    "code": "text"
  },
  "tenantUserDisplayName": "text",
  "tenantUserUid": "text",
  "storePaymentMethodUid": "text",
  "currency": {
    "amount": 1,
    "code": "text",
    "exchangeRate": 1
  },
  "additionalDetails": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "creditCount": 1,
  "creditAmount": 1,
  "paymentCount": 1,
  "paymentAmount": 1,
  "orderReceiptUid": "text"
}