aid: apexxfintech name: Apexxfintech description: Apexxfintech provides a cloud‑native payment orchestration platform that consolidates global payment providers into a single integration point. It offers intelligent routing, cost routing, decline cascading, network tokenisation, and a suite of APIs for merchants to optimise transaction processing, reduce costs, and improve acceptance rates across multiple regions and payment methods. url: https://raw.githubusercontent.com/api-evangelist/apexxfintech/refs/heads/main/apis.yml website: https://apexx.global x-type: company x-source: harvest:secondary-market x-tier: profiled x-tier-reason: enrichment pass 2026-09-25 (modular-v1; was harvest) specificationVersion: '0.20' created: '2026-09-25' modified: '2026-09-25' tags: - Company - Payments - Fintech - Orchestration - Global tags_raw: - Company - Payments - Fintech - API - Orchestration - Global maintainers: - FN: Kin Lane email: kin@apievangelist.com - FN: APIs.json email: info@apis.io common: - type: CapabilityMap url: capabilities/apexxfintech-capability-edges.yml name: Apexxfintech Business Capability Map - type: Spectral url: rules/apexxfintech-rules.yml - type: Vocabulary url: vocabulary/apexxfintech-vocabulary.yml - type: DataModel url: data-model/apexxfintech-data-model.yml - type: Authentication url: authentication/apexxfintech-authentication.yml - type: ErrorCatalog url: errors/apexxfintech-problem-types.yml - type: Conformance url: conformance/apexxfintech-conformance.yml - type: Hosts url: hosts/apexxfintech-hosts.yml - type: Vendors url: vendors/apexxfintech-vendors.yml - type: DomainSecurity url: security/apexxfintech-domain-security.yml - type: Website url: https://equityzen.com/company/apexxfintech - type: APIReference url: https://sandbox.apexx.global/atomic/redoc/api/doc - type: Blog url: https://apexx.global/blog - type: TermsOfService url: https://apexx.global/terms-and-conditions/ - type: PrivacyPolicy url: https://apexx.global/privacy-policy/ - type: Support url: https://support.apexx.global/support/home/ apis: - name: Apexx API description: Apexx provides a payment orchestration platform with APIs for merchants. humanURL: https://apexx.global baseURL: null aid: apexxfintech:apexx-api - aid: apexxfintech:apexxfintech-alternative-payment-methods-api name: Apexxfintech Alternative Payment Methods API description: >- The Alternative Payment Methods API from Apexxfintech — 13 operation(s) for alternative payment methods. humanURL: https://apexx.global tags: - Alternative Payment Methods properties: - type: OpenAPI url: openapi/apexxfintech-alternative-payment-methods-api-openapi.yml - aid: apexxfintech:apexxfintech-buy-now-pay-later-api name: Apexxfintech Buy Now Pay Later API description: BNPL Controller humanURL: https://apexx.global tags: - Buy Now Pay Later properties: - type: OpenAPI url: openapi/apexxfintech-buy-now-pay-later-api-openapi.yml - aid: apexxfintech:apexxfintech-create-and-manage-card-token-api name: Apexxfintech Create And Manage Card Token API description: >- The Create And Manage Card Token API from Apexxfintech — 3 operation(s) for create and manage card token. humanURL: https://apexx.global tags: - Create And Manage Card Token properties: - type: OpenAPI url: openapi/apexxfintech-create-and-manage-card-token-api-openapi.yml - aid: apexxfintech:apexxfintech-credit-transaction-api name: Apexxfintech Credit Transaction API description: The Credit Transaction API from Apexxfintech — 2 operation(s) for credit transaction. humanURL: https://apexx.global tags: - Credit Transaction properties: - type: OpenAPI url: openapi/apexxfintech-credit-transaction-api-openapi.yml - aid: apexxfintech:apexxfintech-get-transactions-api name: Apexxfintech Get Transactions API description: The Get Transactions API from Apexxfintech — 2 operation(s) for get transactions. humanURL: https://apexx.global tags: - Get Transactions properties: - type: OpenAPI url: openapi/apexxfintech-get-transactions-api-openapi.yml - aid: apexxfintech:apexxfintech-hosted-token-api name: Apexxfintech Hosted Token API description: Hosted Token Controller humanURL: https://apexx.global tags: - Hosted Token properties: - type: OpenAPI url: openapi/apexxfintech-hosted-token-api-openapi.yml - aid: apexxfintech:apexxfintech-sdk-api name: Apexxfintech SDK API description: "

JavaScript SDK Integration 1.0.0

\n \n The Apexx Payment Integration SDK is a\ \ comprehensive solution designed to streamline payment processing for merchants by integrating multiple\ \ payment methods into a single, unified platform. With support for providers like PayPal, Volt, and\ \ others, the SDK enables merchants to offer their customers a diverse range of payment options while\ \ ensuring seamless management of the payment flow tailored to each method.\n\n\n \n

What is this\ \ Library for?

\n\n The Apexx-PayPal SDK is designed to simplify the integration of PayPal's Embedded\ \ Checkout into web applications. This SDK abstracts the complexities of payment logic, enabling merchants\ \ to easily handle payment approval and event-driven callbacks. The SDK allows customization of funding\ \ sources such as PayPal and Volt, providing flexibility for developers and businesses alike. This\ \ document outlines the SDK’s core design, focusing on its key methods, error-handling strategy, and\ \ security considerations. By using this SDK, developers can streamline the integration of Apexx's\ \ payment services within their applications.\n\n\n \n

What are the features?

\n\n \n\n\n \n\ \

Use Cases

\n \n \n\n\n \n

SDK Process Flow

\n\n \n Apexx Completes the Order\ \ (CompleteOrder = true)\n \n \"PayPal\n \n Merchant Completes the Order (CompleteOrder = false)\n \n \"PayPal\n \n

How\ \ to setup?

\nThe Apexx js library can be downloaded from here:\n\n \n
\n \n \ \ \n \n \n \n \n \n \n\ \ \n \n \n \n \n \n \n \n \n \n \n \n
EnvironmentEndpointDescription
Sandboxhttps://sandboxsdk.apexx.global/ApexxSDK.min.jsThis environment\ \ provides you with full access to all the features available. Transactions will have no financial\ \ impact.
Productionhttps://sdk.apexx.global/ApexxSDK.min.jsThis environment will\ \ be the Live environment with access based on your configuration. Transactions will have financial\ \ impact.
\n
\n \n

Where to get credentials

\n\ \ \n If you already have a relationship with a service provider, we will help create the neccessary\ \ IDs and share them with your payment provider of choice.\n\n If you do not yet have an account with\ \ a payment service provider, please reach out to your Apexx account manager who will be happy to\ \ help facitlate the onboarding process.\n\n To process payments via Apexx SDK you will need an organisation\ \ id and an X-APIKEY which you can get from your Apexx account manager.\n\n \n

How to consume\ \ the library?

\n\n If you are consuming the library directy from our CDN (Recommended), then\ \ add the following JS snippet to your relevant checkout page. \n\n \n 
<script src=\"https://paypalsandboxsdkdemo.apexx.global/ApexxSDK.min.js\"\
    ></script>
\n \n \n \n 
const paymentInstance = new Apexx(\"PayPal\", (error) =>\
    \ {\nconsole.error(\"Error initializing payment SDK:\", error);\n});
\n \n \n \n

How to\ \ incorporate with any existing libraries

\n\n Merchants can integrate the SDK alongside their\ \ existing payment processing systems. The SDK is compatible with JavaScript and backend payment flows.\ \ Please note that any unique IDs that are used would need to be specific to the JS library.\n\n \n\ \

How to make a call

\n \n \n

Encrypting Payment parameters

\n\n Before initializing\ \ the SDK you would need to encrypt the data required for processing the payment. To encrypt the data\ \ you can call the Apexx server encryption API which will provide you with the required details to\ \ initiate the javascript SDK. For more details on server encryption API, visit API Reference The details of the fields required to be encrypted are mentioned in the\ \ schema definitions below.\n\n \n

Initializing the embedded element

\n\n Initialize the\ \ Apexx wrapper by loading the script from Apexx, using the activation instance keyword (e.g. \"PayPal\"\ ) and an error callback function to handle wrapper error for that payment instance. \n\n \n 
Eg:\
    \ const paypalInstance = new Apexx(\"PayPal\",(error)=>{alert(console.log(\"error\"); ))});
\n\ \ \n \n The APEXX SDK is initialized using a configuration object that contains key parameters required\ \ for payment processing. The initialization process sets up the SDK environment and ensures all provided\ \ configurations are validated. Key Parameters & Data Type : These are needed to be provided as a\ \ single object. \ \ \n \n Example\n 
const apexx = new Apexx({\nencryptedkey: 'eyJraWQiOiJnM2FKMlJyUVNFYmM5WTVxUFowaDR0bVpr....',\
    \ // Required\nencryptedpayload: 'eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0....', // Required\n\
    completeOrder: 'true',\norganisation_id:'716ae509B5091A44baBaadeAc4b384e6b31d'\nsources to enable\
    \ eventHandlers: { // Optional event handlers onApprove: (data, actions) => {\nconsole.log('Payment\
    \ Approved', data); }, onError: (error) => {\nconsole.error('Payment Error:', error); }, onCancel:\
    \ (error) => {\nconsole.error('Payment Error:', error); },}\n});
\n\n \n \n \n \n \n

Completing\ \ the order

\n\n You can pass the completeOrder field as true to complete the order from the Apexx\ \ SDK after the approval is received from Paypal. If you wish to complete the order from your side\ \ via a server to server call then pass the completeOrder field as false. \n\n \n \n However if you\ \ chose to complete the order yourself then you will have to call the Apexx Complete Order API which\ \ will process the transaction and respond you back with the transaction data. \n\n \n See Complete Order API for retrieving order details\n\ \n \n \n Please Note: If you are not doing an auto-capture then capture request will be required\ \ separately which you can find at below location. See Capture API Reference \n \n \n \n \n

Error handling

\n \n \n

Error Categories

\n\ \n Use onError callback to handle errors dynamically. Log errors to capture debugging information.\ \ \n\n
Error TypeDescription
INPUT_VALIDATIONIssues\ \ with provided parameters.
SECURITYSecurity-related errors.
GENERICGeneral\ \ errors not categorized elsewhere.
SCRIPTIssues loading the SDK.
\ \ \n \n

Error Messages

\n\n
CodeDescription
MISSING_CONTAINERIContainer\ \ not created , Instantiate container first..
INVALID_FORMATInvalid {type}\ \ format.
MALICIOUS_INPUTDetected potentially malicious and sanitized.
GENERIC_ERRORError\ \ occurred during {type} operation.
SCRIPT_ERRORFailed to load {type} script\ \ instance.
\n \n

Error Statuses

\n\n
StatusDescription
INVALID_MODE400\ \ (BadRequest)
MISSING_PAYMENT_CONTAINER500 (Internal Server Error)
INVALID_FORMAT400\ \ (BadRequest)
MALICIOUS_INPUT403 (Forbidden)
GENERIC_ERROR500\ \ (Internal Server Error)
SCRIPT_ERROR500 (Internal Server Error)
\n\ \ \n 
<script src=\"https://paypalsandboxsdkdemo.apexx.global/ApexxSDK.min.js\"\nintegrity=\"\
    sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxjwG6ODnY7XJ5SPPc4v5Z4tM\"\"\n crossorigin=\"anonymous\"\
    ></script>
\n \n \n \n

Security considerations

\n\n To ensure a secure integration\ \ of the Apexx SDK, merchants should follow these security best practices:\n \n\n \n \n\n \n " humanURL: https://apexx.global tags: - SDK properties: - type: OpenAPI url: openapi/apexxfintech-sdk-api-openapi.yml - aid: apexxfintech:apexxfintech-server-side-encryption-api name: Apexxfintech SERVER-SIDE ENCRYPTION API description: Server Side Encryption Controller humanURL: https://apexx.global tags: - SERVER-SIDE ENCRYPTION properties: - type: OpenAPI url: openapi/apexxfintech-server-side-encryption-api-openapi.yml - aid: apexxfintech:apexxfintech-standalone-services-api name: Apexxfintech STANDALONE SERVICES API description: The STANDALONE SERVICES API from Apexxfintech — 1 operation(s) for standalone services. humanURL: https://apexx.global tags: - STANDALONE SERVICES properties: - type: OpenAPI url: openapi/apexxfintech-standalone-services-api-openapi.yml - aid: apexxfintech:apexxfintech-transaction-hosted-payment-api name: Apexxfintech Transaction Hosted Payment API description: >- The Transaction Hosted Payment API from Apexxfintech — 4 operation(s) for transaction hosted payment. humanURL: https://apexx.global tags: - Transaction Hosted Payment properties: - type: OpenAPI url: openapi/apexxfintech-transaction-hosted-payment-api-openapi.yml - aid: apexxfintech:apexxfintech-transaction-payment-api name: Apexxfintech Transaction Payment API description: The Transaction Payment API from Apexxfintech — 3 operation(s) for transaction payment. humanURL: https://apexx.global tags: - Transaction Payment properties: - type: OpenAPI url: openapi/apexxfintech-transaction-payment-api-openapi.yml - aid: apexxfintech:apexxfintech-transaction-update-api name: Apexxfintech Transaction Update API description: The Transaction Update API from Apexxfintech — 6 operation(s) for transaction update. humanURL: https://apexx.global tags: - Transaction Update properties: - type: OpenAPI url: openapi/apexxfintech-transaction-update-api-openapi.yml x-coverage: state: unreadable reason: no-machine-readable-spec method: derived generated: '2026-09-25' generator: derive-coverage.py (pre-flight evidence) detail: the company publishes developer documentation but serves no machine-readable contract from it evidence: apexx.global x-enrichment: date: '2026-09-25' status: enriched artifacts_added: 14 pass: modular-v1 engine: identity=local,contract=local,surfaces=local,docs=local