PayFacto API - v2.0 - Main

PayFacto API - v2.0 - Main

PayFacto API - v2.0 - Main

Secure Payment Gateway  ·  API v2.0
 38 articles

Everything you need to integrate, configure, and operate the Secure Payment Gateway — API v2.0. Articles are grouped by topic. Each entry shows the article type so you know what to expect before you open it.

Article types:GuideReferenceHow-To
Getting Started 4 articles
 
ReferencePayFacto API v2.0 - Overview

Base URLs, authentication, request format, all endpoints, and error reference for the SPG v2.0 REST API.

View →
 
ReferenceRequest Parameters Reference

Complete reference for all request fields — types, constraints, allowed values, and required vs. optional flags.

View →
 
ReferenceResponse Parameters Reference

Complete reference for all response fields — status values, result objects, card validation, error types, and decline codes returned by the API.

View →
 
ReferenceGlossary

Definitions for 91 payment industry terms, protocol concepts, and PayFacto-specific terminology used across the v2.0 documentation.

View →
Charges 7 articles
 
ReferencePOST /charges — Create a Charge

Create a card, terminal, token, cash, or wallet payment. Supports immediate capture and pre-authorization.

View →
 
ReferenceGET /charges — List Charges

Retrieve a paginated list of charges filtered by date, status, invoice number, or card.

View →
 
ReferenceGET /charges/{chargeId} — Get a Charge

Retrieve the full details and current status of a specific charge by its UUID.

View →
 
ReferencePOST /charges/{chargeId}/captures — Capture a Charge

Complete a pre-authorization and collect the reserved funds. Captured amount may be less than authorized.

View →
 
ReferencePOST /charges/{chargeId}/increments — Increment a Charge

Increase the authorized amount on an uncaptured pre-authorization before capture.

View →
 
ReferencePOST /charges/{chargeId}/voids — Void a Charge

Cancel a captured charge before it enters end-of-day settlement.

View →
 
ReferencePOST /charges/{chargeId}/releases — Release a Charge

Release the remaining hold on an uncaptured pre-authorization without collecting funds.

View →
Refunds 4 articles
 
ReferencePOST /refunds — Create a Refund

Return funds to a cardholder for a previously captured charge. Full and partial refunds supported.

View →
 
ReferenceGET /refunds — List Refunds

Retrieve a list of refunds with optional filters by date, status, or charge ID.

View →
 
ReferenceGET /refunds/{refundId} — Get a Refund

Retrieve the full details of a specific refund by its UUID.

View →
 
ReferencePOST /refunds/{refundId}/voids — Void a Refund

Cancel a refund before it settles — for same-day error correction before batch close.

View →
Verifications 2 articles
 
ReferencePOST /verifications — Create a Verification

Validate a card with AVS and CVV checks without collecting or holding any funds.

View →
 
ReferenceGET /verifications/{verificationId} — Get a Verification

Retrieve the result of a card verification by its UUID.

View →
Hosted Solutions 3 articles
 
GuideSecure Hosted Checkout (SHC)

Embed a PayFacto-hosted card form inside an iframe on your own page. Supports 3DS, CVV, AVS, reCAPTCHA, and payment token generation.

View →
 
GuideSecure Hosted Pages (SHP)

Redirect customers to a fully PayFacto-hosted payment page. Zero payment UI to build. Supports 3DS, successUrl, declineUrl, and webhook.

View →
 
GuideSecure Pay By Link (SPL)

Create shareable payment links for email, SMS, or QR code delivery. Configurable expiry and reuse count.

View →
Digital Wallets 3 articles
 
GuideApple Pay™ - Online Checkout - InApp

Accept Apple Pay in iOS apps using Method A (partner decrypts) or Method B (PayFacto decrypts). Includes ECv1 token decryption, ECDH key derivation, and AES-256-GCM.

View →
 
GuideGoogle Pay™ - Online Checkout - InApp

Accept Google Pay in Android apps using Method A (partner decrypts) or Method B (PayFacto decrypts). Includes ECv2 token decryption and cryptogram conversion.

View →
 
GuideInterac Konek™ - Online Checkout - InBrowser

Accept Interac Konek online payments in web and mobile integrations.

View →
POS & Terminal Integration 1 article
 
GuideOracle Opera PMS Integration

Hotel POS integration via OPI XML and OHIP REST. Covers room charge posting, card tokenization, pre-authorization flows, and Titan SIP configuration.

View →
How-To Guides 11 articles
 
How-ToHow to Create a Charge

Step-by-step guide for submitting a payment charge — card, terminal, token, cash, or wallet.

View →
 
How-ToHow to Capture a Pre-Authorization

Collect funds reserved by a charge created with capture: false.

View →
 
How-ToHow to Increment a Pre-Authorization

Increase the authorized amount before capture — for tips, extended stays, or rental overages.

View →
 
How-ToHow to Void a Charge

Cancel a captured charge before end-of-day batch close.

View →
 
How-ToHow to Release a Pre-Authorization

Release a hold that will not be captured — no funds collected.

View →
 
How-ToHow to Create a Refund

Issue a full or partial refund for a captured charge.

View →
 
How-ToHow to Void a Refund

Cancel a refund issued in error before the batch closes.

View →
 
How-ToHow to Verify a Card

Run AVS and CVV checks on a card without charging or holding funds.

View →
 
How-ToHow to Charge Using an SHC Token

Submit a charge using a reusable payment token previously returned by Secure Hosted Checkout.

View →
 
How-ToHow to Set Up Secure Hosted Checkout (SHC)

Embed a PayFacto-hosted card form in your web page using the SHC JavaScript library.

View →
 
How-ToHow to Create a Payment Link (SPL)

Generate a shareable payment link for email, SMS, or QR code delivery.

View →
Error Codes & Response Reference 3 articles
 
ReferenceError Types & Error Object

All error type values returned in the API error object: CARD_ERROR, DOWNSTREAM_ERROR, IDEMPOTENCY_ERROR, INTERNAL_ERROR, INVALID_REQUEST_ERROR — with fields and recommended actions.

View →
 
ReferenceDecline Codes

Full lookup table of decline codes in result.declineCode — DO_NOT_HONOR, INSUFFICIENT_FUNDS, EXPIRED_CARD, INVALID_CVV, and more — with issuer messages and retry guidance.

View →
 
ReferenceCharge & Refund Status Values

All possible status values for charges and refunds — AUTHORIZED, CAPTURED, DECLINED, FAILED, RELEASED, SUCCEEDED, VOIDED — with state transition rules.

View →