PaymentMethodMappings

PreviousPaymentMethod NextPaymentMethodParameters

Was this helpful?

Delete a tenantPaymentMethod mapping

delete

Delete a tenantPaymentMethod mapping

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

tenantPaymentMethodUidstringrequired

Reference to a tenant PaymentMethodUid.

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

tenantPaymentMethodMappingUidstringrequired

Reference to a tenantPaymentMethodMappingUid.

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

Responses

delete

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

204

No Content

List all mappings for a tenant payment method

get

List all mappings 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

systemCodestring · enumoptional

Reference to a system code

Available options:

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

Available options:

Responses

application/json

objectoptional

get

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

200

Example response

{
  "items": [
    {
      "systemCode": "OMNIUM",
      "externalId": "text",
      "tenantPaymentMethodMappingUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add a mapping to a tenant payment method

post

Add a mapping to 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-_]+

Body

all ofoptional

Responses

application/json

all ofoptional

post

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

{
  "tenantPaymentMethodMappingUid": "text",
  "externalId": "text",
  "systemCode": "OMNIUM"
}

201

Example response

{
  "systemCode": "OMNIUM",
  "externalId": "text",
  "tenantPaymentMethodMappingUid": "text"
}

Update a mapping to a tenant payment method

put

Update a mapping to 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-_]+

tenantPaymentMethodMappingUidstringrequired

Reference to a tenantPaymentMethodMappingUid.

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

Body

externalIdstringrequired

Responses

application/json

all ofoptional

put

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

{
  "externalId": "text"
}

201

Example response

{
  "systemCode": "OMNIUM",
  "externalId": "text",
  "tenantPaymentMethodMappingUid": "text"
}