PaymentMethod

PaymentMethod

Get list of all payment methods available in Flow Retail

get

Get list of all payment methods in flowRetail

Authorizations

accessTokenauthTokenintegrationToken

Query parameters

tenantUidstringOptional

Reference to a tenant uid

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

Responses

200

PaymentMethod list response

application/json

get

HTTPcURLJavaScriptPython

GET /v2/paymentmethods HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

PaymentMethod list response

{
  "items": [
    {
      "allowRefund": true,
      "allowSale": true,
      "allowAmount": true,
      "allowCashback": true,
      "requireExclusiveUse": true,
      "name": "text",
      "parameters": [
        {
          "key": "text",
          "keyType": "TEXT",
          "name": "text",
          "required": true
        }
      ],
      "paymentCode": "CASH"
    }
  ]
}

List tenant payment methods

get

List all payment methods available for tenant.

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

systemCodestring · enumOptional

Reference to a system code

Possible values:

Responses

200

TenantPaymentMethod list response

application/json

get

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/paymentmethods HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

TenantPaymentMethod list response

{
  "items": [
    {
      "active": true,
      "name": "text",
      "description": "text",
      "settlementCode": "text",
      "paymentMethod": {
        "allowRefund": true,
        "allowSale": true,
        "allowAmount": true,
        "allowCashback": true,
        "requireExclusiveUse": true,
        "name": "text",
        "parameters": [
          {
            "key": "text",
            "keyType": "TEXT",
            "name": "text",
            "required": true
          }
        ],
        "paymentCode": "CASH"
      },
      "tenantPaymentMethodUid": "text",
      "allowRefund": true,
      "allowSale": true,
      "allowCashback": true,
      "parameters": [
        {
          "name": "text",
          "description": "text",
          "required": true,
          "key": "text",
          "type": "TEXT",
          "regex": "text"
        }
      ],
      "externalSystemMappings": [
        {
          "systemCode": "OMNIUM",
          "externalId": "text",
          "tenantPaymentMethodMappingUid": "text"
        }
      ],
      "position": 1,
      "visibility": "FEATURED"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add a payment method to tenant

post

Add a payment method to the tenant.

For external payment methods, settlementCode is required. It must have the prefixEXTERNAL_.

For all other payment methods, the payment code is used as the settlement code.

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

activebooleanOptional

namestringOptional

Name of the payment method as it should be displayed on screen and receipts

descriptionstringOptional

A description of the payment method, shown in the client

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

settlementCodestringOptional

paymentMethodCodestring · enumRequiredPossible values:

positionintegerRequired

order of appearance in lists

visibilitystring · enumRequiredPossible values:

Responses

200

Return a list of all paymentMethods in FlowRetail

application/json

post

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/paymentmethods HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "active": true,
  "name": "text",
  "description": "text",
  "tenantPaymentMethodUid": "text",
  "settlementCode": "text",
  "paymentMethodCode": "CASH",
  "position": 1,
  "visibility": "FEATURED"
}

200

Return a list of all paymentMethods in FlowRetail

{
  "active": true,
  "name": "text",
  "description": "text",
  "settlementCode": "text",
  "paymentMethod": {
    "allowRefund": true,
    "allowSale": true,
    "allowAmount": true,
    "allowCashback": true,
    "requireExclusiveUse": true,
    "name": "text",
    "parameters": [
      {
        "key": "text",
        "keyType": "TEXT",
        "name": "text",
        "required": true
      }
    ],
    "paymentCode": "CASH"
  },
  "tenantPaymentMethodUid": "text",
  "allowRefund": true,
  "allowSale": true,
  "allowCashback": true,
  "parameters": [
    {
      "name": "text",
      "description": "text",
      "required": true,
      "key": "text",
      "type": "TEXT",
      "regex": "text"
    }
  ],
  "externalSystemMappings": [
    {
      "systemCode": "OMNIUM",
      "externalId": "text",
      "tenantPaymentMethodMappingUid": "text"
    }
  ],
  "position": 1,
  "visibility": "FEATURED"
}

Get tenant paymentmethod details

get

Get paymentmethod details.

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantPaymentMethodUidstringRequired

Reference to a tenant PaymentMethodUid.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

200

Return a list of all paymentMethods in FlowRetail

application/json

get

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Return a list of all paymentMethods in FlowRetail

{
  "active": true,
  "name": "text",
  "description": "text",
  "settlementCode": "text",
  "paymentMethod": {
    "allowRefund": true,
    "allowSale": true,
    "allowAmount": true,
    "allowCashback": true,
    "requireExclusiveUse": true,
    "name": "text",
    "parameters": [
      {
        "key": "text",
        "keyType": "TEXT",
        "name": "text",
        "required": true
      }
    ],
    "paymentCode": "CASH"
  },
  "tenantPaymentMethodUid": "text",
  "allowRefund": true,
  "allowSale": true,
  "allowCashback": true,
  "parameters": [
    {
      "name": "text",
      "description": "text",
      "required": true,
      "key": "text",
      "type": "TEXT",
      "regex": "text"
    }
  ],
  "externalSystemMappings": [
    {
      "systemCode": "OMNIUM",
      "externalId": "text",
      "tenantPaymentMethodMappingUid": "text"
    }
  ],
  "position": 1,
  "visibility": "FEATURED"
}

Update paymentmethods details

put

Update paymentmethod details for tenant.

settlementCode can only be set and updated for EXTERNAL payment methods. It must have the prefixEXTERNAL_.

For all other payment methods, the payment code is used as the settlement code.

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantPaymentMethodUidstringRequired

Reference to a tenant PaymentMethodUid.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

activebooleanOptional

namestringOptional

The name will be displayed in the clients and on the receipt

descriptionstringOptional

A description of the payment method, shown in the client

allowSalebooleanOptional

allowRefundbooleanOptional

allowCashbackbooleanOptional

settlementCodestringOptional

positionintegerOptional

order of appearance in lists

visibilitystring · enumOptionalPossible values:

Responses

200

Return a list of all paymentMethods in FlowRetail

application/json

put

HTTPcURLJavaScriptPython

PUT /v2/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "active": true,
  "name": "text",
  "description": "text",
  "allowSale": true,
  "allowRefund": true,
  "allowCashback": true,
  "settlementCode": "text",
  "position": 1,
  "visibility": "FEATURED"
}

200

Return a list of all paymentMethods in FlowRetail

{
  "active": true,
  "name": "text",
  "description": "text",
  "settlementCode": "text",
  "paymentMethod": {
    "allowRefund": true,
    "allowSale": true,
    "allowAmount": true,
    "allowCashback": true,
    "requireExclusiveUse": true,
    "name": "text",
    "parameters": [
      {
        "key": "text",
        "keyType": "TEXT",
        "name": "text",
        "required": true
      }
    ],
    "paymentCode": "CASH"
  },
  "tenantPaymentMethodUid": "text",
  "allowRefund": true,
  "allowSale": true,
  "allowCashback": true,
  "parameters": [
    {
      "name": "text",
      "description": "text",
      "required": true,
      "key": "text",
      "type": "TEXT",
      "regex": "text"
    }
  ],
  "externalSystemMappings": [
    {
      "systemCode": "OMNIUM",
      "externalId": "text",
      "tenantPaymentMethodMappingUid": "text"
    }
  ],
  "position": 1,
  "visibility": "FEATURED"
}

List store payment methods

get

Get list of payment methods for store.

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Responses

200

StorePaymentMethod list response

application/json

get

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/paymentmethods HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

StorePaymentMethod list response

{
  "items": [
    {
      "active": true,
      "ledgerNumber": "text",
      "ledgerType": "LEDGER",
      "storePaymentMethodUid": "text",
      "storeSettlementIssuers": true,
      "tenantPaymentMethod": {
        "active": true,
        "name": "text",
        "description": "text",
        "settlementCode": "text",
        "paymentMethod": {
          "allowRefund": true,
          "allowSale": true,
          "allowAmount": true,
          "allowCashback": true,
          "requireExclusiveUse": true,
          "name": "text",
          "parameters": [
            {
              "key": "text",
              "keyType": "TEXT",
              "name": "text",
              "required": true
            }
          ],
          "paymentCode": "CASH"
        },
        "tenantPaymentMethodUid": "text",
        "allowRefund": true,
        "allowSale": true,
        "allowCashback": true,
        "parameters": [
          {
            "name": "text",
            "description": "text",
            "required": true,
            "key": "text",
            "type": "TEXT",
            "regex": "text"
          }
        ],
        "externalSystemMappings": [
          {
            "systemCode": "OMNIUM",
            "externalId": "text",
            "tenantPaymentMethodMappingUid": "text"
          }
        ],
        "position": 1,
        "visibility": "FEATURED"
      }
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add a payment method to a store

post

Add a payment method to a store

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

Body

activebooleanOptional

ledgerNumberstringOptional

Ledger number must be a valid number with possible leading zeros

ledgerTypestring · enumOptional

ENUM	Description
LEDGER	Ledger
GENERAL_LEDGER	General ledger
CUSTOMER_LEDGER	Customer ledger

Possible values:

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

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

Responses

200

StorePaymentMethod response

application/json

post

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/stores/{storeUid}/paymentmethods HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "active": true,
  "ledgerNumber": "text",
  "ledgerType": "LEDGER",
  "tenantPaymentMethodUid": "text",
  "storePaymentMethodUid": "text"
}

200

StorePaymentMethod response

{
  "active": true,
  "ledgerNumber": "text",
  "ledgerType": "LEDGER",
  "storePaymentMethodUid": "text",
  "storeSettlementIssuers": true,
  "tenantPaymentMethod": {
    "active": true,
    "name": "text",
    "description": "text",
    "settlementCode": "text",
    "paymentMethod": {
      "allowRefund": true,
      "allowSale": true,
      "allowAmount": true,
      "allowCashback": true,
      "requireExclusiveUse": true,
      "name": "text",
      "parameters": [
        {
          "key": "text",
          "keyType": "TEXT",
          "name": "text",
          "required": true
        }
      ],
      "paymentCode": "CASH"
    },
    "tenantPaymentMethodUid": "text",
    "allowRefund": true,
    "allowSale": true,
    "allowCashback": true,
    "parameters": [
      {
        "name": "text",
        "description": "text",
        "required": true,
        "key": "text",
        "type": "TEXT",
        "regex": "text"
      }
    ],
    "externalSystemMappings": [
      {
        "systemCode": "OMNIUM",
        "externalId": "text",
        "tenantPaymentMethodMappingUid": "text"
      }
    ],
    "position": 1,
    "visibility": "FEATURED"
  }
}

Get details of a payment method for store

get

Get details of a payment method for store

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

storePaymentMethodUidstringRequired

Reference to a store PaymentMethodUid.

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

Responses

200

StorePaymentMethod response

application/json

get

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/paymentmethods/{storePaymentMethodUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

StorePaymentMethod response

{
  "active": true,
  "ledgerNumber": "text",
  "ledgerType": "LEDGER",
  "storePaymentMethodUid": "text",
  "storeSettlementIssuers": true,
  "tenantPaymentMethod": {
    "active": true,
    "name": "text",
    "description": "text",
    "settlementCode": "text",
    "paymentMethod": {
      "allowRefund": true,
      "allowSale": true,
      "allowAmount": true,
      "allowCashback": true,
      "requireExclusiveUse": true,
      "name": "text",
      "parameters": [
        {
          "key": "text",
          "keyType": "TEXT",
          "name": "text",
          "required": true
        }
      ],
      "paymentCode": "CASH"
    },
    "tenantPaymentMethodUid": "text",
    "allowRefund": true,
    "allowSale": true,
    "allowCashback": true,
    "parameters": [
      {
        "name": "text",
        "description": "text",
        "required": true,
        "key": "text",
        "type": "TEXT",
        "regex": "text"
      }
    ],
    "externalSystemMappings": [
      {
        "systemCode": "OMNIUM",
        "externalId": "text",
        "tenantPaymentMethodMappingUid": "text"
      }
    ],
    "position": 1,
    "visibility": "FEATURED"
  }
}

Update a payment method for a store

put

Update a payment method for a store

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

storePaymentMethodUidstringRequired

Reference to a store PaymentMethodUid.

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

Body

activebooleanOptional

ledgerNumberstringOptional

Ledger number must be a valid number with possible leading zeros

ledgerTypestring · enumOptional

ENUM	Description
LEDGER	Ledger
GENERAL_LEDGER	General ledger
CUSTOMER_LEDGER	Customer ledger

Possible values:

Responses

200

StorePaymentMethod response

application/json

put

HTTPcURLJavaScriptPython

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/paymentmethods/{storePaymentMethodUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "active": true,
  "ledgerNumber": "text",
  "ledgerType": "LEDGER"
}

200

StorePaymentMethod response

{
  "active": true,
  "ledgerNumber": "text",
  "ledgerType": "LEDGER",
  "storePaymentMethodUid": "text",
  "storeSettlementIssuers": true,
  "tenantPaymentMethod": {
    "active": true,
    "name": "text",
    "description": "text",
    "settlementCode": "text",
    "paymentMethod": {
      "allowRefund": true,
      "allowSale": true,
      "allowAmount": true,
      "allowCashback": true,
      "requireExclusiveUse": true,
      "name": "text",
      "parameters": [
        {
          "key": "text",
          "keyType": "TEXT",
          "name": "text",
          "required": true
        }
      ],
      "paymentCode": "CASH"
    },
    "tenantPaymentMethodUid": "text",
    "allowRefund": true,
    "allowSale": true,
    "allowCashback": true,
    "parameters": [
      {
        "name": "text",
        "description": "text",
        "required": true,
        "key": "text",
        "type": "TEXT",
        "regex": "text"
      }
    ],
    "externalSystemMappings": [
      {
        "systemCode": "OMNIUM",
        "externalId": "text",
        "tenantPaymentMethodMappingUid": "text"
      }
    ],
    "position": 1,
    "visibility": "FEATURED"
  }
}

Get list of issuers for a settlement on a store

get

Get list of issuers for a settlement on a store

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

storePaymentMethodUidstringRequired

Reference to a store PaymentMethodUid.

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

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Responses

200

StorePaymentMethodIssuer list response

application/json

get

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/paymentmethods/{storePaymentMethodUid}/settlementissuers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

StorePaymentMethodIssuer list response

{
  "items": [
    {
      "code": "text",
      "ledgerNumber": "text",
      "ledgerType": "LEDGER",
      "name": "text",
      "storeSettlementIssuerUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get details of an issuer for a settlement on a store

get

Get details of an issuer for a settlement on a store

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

storePaymentMethodUidstringRequired

Reference to a store PaymentMethodUid.

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

storeSettlementIssuerUidstringRequired

Reference to a store settlement issuerId.

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

Responses

200

StorePaymentMethodIssuer response

application/json

get

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/paymentmethods/{storePaymentMethodUid}/settlementissuers/{storeSettlementIssuerUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

StorePaymentMethodIssuer response

{
  "code": "text",
  "ledgerNumber": "text",
  "ledgerType": "LEDGER",
  "name": "text",
  "storeSettlementIssuerUid": "text"
}

Update details of an issuer for a settlement on a store

put

Update details of an issuer for a settlement on a store

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

storePaymentMethodUidstringRequired

Reference to a store PaymentMethodUid.

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

storeSettlementIssuerUidstringRequired

Reference to a store settlement issuerId.

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

Body

ledgerNumberstringOptional

Ledger number must be a valid number with possible leading zeros

ledgerTypestring · enumOptional

ENUM	Description
LEDGER	Ledger
GENERAL_LEDGER	General ledger
CUSTOMER_LEDGER	Customer ledger

Possible values:

Responses

200

StorePaymentMethodIssuer response

application/json

put

HTTPcURLJavaScriptPython

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/paymentmethods/{storePaymentMethodUid}/settlementissuers/{storeSettlementIssuerUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "ledgerNumber": "text",
  "ledgerType": "LEDGER"
}

200

StorePaymentMethodIssuer response

{
  "code": "text",
  "ledgerNumber": "text",
  "ledgerType": "LEDGER",
  "name": "text",
  "storeSettlementIssuerUid": "text"
}