For the complete documentation index, see llms.txt. This page is also available as Markdown.

Add a mapping to a tenant payment method

Add a mapping to a tenant payment method

Required permissions: PAYMENT_METHOD

post
/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/mappings
Authorizations
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
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
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"
}

Last updated

Was this helpful?