Skip to main content

Partner onboarding and management APIs

If you want to automate onboarding and operations for your merchants and payment gateways, you can manage them via API instead of using the Open Fabric portal.

In this page, we use partner to mean “a merchant or payment gateway that integrates with Open Fabric to offer your payment method at checkout”.

Partner lifecycle

Use these APIs to create, list, update, and deactivate partners.

ActionAPI
Create a partnerCreate partner
List partnersList partners
Get partner detailsGet partner
Update a partnerUpdate partner
Deactivate a partnerDeactivate partner

Credentials

Once a partner is onboarded, Open Fabric generates integration credentials for them. Use these APIs to retrieve or rotate credentials.

ActionAPI
Retrieve credentialsGet partner credentials
Rotate credentialsRotate partner credentials

Callback (webhook) subscriptions

Partners can optionally receive callbacks directly from Open Fabric (for example, for flows that require asynchronous handling). Use these APIs to manage callback subscriptions on a partner’s behalf.

ActionAPI
Create a subscriptionCreate subscription
List subscriptionsList subscriptions
Get a subscriptionGet subscription
Update a subscriptionUpdate subscription
Delete a subscriptionDelete subscription

Payment gateway settings (PG token handover)

For partners that are not PCI compliant, Open Fabric can work with the partner’s payment gateway to generate a PCI-compliant PG token for the one-time virtual card. You can store and manage a partner’s payment-gateway credentials using these APIs.

ActionAPI
Create/update payment gateway credentialsUpsert PG credentials
List payment gateway credentialsList PG credentials
Get payment gateway credential detailsGet PG credential
Delete payment gateway credentialsDelete PG credentials