Heads up, our devs are blazing ahead—docs are catching up, so some features might not be fully documented yet.
Visit our websiteAPI Documentation

PaymentMethodParameters

PaymentMethodParameters

List parameters for a tenant payment method

get

List parameters for a tenant payment method.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a tenant 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.

Responses
200Success
application/json
get
GET /v2/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/parameters HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "items": [
    {
      "tenantPaymentMethodParameterUid": "text",
      "name": "text",
      "description": "text",
      "required": true,
      "key": "text",
      "type": "TEXT",
      "regex": "text",
      "position": 1,
      "createdAt": "2025-06-27T10:12:39.262Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-06-27T10:12:39.262Z",
      "lastModifiedBy": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create parameter for a tenant payment method

post

Create a parameter for a tenant payment method. position is used to order the fields when they are listed. key is the ID of the parameter within the payment method. tenantPaymentMethodParameterUid is the primary key of the table. It is assigned a unique UUID but you can assign it your own ID if needed.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a tenant PaymentMethodUid.

Pattern: ^[A-Za-z0-9-_]+
Body
tenantPaymentMethodParameterUidstringOptionalPattern: ^[A-Za-z0-9-_]*
namestringRequired
descriptionstringOptional
requiredbooleanRequired
keystringRequired
typestring · enumRequiredPossible values:
regexstring · regexOptional

regular expression

positionintegerOptional
Responses
201Success
application/json
post
POST /v2/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/parameters HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "tenantPaymentMethodParameterUid": "text",
  "name": "text",
  "description": "text",
  "required": true,
  "key": "text",
  "type": "TEXT",
  "regex": "/[a-z]/",
  "position": 1
}
201Success
{
  "tenantPaymentMethodParameterUid": "text",
  "name": "text",
  "description": "text",
  "required": true,
  "key": "text",
  "type": "TEXT",
  "regex": "text",
  "position": 1,
  "createdAt": "2025-06-27T10:12:39.262Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-06-27T10:12:39.262Z",
  "lastModifiedBy": "text"
}

Get a parameter for a tenant payment method

get

Get a parameter for a tenant payment method.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a tenant PaymentMethodUid.

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

Primary key of the TenantPaymentMethodParameter table

Responses
200Success
application/json
get
GET /v2/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/parameters/{tenantPaymentMethodParameterUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "tenantPaymentMethodParameterUid": "text",
  "name": "text",
  "description": "text",
  "required": true,
  "key": "text",
  "type": "TEXT",
  "regex": "text",
  "position": 1,
  "createdAt": "2025-06-27T10:12:39.262Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-06-27T10:12:39.262Z",
  "lastModifiedBy": "text"
}

Update a parameter for a tenant payment method

put

Update a parameter for a tenant payment method. position is used to order the fields when they are listed. key is the ID of the parameter within the payment method. tenantPaymentMethodParameterUid is the primary key of the table. It is assigned a unique UUID but you can assign it your own ID if needed.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a tenant PaymentMethodUid.

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

Primary key of the TenantPaymentMethodParameter table

Body
namestringOptional
descriptionstringOptional
requiredbooleanOptional
keystringOptional
typestring · enumOptionalPossible values:
regexstring · regexOptional

regular expression

positionintegerOptional
Responses
200Success
application/json
put
PUT /v2/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/parameters/{tenantPaymentMethodParameterUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "name": "text",
  "description": "text",
  "required": true,
  "key": "text",
  "type": "TEXT",
  "regex": "/[a-z]/",
  "position": 1
}
200Success
{
  "tenantPaymentMethodParameterUid": "text",
  "name": "text",
  "description": "text",
  "required": true,
  "key": "text",
  "type": "TEXT",
  "regex": "text",
  "position": 1,
  "createdAt": "2025-06-27T10:12:39.262Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-06-27T10:12:39.262Z",
  "lastModifiedBy": "text"
}

Delete a parameter for a tenant payment method

delete

Delete a parameter for a tenant payment method.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a tenant PaymentMethodUid.

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

Primary key of the TenantPaymentMethodParameter table

Responses
204
No Content
delete
DELETE /v2/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/parameters/{tenantPaymentMethodParameterUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content
PreviousPaymentMethodMappingsNextPrePayment

Was this helpful?