How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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 Value Added Services API is one of 133 APIs that Payrix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Value Added Services. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 1.7.0.

Requests are made against 3 base URLs: https://test-api.payrix.com, https://test-api.payrixcanada.com, {serverUrl}.

1 operations 1 paths 9 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.7.0
Base URL
https://api.payrix.com
Authentication
API Key, API Key, API Key, API Key, API Key
Contact
Resource Areas
1

Authentication & Security 5

Payrix Value Added Services API declares 5 security schemes for authenticating requests. An API key is passed in the header as APIKEY (apiKey). An API key is passed in the header as SESSIONKEY (sessionKey). An API key is passed in the header as TXNSESSIONKEY (txnSessionKey). An API key is passed in the header as USERNAME (username). An API key is passed in the header as PASSWORD (password). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Value Added Services 1

Value Added Services is a collection of additional services and features beyond the core payment processing functionality that provide additional value to the user.

GET
/valueAddedServices/{service}/{target}/{targetId}
getValueAddedServicesEnablementStatusTargetId
getValueAddedServicesEnablementStatusTargetId 5 params → 200400

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are error-four-hundred-Properties (5 properties), errorItem (5 properties), vasEnablementStatusResponseItem (2 properties), vasEnablementStatusResponse (1 property). Each schema is shown below with its type and property counts.

Status1
string
error-four-hundred-Properties
object
5 properties
vasEnablementStatusResponseItem
object
2 properties
errorItem
object
5 properties
vasEnablementStatusTargetType
string
vasEnablementStatusService
string
vasEnablementStatusResponse
object
1 property
vasEnablementStatusResponseResult
object
1 property
error-four-hundred1
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

payrix-value-added-services-api-openapi.yml Raw ↑

Other APIs Payrix publishes across the network.

Payrix Accounts API
Payrix Accounts Verifications API
Payrix Adjustments API
Payrix Aggregation Result Groups API
Payrix Aggregation Results API
Payrix Aggregations API
Payrix Alert Actions API
Payrix Alert Triggers API
Payrix Alerts API
Payrix API Keys API
Payrix Apple Domains API
Payrix Apple Domains Mass Enablement API
Where this information came from

This is an independent, third-party profile of Payrix Value Added Services API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.