Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/fabric-com-payments-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Fabric Com Payments API
version: 3.0.0
license:
name: fabric API License
url: https://fabric.inc/api-license
x-refined-note:
- x-audience differs across the merged source definitions and was not carried
description: 'Operations tagged Payments across 2 of this provider''s published API definitions: fabric-cart-openapi.yml, fabric-orders-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.fabric.inc/v3
tags:
- name: Payments
description: Payments endpoints are used to add add, update and remove payments from the Cart.
paths:
/carts/{cartId}/payments:
post:
tags:
- Payments
summary: Create Payment
description: 'Adds a payment method to the corresponding cart to process a transaction.
The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter.
'
operationId: createPayment
parameters:
- name: cartId
in: path
required: true
schema:
type: string
description: The 24-character system-generated Cart ID. This ID is generated using the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint.
- name: x-fabric-tenant-id
in: header
description: "A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from [Copilot](/v3/platform/settings/account-details/getting-the-account-id). This header is required. \n"
required: true
schema:
type: string
example: 617329dfd5288b0011332311
- name: x-fabric-request-id
in: header
description: ' Unique request ID for tracking.'
required: false
schema:
type: string
example: 263e731c-45c8-11ed-b878-0242ac120002
- name: x-fabric-channel-id
in: header
description: x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is a required field. The default US channel is 12 while the default Canada channel is 11.
required: false
schema:
type: string
example: '12'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePaymentRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/NewPayment'
'400':
description: Client error
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
'404':
description: Cart or Payment not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
security:
- bearerAuth: []
servers:
- url: https://api.fabric.inc/v3
/carts/{cartId}/payments/{id}/actions/delete-attributes:
post:
tags:
- Payments
summary: Delete Payment Attributes
description: 'Partially deletes attributes of your choice in the payment object associated with the corresponding cart.
The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter.
The ID from the [Create payment](/v3/cart-and-checkout/api-reference/carts-v3/payments/create-payments) endpoint is used in the path parameter.
'
operationId: deletePaymentAttributes
parameters:
- name: cartId
in: path
required: true
schema:
type: string
description: The 24-character system-generated Cart ID. This ID is generated using the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint.
- name: id
in: path
required: true
schema:
type: string
description: The Payment ID that was generated when a payment was created using the [Create payment](/v3/cart-and-checkout/api-reference/carts-v3/payments/create-payments) endpoint.
- name: x-fabric-tenant-id
in: header
description: "A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from [Copilot](/v3/platform/settings/account-details/getting-the-account-id). This header is required. \n"
required: true
schema:
type: string
example: 617329dfd5288b0011332311
- name: x-fabric-request-id
in: header
description: ' Unique request ID for tracking.'
required: false
schema:
type: string
example: 263e731c-45c8-11ed-b878-0242ac120002
- name: x-fabric-channel-id
in: header
description: x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is a required field. The default US channel is 12 while the default Canada channel is 11.
required: false
schema:
type: string
example: '12'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAttributesRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Payment'
'400':
description: Client error
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
'404':
description: Cart or Payment not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
security:
- bearerAuth: []
servers:
- url: https://api.fabric.inc/v3
/carts/{cartId}/payments/{id}/actions/add-attributes:
post:
tags:
- Payments
summary: Add Payment Attributes
description: 'Partially updates attributes of your choice in the payment.
The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter.
The ID from the [Create payment](/v3/cart-and-checkout/api-reference/carts-v3/payments/create-payments) endpoint is used in the path parameter.
'
operationId: addPaymentAttributes
parameters:
- name: cartId
in: path
required: true
schema:
type: string
description: The 24-character system-generated Cart ID. This ID is generated using the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint.
- name: id
in: path
required: true
schema:
type: string
description: The Payment ID that was generated when a payment was created using the [Create payment](/v3/cart-and-checkout/api-reference/carts-v3/payments/create-payments) endpoint.
- name: x-fabric-tenant-id
in: header
description: "A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from [Copilot](/v3/platform/settings/account-details/getting-the-account-id). This header is required. \n"
required: true
schema:
type: string
example: 617329dfd5288b0011332311
- name: x-fabric-request-id
in: header
description: ' Unique request ID for tracking.'
required: false
schema:
type: string
example: 263e731c-45c8-11ed-b878-0242ac120002
- name: x-fabric-channel-id
in: header
description: x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is a required field. The default US channel is 12 while the default Canada channel is 11.
required: false
schema:
type: string
example: '12'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddAttributesRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Payment'
'400':
description: Client error
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
'404':
description: Cart or Payment not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
security:
- bearerAuth: []
servers:
- url: https://api.fabric.inc/v3
/carts/{cartId}/payments/{id}:
delete:
tags:
- Payments
summary: Delete Payment
description: 'Removes the payment from the cart.
The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter.
The ID from the [Create payment](/v3/cart-and-checkout/api-reference/carts-v3/payments/create-payments) endpoint is used in the path parameter.
'
operationId: removePayment
parameters:
- name: cartId
in: path
required: true
schema:
type: string
description: The 24-character system-generated Cart ID. This ID is generated using the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint.
- name: id
in: path
required: true
schema:
type: string
description: The Payment ID that was generated when a payment was created using the [Create payment](/v3/cart-and-checkout/api-reference/carts-v3/payments/create-payments) endpoint.
- name: x-fabric-tenant-id
in: header
description: "A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from [Copilot](/v3/platform/settings/account-details/getting-the-account-id). This header is required. \n"
required: true
schema:
type: string
example: 617329dfd5288b0011332311
- name: x-fabric-request-id
in: header
description: ' Unique request ID for tracking.'
required: false
schema:
type: string
example: 263e731c-45c8-11ed-b878-0242ac120002
- name: x-fabric-channel-id
in: header
description: x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is a required field. The default US channel is 12 while the default Canada channel is 11.
required: false
schema:
type: string
example: '12'
responses:
'204':
description: No Content
'400':
description: Client error
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
'404':
description: Cart or Payment not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
security:
- bearerAuth: []
patch:
tags:
- Payments
summary: Update Payment
description: 'Updates the payment in the cart.
The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter.
The ID from the [Create payment](/v3/cart-and-checkout/api-reference/carts-v3/payments/create-payments) endpoint is used in the path parameter.
'
operationId: updatePayment
parameters:
- name: cartId
in: path
required: true
schema:
type: string
description: The 24-character system-generated Cart ID. This ID is generated using the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint.
- name: id
in: path
required: true
schema:
type: string
description: The Payment ID that was generated when a payment was created using the [Create payment](/v3/cart-and-checkout/api-reference/carts-v3/payments/create-payments) endpoint.
- name: x-fabric-tenant-id
in: header
description: "A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from [Copilot](/v3/platform/settings/account-details/getting-the-account-id). This header is required. \n"
required: true
schema:
type: string
example: 617329dfd5288b0011332311
- name: x-fabric-request-id
in: header
description: ' Unique request ID for tracking.'
required: false
schema:
type: string
example: 263e731c-45c8-11ed-b878-0242ac120002
- name: x-fabric-channel-id
in: header
description: x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is a required field. The default US channel is 12 while the default Canada channel is 11.
required: false
schema:
type: string
example: '12'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePaymentRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Payment'
'400':
description: Client error
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
'404':
description: Cart or Payment not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
security:
- bearerAuth: []
servers:
- url: https://api.fabric.inc/v3
/orders/actions/authorize-payments:
post:
description: This endpoint is used synchronously or asynchronously for authorizing order payments pending for authorization.
operationId: authorizeOrderPayments
parameters:
- $ref: '#/components/parameters/xFabricTenantId'
- $ref: '#/components/parameters/xFabricChannelId'
- $ref: '#/components/parameters/xFabricRequestId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/paymentAuthorizationRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/paymentAuthorizationResponse'
description: OK
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
'400':
content:
application/json:
example:
errors:
- message: Invalid request
type: CLIENT_ERROR
message: Bad request
type: CLIENT_ERROR
schema:
$ref: '#/components/schemas/errorResponse'
description: Bad request
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
'401':
content:
application/json:
example:
message: Unauthorized request
type: CLIENT_ERROR
schema:
$ref: '#/components/schemas/errorResponse'
description: Unauthorized
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
'404':
content:
application/json:
example:
message: Not found
type: CLIENT_ERROR
schema:
$ref: '#/components/schemas/errorResponse'
description: Not found
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
'500':
content:
application/json:
example:
message: Internal server error
type: SERVER_ERROR
schema:
$ref: '#/components/schemas/errorResponse'
description: Internal server error
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
summary: Authorize Order Payments
tags:
- Payments
security:
- authorization: []
servers:
- description: Production
url: https://api.fabric.inc/v3
/orders/order-number/{orderNumber}/actions/update-payment-status:
post:
description: This endpoint is used sync order payments when transactions happen externally. Additionally, used for updating order payment status and the amount, whether it is captured, refunded or void amount. <p> If you don't have order number, use the corresponding order ID-based endpoint - POST /orders/{orderId}/actions/update-payment-status. </p>
operationId: updatePaymentStatusByOrderNumber
parameters:
- description: Merchant-defined order identifier
example: 123k4h123k
in: path
name: orderNumber
required: true
schema:
type: string
- $ref: '#/components/parameters/xFabricTenantId'
- $ref: '#/components/parameters/xFabricChannelId'
- $ref: '#/components/parameters/xFabricRequestId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/updatePaymentRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/orderResponse'
description: OK
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
'400':
content:
application/json:
example:
errors:
- message: Invalid request
type: CLIENT_ERROR
message: Bad request
type: CLIENT_ERROR
schema:
$ref: '#/components/schemas/errorResponse'
description: Bad request
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
'401':
content:
application/json:
example:
message: Unauthorized request
type: CLIENT_ERROR
schema:
$ref: '#/components/schemas/errorResponse'
description: Unauthorized
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
'404':
content:
application/json:
example:
message: Not found
type: CLIENT_ERROR
schema:
$ref: '#/components/schemas/errorResponse'
description: Not found
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
'500':
content:
application/json:
example:
message: Internal server error
type: SERVER_ERROR
schema:
$ref: '#/components/schemas/errorResponse'
description: Internal server error
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
summary: Update Status of Order Payment by Order Number
tags:
- Payments
security:
- authorization: []
servers:
- description: Production
url: https://api.fabric.inc/v3
/orders/{orderId}/actions/update-payment-status:
post:
description: This endpoint is used sync order payments when transactions happen externally. Additionally, used for updating order payment status and the amount, whether it is captured, refunded or void amount. <p> If you don't have order ID, use the corresponding order number-based endpoint - POST /orders/order-number/{orderNumber}/actions/update-payment-status.</p>
operationId: updatePaymentStatus
parameters:
- description: 24-character system-generated ID. It is returned in the response of Create Order - `POST /orders` endpoint.
example: 5349b4ddd2781d08c09890f4
in: path
name: orderId
required: true
schema:
type: string
- $ref: '#/components/parameters/xFabricTenantId'
- $ref: '#/components/parameters/xFabricChannelId'
- $ref: '#/components/parameters/xFabricRequestId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/updatePaymentRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/orderResponse'
description: OK
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
'400':
content:
application/json:
example:
errors:
- message: Invalid request
type: CLIENT_ERROR
message: Bad request
type: CLIENT_ERROR
schema:
$ref: '#/components/schemas/errorResponse'
description: Bad request
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
'401':
content:
application/json:
example:
message: Unauthorized request
type: CLIENT_ERROR
schema:
$ref: '#/components/schemas/errorResponse'
description: Unauthorized
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
'404':
content:
application/json:
example:
message: Not found
type: CLIENT_ERROR
schema:
$ref: '#/components/schemas/errorResponse'
description: Not found
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
'500':
content:
application/json:
example:
message: Internal server error
type: SERVER_ERROR
schema:
$ref: '#/components/schemas/errorResponse'
description: Internal server error
headers:
x-fabric-request-id:
$ref: '#/components/headers/xFabricRequestIdResponseHeader'
summary: Update Order Payment Status by Order ID
tags:
- Payments
security:
- authorization: []
servers:
- description: Production
url: https://api.fabric.inc/v3
components:
schemas:
Payment:
type: object
properties:
id:
type: string
description: The Payment ID that was generated when a payment was created using the [Create payment](/v3/cart-and-checkout/api-reference/carts-v3/payments/create-payments) endpoint.
example: 6ef2067a-5d6b-4785-a090-96ea0078220d
provider:
type: string
description: The payment provider, such as Verifone, that offers functions like transaction processing, gateway management, and other financial services.
example: verifone
processor:
type: string
description: The payment processor, such as Stripe, responsible for handling and processing payment transactions by facilitating communication between the merchant and the issuing bank.
example: stripe
method:
type: string
description: Payment method, such as Apple Pay, used for processing transactions.
example: apple pay
methodType:
type: string
description: Payment method type, such as a credit card.
example: credit card
state:
type: string
description: Payment state indicates whether the payment has been successfully processed.
example: PENDING
enum:
- PENDING
- AUTHORIZED
- CAPTURED
- FAILED
authorization:
$ref: '#/components/schemas/PaymentAuthorization'
billToAddress:
type: string
description: The Address ID that was generated when an address was created using the [Create address](/v3/cart-and-checkout/api-reference/carts-v3/addresses/create-addresses) endpoint.
example: a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93
cardDetails:
type: object
description: Information about the card used for payment, such as gift card details.
additionalProperties:
type: object
description: Information about the card used for payment, such as gift card details.
attributes:
type: object
additionalProperties:
type: object
description: Custom attributes associated with the transaction, such as the name of the gift card used.
example:
gift-card-name: custom name
description: Custom attributes associated with the transaction, such as the name of the gift card used.
example:
gift-card-name: custom name
description: Cart Payment
PaymentAuthorization:
required:
- amount
type: object
properties:
amount:
type: number
description: The amount for which the payment has been authorized.
example: 8
exclusiveMinimum: 0
expiry:
type: string
description: The date when the payment authorization expires.
example: 2024-06-13 16:50:00.682000+00:00
verifier:
$ref: '#/components/schemas/Verifier'
description: Payment authorization
NotFound:
type: object
properties:
type:
type: string
description: Error code, meant for machine consumption
example: CART_NOT_FOUND
message:
type: string
description: Human-readable error description
example: Cart not found
description: Resource Not Found
ClientError:
type: object
properties:
type:
type: string
description: Error code, meant for machine consumption
example: BAD_REQUEST
message:
type: string
description: Human-readable error description
example: x-fabric-tenant-id is required
description: Client error details
AddAttributesRequest:
required:
- attributes
type: object
properties:
attributes:
type: object
additionalProperties:
type: object
description: An object containing custom attributes of your choice for the resource.
example:
test: test
description: An object containing custom attributes of your choice for the resource.
example:
test: test
description: Add Attributes Request
NewPayment:
type: object
properties:
id:
type: string
description: The unique identifier for the payment generated in this response, used for referencing in other endpoints.
example: 6ef2067a-5d6b-4785-a090-96ea0078220d
provider:
type: string
description: The payment provider, such as Verifone, that offers functions like transaction processing, gateway management, and other financial services.
example: verifone
processor:
type: string
description: The payment processor, such as Stripe, responsible for handling and processing payment transactions by facilitating communication between the merchant and the issuing bank.
example: stripe
method:
type: string
description: Payment method, such as Apple Pay, used for processing transactions.
example: apple pay
methodType:
type: string
description: Payment method type, such as a credit card.
example: credit card
state:
type: string
description: Payment state indicates whether the payment has been successfully processed.
example: PENDING
enum:
- PENDING
- AUTHORIZED
- CAPTURED
- FAILED
authorization:
$ref: '#/components/schemas/PaymentAuthorization'
billToAddress:
type: string
description: The Address ID that was generated when an address was created using the [Create address](/v3/cart-and-checkout/api-reference/carts-v3/addresses/create-addresses) endpoint.
example: a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93
cardDetails:
type: object
description: Information about the card used for payment, such as gift card details.
additionalProperties:
type: object
description: Information about the card used for payment, such as gift card details.
attributes:
type: object
additionalProperties:
type: object
description: Custom attributes associated with the transaction, such as the name of the gift card used.
example:
gift-card-name: custom name
description: Custom attributes associated with the transaction, such as the name of the gift card used.
example:
gift-card-name: custom name
description: Cart Payment
UpdatePaymentRequest:
type: object
properties:
provider:
type: string
description: The payment provider, such as Verifone, that offers functions like transaction processing, gateway management, and other financial services.
example: verifone
processor:
type: string
description: The payment processor, such as Stripe, responsible for handling and processing payment transactions by facilitating communication between the merchant and the issuing bank.
example: stripe
method:
type: string
description: Payment method
example: stripe
methodType:
type: string
description: Payment method type
example: cc
state:
type: string
description: Payment state
example: PENDING
enum:
- PENDING
- AUTHORIZED
- CAPTURED
- FAILED
authorization:
$ref: '#/components/schemas/PaymentAuthorization'
billToAddress:
type: string
description: Identifier of billing address
# --- truncated at 32 KB (130 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fabric-com/refs/heads/main/openapi/fabric-com-payments-api-openapi.yml