Payrix
Payrix, now operating as Worldpay for Platforms, is an embedded payments provider for vertical SaaS platforms. Its Payrix Pro product is a white-label payment facilitation platform: a REST API and portal for merchant boarding and underwriting, card and eCheck transaction processing, tokenization, recurring billing, fees, disbursements and payouts, chargebacks, risk decisions, embedded finance and reporting, plus hosted PayFields and PayFrame checkout components and mobile/terminal SDKs. Payrix was acquired by FIS/Worldpay, and its API reference and OpenAPI specifications are now published on the Worldpay Developer Hub while api.payrix.com remains the production API host.
Payrix publishes 133 API contracts indexed on the APIs.io network, including Accounts API, Accounts Verifications API, Adjustments API, and 130 more. Tagged areas include Company, Payments, Embedded Payments, Payment Facilitation, and Merchant Onboarding.
The Payrix catalog on APIs.io includes 1 event-driven AsyncAPI specification, 1 JSON-LD context, and 1 Spectral governance ruleset.
Payrix’s developer surface includes changelog, sandbox, authentication, documentation, API reference, getting-started guide, support, and 35 more developer resources.
What this lets a business do 1
Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →
Kin Score
APIs 133
Individual APIs this provider publishes, each with its own machine-readable definition.
Payrix Accounts API
Accounts deals with payment account details for merchant boarding and entity funding. Ultimately, all the business performed within Payrix Pro (be it merchant transactions, vend...
Payrix Accounts Verifications API
Accounts Verification represents an attempt to verify the ownership of a particular bank account by verifying a known deposit amount or credential.
Payrix Adjustments API
A way to make monetary adjustments to an entity's funds.
Payrix Aggregation Result Groups API
Aggregation Result Groups Holds data regarding a processed aggregation.
Payrix Aggregation Results API
Aggregation Results Holds a field totals calculated when processing an aggregation.
Payrix Aggregations API
Aggregations acts as a scheduler that contains the needed parameters to properly generate results containing the calculated totals and keep such records in the aggregation resul...
Payrix Alert Actions API
Alert Actions deals with specific action that occurs following a triggered web alert.
Payrix Alert Triggers API
Alert Trigger deals with triggers associated with web alerts
Payrix Alerts API
Web alerts, also known as webhooks, are automated notifications sent from the API server when triggered by a specific action that occurs in your portfolio. You can configure the...
Payrix API Keys API
Interaction with the API requires authentication. For application integration and persistent authentication, an API key is required.
Payrix Apple Domains API
An Apple Domains resource represents the status of Apple Pay registration for a specific merchant and domain.
Payrix Apple Domains Mass Enablement API
An Apple Domains Mass Enablement resource represents the bulk registration of multiple merchants, each associated with a respective domain, to enable the Apple Pay service.
Payrix Assessments API
Assessments represents a record of fees charged by processors or other third-parties to Entities or Orgs. These can represent either charges that are levied on a one-off, regula...
Payrix Authentication Tokens API
Tokens provide the means through which to safely and securely store payment methods (e.g. credit cards or bank accounts) for later use. A transaction may be initiated for a cust...
Payrix Batches (Settlements) API
Batches are a container for transactions that enables batch processing to the processor for a merchant (to settle customer sales). Processing transactions for settlement to the ...
Payrix Billing API
The billing deals with billing configuration for an entity, org, division or partition. A billing configuration determines how an entity is billed for their payables within Payr...
Payrix Billing Events API
A conditional logic that determines the events that will be billed and the configuration for each event.
Payrix Billing Modifiers API
Billing Modifiers means to change the total amount of the billing or whoever will pay it.
Payrix Bins API
Bins Holds information about the issuer of a card. (Bank Issuer Number).
Payrix Change Requests API
Change Requests Accounts Verification deals with payment account details for merchant boarding and entity funding. Ultimately, all the business performed within Payrix Pro (be i...
Payrix Chargeback Documents API
Represents a file related to the Chargeback.
Payrix Chargeback Message Results API
Chargeback Message Results represents a message that is received from the processor in relation to a Chargeback message.
Payrix Chargeback Messages API
Resources that deal with chargebacks. A chargeback is a dispute of a purchase that has already been charged to an account that can result in a return of funds.
Payrix Chargeback Statuses API
The logged status changes of a Chargeback.
Payrix Chargebacks API
Resources that deal with chargebacks. A chargeback is a dispute of a purchase that has already been charged to an account that can result in a return of funds.
Payrix Confirmation Codes API
Represents a unique confirmation code issued to an email address, either when a user indicates that they have forgotten their password, or when the system needs to verify the em...
Payrix Contacts API
A contact reflects a known, valid individual registered as a contact for the entity. It is purely informational and not a required record.
Payrix Credentials API
Represents an authorization that a given Entity has to connect to an integration to perform a particular action, such as send Transactions to the processor, or board a Merchant ...
Payrix Customers API
Customers deals with merchant customer information. Customers may be associated with tokens to create a stored method of payment or with invoices for billing.
Payrix Decision Actions API
A piece of conditional logic that makes a Verification Result change the application and the decision action in certain circumstance.
Payrix Decision Rules API
A piece of conditional logic that makes a Decision apply only in certain circumstances.
Payrix Decisions API
Decisions deal with the schedule and rules for a check done on Transactions.
Payrix Disbursement Entries API
A record of disbursement amount come from.
Payrix Disbursement Reference API
Disbursement Reference Represents a reference code issued by the Payout facilitator when a Disbursement is paid.
Payrix Disbursement Results API
Disbursement Results Represents the results of a Disbursement and and any follow-ups actions (confirmations, returns, etc.).
Payrix Disbursements API
A disbursement represents a movement of funds in an entity's payment account. Records of an occasion where money is either paid to a bank account or received from a bank account.
Payrix Divisions API
Divisions contains a list of user divisions associated with an account. It allows for an additional and optional layer of separation within a partition.
Payrix Embedded Finance API
Embedded Finance stores information related to the activation of the resource for an entity. EmbeddedFinance's Valued Added Service provides access to new products and services ...
Payrix Entities API
Entities are portion of a single facilitator, vendor or merchant. Common business-related details for each type of entity are stored here (like name and address) as well as mana...
Payrix Entities Custom Fields API
the Entity Custom Fields feature, designed to empower partners to send identifiers and Risk-requested items using unlimited custom fields. By leveraging this feature, partners c...
Payrix Entity Debts API
Entity Debts represents a record of a debt between entities or an entity and the System.
Payrix Entity Reserves API
Entity Reserves Represents funds held by an Entity in reserve. The funds are held separately from amounts in any entity Funds.
Payrix Entity Returns API
Represents an ACH transaction or disbursement that has been rejected. The Entity Return will block ACH creations or send out related to its entity and payment.
Payrix Entity Terms API
EntityTerms resource represent the different agreed terms and condition agreed to by merchants during the signup.
Payrix Entity Data API
An entityData record is used to store a signature image for an entity's acceptance of terms and conditions. This is stored in a separate table so as not to bloat the entities ta...
Payrix Entity Refs API
An entityRef may be used to store referential IDs for merchants, facilitators and even vendors. For a merchant, at least a mid and funding entityRef is required for proper trans...
Payrix Entries API
An entry record represents a credit or debit of funds for an entity, possibly part of a transfer of funds between two entities. Any monetary change for an entity in Payrix Pro i...
Payrix Entry Origin API
Entry Origin represents a record of sources for funded activity.
Payrix Fee Modifiers API
Fee Modifiers means to change the total amount of the fee or whoever will pay it.
Payrix Fee Refunds API
Fee Refund is a way to reverse a fee that has been charged to another entity incorrectly.
Payrix Fee Rules API
A piece of conditional logic that makes a Fee apply only in certain circumstances.
Payrix Fees API
Fees are costs for specific timeframes elapsing, such as weekly, or monthly; or as actions taking place, such as a transaction authorization, Merchant onboarding, or chargeback ...
Payrix FraudSight Enablements API
Monitor and control entity-level access to the FraudSight service, a comprehensive fraud prevention solution for card-present and card-not-present transactions. Track when entit...
Payrix FraudSight Results API
Query fraudSightResults to retrieve information about fraud detection results from the FraudSight service.
Payrix Fund Origins API
Each fundOrigin represents the sourced amounts of available funds, which are always traceable to a processor and merchant. This ensures accurate recording and compliance with fu...
Payrix Funds API
Funds deal with aggregate funding amount records. A funds record is a snapshot for funding activity, per entity and currency, and is used to determine available funds for an ent...
Payrix Host Themes API
A host themes retrieves the active theme color associated with a specific host.
Payrix Interchange Histories API
Provides visibility into how a transaction's interchange classification changes after settlement. Use this endpoint to track **post-settlement reclassifications**, including upd...
Payrix Invoice Items API
A resource that stores line item details for an invoice.
Payrix Invoice Line Items API
A resource that relates an invoice item with an invoice. It holds information such as quantity, and price each item.
Payrix Invoice Parameters API
Invoice Parameters holds a certain configuration used for creating an invoice such as dba, address, API Key.
Payrix Invoice Results API
Invoice Results represents the result of an invoice processing. In other words, when the customer pays for an invoice it will then generate an invoice result.
Payrix Invoices API
Invoices deals with customer invoice details allowing for presenting charges to a customer and for payments to be made related to certain products or services.
Payrix IP Address Lists API
An iplist represents a whitelisted or blacklisted IP address or range. As an additional security measure, it may be useful for users to set specific, known IP addresses to be th...
Payrix Logins API
Logins resources deal with individual user details like name and email as well as management details like which partition and division the user belongs to.
Payrix Logins Helpers API
To view and manage utilities that assist with login-related actions such as password resets.
Payrix Mappings API
Mappings enable the re-mapping of fields in the API for either in or out, using a set of JSON field mappings. For example, if your system uses a different format for out data th...
Payrix Members API
A member represents a control or beneficiary member of the entity. At least one primary member record is required for merchant boarding.
Payrix Merchant Platform Statuses API
Merchant Platform Statuses provides access to view the status of a merchant's onboarding process to Payrix Pro, including the activation of individual value-added services.
Payrix Merchant Results API
Result created after an oboarding attempt, it will contain important information related to the boarding and attempt.
Payrix Merchants API
Merchant details for transaction processing entities. Together with the entities table, this table defines a merchant. A merchant is primarily an entity that accepts payments an...
Payrix Message Threads API
Represents the sender, receiver, and subject of the Messages resources.
Payrix Messages API
Represents a message within a Message Thread.
Payrix Note Documents API
Note Documents represents a file that is related to a specific note record.
Payrix Notes API
Notes handles risk management notes, reviews and releases for a Hold, Transaction and Entity specific data.
Payrix Omni Tokens API
OmniTokens stores information related to the activation of the resource for an entity. OmniToken's Valued Added Service helps protect transactions and reduce transaction risk.
Payrix Opt Outs API
Opt Outs provides the ability to disable merchants or entities from participating in specific Value Added Services, such as FraudSight.
Payrix Org Entities API
A record of an association between a particular Org and a particular Entity. You can associate Entities with an Org by creating Org Entity resources. One Org can contain and be ...
Payrix Org Flow Actions API
Org Flow Actions means to add an Entity defined in the associated Org Flow to an Org, or remove an Entity identified in the same way from an Org.
Payrix Org Flow Rules API
Org Flow Rules Provides access to manage workflows that add or remove merchants from a group based on specific criteria.
Payrix Org Flows API
Org Flows represents a way to trigger the addition or removal of the Merchants associated with a Login to a particular Org.
Payrix Orgs API
Resource that deals with records of all orgs. An org is an arbitrary grouping of entity records that can be attached to other resources as a unit for shared functionality.
Payrix Orgs VAS EfeProducts API
OrgsVASEfeProducts is a way to automatically enable an entity with the default parameters to embeddedFinance.
Payrix Orgs VAS fraudSightEnablements API
Orgs VAS fraudSightEnablements provides access to manage automatic enrollments for merchants within the specified group for the FraudSight fraud prevention Value Added Service.
Payrix Orgs VAS OmniTokens API
Orgs VAS OmniTokens provides access to manage automatic enrollments for merchants within the specified group for the Omnitoken Value Added Service.
Payrix Orgs VAS PinlessDebitConversions API
Orgs VAS Pinless Debit Conversion is a new Value-Added Service (VAS) in the Payrix system. This feature is designed to generate additional revenue and will follow the same merch...
Payrix Orgs VAS RevenueBoosts API
OrgsVasNetworkPaymentManager is a way to automatically enroll an entity associated with a specific org in the networkPaymentManager service.
Payrix Orgs VAS SaferPayments API
Orgs VAS SaferPayments provides access to manage automatic enrollments for merchants within the specified group for the Safer Payments Value Added Service.
Payrix Orgs VAS SaferPayments Non-compliance API
Orgs VAS SaferPayments Non-compliance provides access to manage automatic enrollments for fees billing on non-compliant merchants within the specified group for the Safer Paymen...
Payrix Payment Update Groups API
A collection of Payment Updates owned by the merchant's entity.
Payrix Payment Updates API
Payment Updates Holds information about the payment update - updating a payment method or account. The Payment Update will be related to a Payment, Subscription Token or Account...
Payrix Payout Flows API
Payout Flows means to set up a Payouts resource automatically for an Entity or Org when it is boarded, or when a bank account is associated.
Payrix Payouts API
Resource that tracks details that allow a Disbursement to be paid or debited.
Payrix Pending Entry API
Pending Entry represents a record of amounts moving in or out of the funds held by an Entity.
Payrix Pinless Debit Conversions API
Pinless Debit Conversion is a new Value-Added Service (VAS) in the Payrix system. This feature is designed to generate additional revenue and will follow the same merchant enabl...
Payrix Plans API
Resource that represents a recurring type of payment that charges a certain amount on a weekly, monthly, quarterly, or annual basis.
Payrix Profit Share Results API
Profit Share Results Holds a message regarding a failed Profit Share process.
Payrix Profit Share Rules API
A piece of conditional logic that makes a Profit Share apply only in certain circumstances.
Payrix Profit Shares API
Profit Shares means for an entity to have its earnings expenses shared with another entity.
Payrix Reserve Entry API
Reserve Entry represents a record of funds moving in or out of reserve. It can be associated with either a Transaction, a Reserve, an Entity Reserve, or another Reserve Entry re...
Payrix Reserves API
Resources that deals with reserve activity. Reserving means to withhold funds from an entity by removing the ability to extract the funds from the control of the financial insti...
Payrix Rev Share Schedules API
Rev Share Schedules table records the rules for income sharing, detailing who receives and who pays, along with the start and end dates of these rules. It also identifies the pa...
Payrix Rev Share Statements API
Rev Share Statements table stores the final calculated revenue share entries that are billed to partners. It applies the revenue sharing schedule to a month's worth of transacti...
Payrix Revenue Boosts API
It captures the entities when they are enabled/disabled/re-enabled with networkPaymentManager
Payrix Safer Payments API
Safer Payments provides access to create, view, and update SaferPayments Value Added Service records.
Payrix Secrets API
Keys used to decrypt data or an indicator of which key to be used to decrypt data
Payrix Sessions API
Resources that deals with secret (private) and public (publishable) user session keys for authentication in API interactions.
Payrix Statement Entry API
Statement Entry represents a record of funds owed for a billing schedule.
Payrix Statements API
Resources for dealing with billing statements for entities. Statements are generated from billing configurations and represent the amount billed for a given period of time.
Payrix Subscription Tokens API
Represents an association between a Subscription and a means of payment (Token) for that Subscription.
Payrix Subscriptions API
Resources that deal with customer subscriptions to a plan. Customers are subscribed to plans to allow for recurring payments to be made from that customer.
Payrix Tax Form Requests API
Tax Form Requests provides access to create and view requests for tax documents, returning the PDF of the requested tax document.
Payrix Team Logins API
Represents the link between a Login and a Team as well as the Login's rights on the Team. The Login resource identified in its login field is considered part of the Team.
Payrix Teams API
A team is an arbitrary grouping of user records that may have access provisioned on each other and can be attached to other resources as a unit for shared functionality.
Payrix Terminal Transaction Reference API
Terminal Transaction Reference represents a reference code issued by the Processor in relation to a particular Transaction.
Payrix Terminal Transaction Results API
Represents the result of a Transaction from a processor, which can be approved, declined, or raise an error.
Payrix Terminal Transactions API
Holds all of the information to a related final transaction and is used to reconcile with the actual, final transaction.
Payrix Terminal Transactions Datas API
The terminal_txn_datas database table stores signature data for a terminal activation request. A terminalTxnData represents a signature image for a customer’s acceptance of term...
Payrix Terminal Transactions Metadatas API
Terminal Transactions Metadatas Represents data from an EMV Transaction and/or returned by the credit card network associated with a Transaction.
Payrix Terminals API
Resources for dealing with transaction that occur on physical terminals, such as a table or register.
Payrix Token Results API
Token Results represent events that occur during the transaction process, specifically related to the usage or creation of tokens. These events are derived from the processor's ...
Payrix Tokens API
Tokens provide the means through which to safely and securely store payment methods (e.g. credit cards or bank accounts) for later use.
Payrix Transaction Datas API
Transactions Datas represents data associated with a Transaction - in particular, a Base64 encoded image of a signature captured at the time of entering the Transaction.
Payrix Transaction Holds API
A holds resource represents a reviewable action taken on a Transaction.
Payrix Transaction Items API
An Item is a line item that is associated with a particular Transaction. It allows you to describe the cost, quantity and other details of each line in the Transaction.
Payrix Transaction Metadatas API
Transaction Metadatas represents data from an EMV Transaction and/or returned by the credit card network associated with a Transaction.
Payrix Transactions Results API
Transactions Results represents the result of a Transaction from a processor. For example, the Transaction may be approved, declined, or raise an error.
Payrix Transactions (Txns) API
Resources for dealing with information relating to a particular credit card transaction, including the merchant, token, subscription, customer and card information.
Payrix Txn Sessions API
The txnSessionKey is designed to securely handle transactions within Payrix Pro PayFields/PayFrame integrations. This key aims to prevent misuse by third parties, as it is hoste...
Payrix Value Added Services API
Value Added Services is a collection of additional services and features beyond the core payment processing functionality that provide additional value to the user.
Payrix VAS EfeOffer Updates API
VAS EfeOffer Updates provides Access to view Embedded Finance offer updates for Referrers. It holds historic data on an offer through the offer life cycle.
Payrix VAS EfeOffers API
VAS EfeOffers provides Access to view Embedded Finance offers for Referrers and Merchants, including terms, eligibility and application details.
Payrix Vendors API
Resources that deal with third-party entities (non-facilitators and non-merchants) that are involved with the merchant processing and provide a service (or set of services) to t...
Scroll for all 133
Pricing Plans 1
Published pricing tiers and plan structures.
Payrix Plans Pricing
PLANSRate Limits 1
Documented rate limits and quota policies.
Payrix Rate Limits
RATE LIMITSEvent Specifications 1
AsyncAPI definitions for this provider's event-driven and streaming APIs.
Payrix Webhooks
ASYNCAPISemantic Vocabularies 1
JSON-LD contexts and semantic vocabularies used across these APIs.
Payrix Context
JSON-LDSpectral Rules 1
Spectral governance rulesets for linting and validating these APIs.
Payrix API Rules
SPECTRALOpenAPI Overlays 2
Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.
Payrix Merchant Overlay
GENERATEDPayrix Partner Overlay
GENERATEDJSON Schema 60
Standalone JSON Schema definitions for this provider's data models.
accountVerificationsResponseResult
JSON SCHEMAaccountsPostRequest
JSON SCHEMAaccountsPutRequest
JSON SCHEMAaccountsResponseResult
JSON SCHEMAadjustmentsResponseResult
JSON SCHEMAaggregationResultsGroupsResponseResult
JSON SCHEMAaggregationResultsResponseResult
JSON SCHEMAaggregationsPostRequest
JSON SCHEMAaggregationsPutRequest
JSON SCHEMAaggregationsResponseResult
JSON SCHEMAalertActionsPostRequest
JSON SCHEMAalertActionsPutRequest
JSON SCHEMAalertActionsResponseResult
JSON SCHEMAalertTriggersPostRequest
JSON SCHEMAalertTriggersPutRequest
JSON SCHEMAalertTriggersResponseResult
JSON SCHEMAalertsPostRequest
JSON SCHEMAalertsPutRequest
JSON SCHEMAalertsResponseResult
JSON SCHEMAapiKeysPostRequest
JSON SCHEMAapiKeysPutRequest
JSON SCHEMAapikeysResponseResult
JSON SCHEMAappleDomainsMassEnablementCsvResponseResult
JSON SCHEMAappleDomainsMassEnablementForMerchantList
JSON SCHEMAappleDomainsResponseResult
JSON SCHEMAapplePayForMerchantListPostRequest
JSON SCHEMAassessmentsResponseResult
JSON SCHEMAauthTokensPostRequest
JSON SCHEMAauthTokensPutRequest
JSON SCHEMAauthTokensResponseResult
JSON SCHEMAbatchesPostRequest
JSON SCHEMAbatchesPutRequest
JSON SCHEMAbatchesResponseResult
JSON SCHEMAbillingEventsPostRequest
JSON SCHEMAbillingEventsPutRequest
JSON SCHEMAbillingEventsResponseResult
JSON SCHEMAbillingModifiersPostRequest
JSON SCHEMAbillingModifiersPutRequest
JSON SCHEMAbillingModifiersResponseResult
JSON SCHEMAbillingsPostRequest
JSON SCHEMAbillingsPutRequest
JSON SCHEMAbillingsResponseResult
JSON SCHEMAbinsResponseResult
JSON SCHEMAchangeRequestsResponseResult
JSON SCHEMAchargebackDocumentsPostRequest
JSON SCHEMAchargebackDocumentsResponseResult
JSON SCHEMAchargebackMessagePostRequest
JSON SCHEMAchargebackMessageResultsResponseResult
JSON SCHEMAchargebackMessagesResponseResult
JSON SCHEMAchargebackStatusesResponseResult
JSON SCHEMAchargebacksDocumentsPutRequest
JSON SCHEMAchargebacksResponseResult
JSON SCHEMAconfirmCodesPostRequest
JSON SCHEMAconfirmCodesResponseResult
JSON SCHEMAcontactsPostRequest
JSON SCHEMAcontactsPutRequest
JSON SCHEMAcontactsResponseResult
JSON SCHEMAcredentialsPostRequest
JSON SCHEMAupdateApplePayDomainPostRequest
JSON SCHEMAupdateApplePayDomainResponseResult
JSON SCHEMAScroll for all 60
Security Posture 2
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Agentic Access 1
Recommended x-agentic-access execution contracts for AI agents.
Resources
Get Started 5
Portal, sign-up, and the first successful call
Documentation 2
Reference material describing how the API behaves
Agent Surfaces 4
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 11
Pagination, idempotency, versioning, errors, and events
Scroll for all 11
Build 4
SDKs, sample code, and the tooling you integrate with
Access & Security 3
Authentication, authorization, and security posture
Operate 5
Status, limits, changes, and where to get help
Commercial 3
Pricing, plans, and the legal terms of use
Company 3
The organization behind the API
Other 2
Properties that don't map to a standard resource type
Source (apis.yml)
Work with this as data
Every provider here is available over the APIs.io API and to AI agents over MCP.