PaymentMethodMappings
PaymentMethodMappings
List all mappings for a tenant payment method
List all mappings for a tenant payment method
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a tenant PaymentMethodUid.
^[A-Za-z0-9-_]+Reference to a system code
Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Example response
GET /v2/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/mappings HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"systemCode": "OMNIUM",
"externalId": "text",
"tenantPaymentMethodMappingUid": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Add a mapping to a tenant payment method
Add a mapping to a tenant payment method
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a tenant PaymentMethodUid.
^[A-Za-z0-9-_]+Example response
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"
}Example response
{
"systemCode": "OMNIUM",
"externalId": "text",
"tenantPaymentMethodMappingUid": "text"
}Update a mapping to a tenant payment method
Update a mapping to a tenant payment method
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a tenant PaymentMethodUid.
^[A-Za-z0-9-_]+Reference to a tenantPaymentMethodMappingUid.
^[A-Za-z0-9-_]+Example response
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"
}Example response
{
"systemCode": "OMNIUM",
"externalId": "text",
"tenantPaymentMethodMappingUid": "text"
}Delete a tenantPaymentMethod mapping
Delete a tenantPaymentMethod mapping
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a tenant PaymentMethodUid.
^[A-Za-z0-9-_]+Reference to a tenantPaymentMethodMappingUid.
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/mappings/{tenantPaymentMethodMappingUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Was this helpful?