PaymentMethodMappings

PaymentMethodMappings

List all mappings for a tenant payment method

get

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

/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/mappings

List all mappings for a tenant payment method

Required permissions: PAYMENT_METHOD

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

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

Possible values:

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

Example response

application/json

get/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/mappings

HTTPcURLJavaScriptPython

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

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

/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/mappings

Add a mapping to a tenant payment method

Required permissions: PAYMENT_METHOD

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

tenantPaymentMethodUidstringRequired

Reference to a tenant PaymentMethodUid.

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

Body

application/json

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

externalIdstringRequired

systemCodestring · enumRequiredPossible values:

Responses

201

Example response

application/json

systemCodestring · enumRequiredPossible values:

externalIdstringRequired

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

post/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/mappings

HTTPcURLJavaScriptPython

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

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

/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/mappings/{tenantPaymentMethodMappingUid}

Update a mapping to a tenant payment method

Required permissions: PAYMENT_METHOD

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

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

application/json

externalIdstringRequired

Responses

201

Example response

application/json

systemCodestring · enumRequiredPossible values:

externalIdstringRequired

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

put/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/mappings/{tenantPaymentMethodMappingUid}

HTTPcURLJavaScriptPython

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

Delete a tenantPaymentMethod mapping

delete

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

/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/mappings/{tenantPaymentMethodMappingUid}

Delete a tenantPaymentMethod mapping

Required permissions: PAYMENT_METHOD

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

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

204

No Content

No content

delete/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/mappings/{tenantPaymentMethodMappingUid}

HTTPcURLJavaScriptPython

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

204

No Content

No content