Generated by API Evangelist
Written by API Evangelist tooling for Payrix's API. It is a proposal applied on top of the contract, not a document Payrix publishes.
overlay: 1.0.0
info:
title: "Payrix Pro Partner API \u2014 API Evangelist overlay"
version: 1.0.0
extends: ../openapi/_original/payrix-partner-openapi.yml
x-generated: '2026-09-20'
x-method: generated
x-source: Get Started with the Payrix Pro API (https://docs.worldpay.com/api-specification/payrix/partner)
actions:
- target: $.info
update:
title: Payrix Pro Partner API
x-provider: Payrix (Worldpay for Platforms)
x-api-specification-version: '1.18'
description: The provider spec is titled only "Payrix" for both audiences; disambiguate merchant vs partner.
- target: $.servers
update:
- url: https://api.payrix.com
description: Production (documented in Base URLs; the provider export lists sandbox hosts only)
- url: https://api.payrixcanada.com
description: Canada production
description: Add the documented production base URLs alongside the sandbox servers.
- target: $.paths.*[post,put,delete].responses
update:
'401':
description: "Unauthorized \u2014 an invalid authentication key was provided."
'429':
description: "Too Many Requests \u2014 rate limit exceeded (1,000 requests in 10 seconds; error code 64, C_RATE_LIMIT_EXCEEDED_TEMP_BLOCK; 10 second block)."
description: The spec declares only 200 and 400; the guide documents 401 and 429.
- target: $.paths.*.get.responses
update:
'401':
description: "Unauthorized \u2014 an invalid authentication key was provided."
'429':
description: "Too Many Requests \u2014 rate limit exceeded."
- target: $.paths['/txns'].post
update:
x-idempotency:
header: REQUEST-TOKEN
docs: https://docs.worldpay.com/api-specification/payrix/partner
x-reversal:
void: type 4 with fortxn while Approved
refund: type 5 (card) / type 8 (eCheck) with fortxn once Captured or Settled
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.