PaymentMethodParameters

PreviousPaymentMethodMappings NextPrePayment

Was this helpful?

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

application/json

objectoptional

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-04-18T01:43:00.159Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-04-18T01:43:00.159Z",
  "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

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

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

application/json

objectoptional

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-04-18T01:43:00.159Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-04-18T01:43:00.159Z",
      "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 · enumrequiredAvailable options:

regexstring · regexoptional

regular expression

positionintegeroptional

Responses

application/json

objectoptional

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-04-18T01:43:00.159Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-04-18T01:43:00.159Z",
  "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 · enumoptionalAvailable options:

regexstring · regexoptional

regular expression

positionintegeroptional

Responses

application/json

objectoptional

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-04-18T01:43:00.159Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-04-18T01:43:00.159Z",
  "lastModifiedBy": "text"
}