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: | Guide | Reference | How-To |
| Getting Started | | 4 articles |
| | Base URLs, authentication, request format, all endpoints, and error reference for the SPG v2.0 REST API. | View → |
|
|
| | Complete reference for all request fields — types, constraints, allowed values, and required vs. optional flags. | View → |
|
|
| | Complete reference for all response fields — status values, result objects, card validation, error types, and decline codes returned by the API. | View → |
|
|
| | Definitions for 91 payment industry terms, protocol concepts, and PayFacto-specific terminology used across the v2.0 documentation. | View → |
|
|
| | Create a card, terminal, token, cash, or wallet payment. Supports immediate capture and pre-authorization. | View → |
|
|
| | Retrieve a paginated list of charges filtered by date, status, invoice number, or card. | View → |
|
|
| | Retrieve the full details and current status of a specific charge by its UUID. | View → |
|
|
| | Complete a pre-authorization and collect the reserved funds. Captured amount may be less than authorized. | View → |
|
|
| | Increase the authorized amount on an uncaptured pre-authorization before capture. | View → |
|
|
| | Cancel a captured charge before it enters end-of-day settlement. | View → |
|
|
| | Release the remaining hold on an uncaptured pre-authorization without collecting funds. | View → |
|
|
| | Return funds to a cardholder for a previously captured charge. Full and partial refunds supported. | View → |
|
|
| | Retrieve a list of refunds with optional filters by date, status, or charge ID. | View → |
|
|
| | Retrieve the full details of a specific refund by its UUID. | View → |
|
|
| | Cancel a refund before it settles — for same-day error correction before batch close. | View → |
|
|
| | Validate a card with AVS and CVV checks without collecting or holding any funds. | View → |
|
|
| | Retrieve the result of a card verification by its UUID. | View → |
|
|
| Hosted Solutions | | 3 articles |
| | Embed a PayFacto-hosted card form inside an iframe on your own page. Supports 3DS, CVV, AVS, reCAPTCHA, and payment token generation. | View → |
|
|
| | Redirect customers to a fully PayFacto-hosted payment page. Zero payment UI to build. Supports 3DS, successUrl, declineUrl, and webhook. | View → |
|
|
| | Create shareable payment links for email, SMS, or QR code delivery. Configurable expiry and reuse count. | View → |
|
|
| Digital Wallets | | 3 articles |
| | 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 → |
|
|
| | Accept Google Pay in Android apps using Method A (partner decrypts) or Method B (PayFacto decrypts). Includes ECv2 token decryption and cryptogram conversion. | View → |
|
|
| | Accept Interac Konek online payments in web and mobile integrations. | View → |
|
|
| POS & Terminal Integration | | 1 article |
| | 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 |
| | Step-by-step guide for submitting a payment charge — card, terminal, token, cash, or wallet. | View → |
|
|
| | Collect funds reserved by a charge created with capture: false. | View → |
|
|
| | Increase the authorized amount before capture — for tips, extended stays, or rental overages. | View → |
|
|
| | Cancel a captured charge before end-of-day batch close. | View → |
|
|
| | Release a hold that will not be captured — no funds collected. | View → |
|
|
| | Issue a full or partial refund for a captured charge. | View → |
|
|
| | Cancel a refund issued in error before the batch closes. | View → |
|
|
| | Run AVS and CVV checks on a card without charging or holding funds. | View → |
|
|
| | Submit a charge using a reusable payment token previously returned by Secure Hosted Checkout. | View → |
|
|
| | Embed a PayFacto-hosted card form in your web page using the SHC JavaScript library. | View → |
|
|
| | Generate a shareable payment link for email, SMS, or QR code delivery. | View → |
|
|
| Error Codes & Response Reference | | 3 articles |
| | 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 → |
|
|
| | 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 → |
|
|
| | All possible status values for charges and refunds — AUTHORIZED, CAPTURED, DECLINED, FAILED, RELEASED, SUCCEEDED, VOIDED — with state transition rules. | View → |
|
|