Changelog¶
All notable changes to the Payment Gateway documentation will be documented on this page.
2026-05-26¶
Fixed¶
- Corrected the Qore Payments production OIDC realm in Environments from
productiontoqore-prod.
2026-05-20¶
Added¶
- Added a Supported Transaction Types section to the Transaction Management page, listing all initial transaction types (
PURCHASE,AUTHORIZE,OCT,PAYOUT,PAYMENT) and management transaction types (CAPTURE,REFUND,VOID) with descriptions.
Changed¶
- Clarified across Payments, Payments — Direct API Integration, Payouts, Payouts — Direct API Integration, OCT, Hosted Payment Page, and Embedded Fields that the
amountfield must be an integer in minor units. Decimal or fractional values (for example100.00or the string"100.00") are rejected at request validation with a clear error.
2026-05-18¶
Changed¶
- Updated all request/response examples across API Integration, Hosted Payment Page, Embedded Fields, 3D Secure, Google Pay, and Webhooks to use
PURCHASEinstead ofAUTHORIZEas the exampletransaction_type.
2026-05-15¶
Added¶
- New Wallet Redirect (Google Pay & Apple Pay) reference page covering the
google-pay-redirectandapple-pay-redirectpayment method types: how the PSP-hosted wallet flow works, HPP / Embedded Fields / Direct API behavior, theauthorizerequest and response shape, and how it differs from the native Google Pay integration.
2026-05-12¶
Changed¶
- Updated the Direct API Integration request schema:
description,country,customer_ip,return_url,error_url, andcancel_urlare now required. Added the newerror_urlandcancel_urlfields for redirecting the customer after failed or canceled payments (previously a singlereturn_urlcovered all outcomes).
2026-04-27¶
Added¶
- New API Integration Guidelines page in Getting Started covering recommended request hygiene (mandatory
User-Agentheader, HTTPS, correctContent-Type, clean payloads) and how to troubleshoot a 403 with an empty response body.
Changed¶
- Documented the required recipient
customerfields on the OCT request:first_name,last_name,email,phone,address,city,country, andpostal_codeare all required. Added a Customer Fields table with field-level notes (E.164 phone format, ISO 3166-1 alpha-2 country code) and a JSON example, and updated the OCT OpenAPI schema to mark these fields as required.
2026-04-24¶
Added¶
- Documented the optional
customer_ipfield on the card Authorize request. Pass the end customer's IPv4/IPv6 address so fraud and 3DS risk checks see their IP rather than your backend's; if omitted, the gateway falls back to the IP of the incoming HTTP request
Changed¶
- Aligned the
customer_ipdescription on the Payments, Payouts, and OCT request schemas with the Authorize page — noting IPv4/IPv6 support, the fallback to the HTTP request IP, and when to set it explicitly
2026-04-23¶
Added¶
- Added field format requirements table to the Encryption Example page, documenting accepted plain-text formats for card number, CVV, expiration month, and expiration year before encryption.
- Added Card Payment Data Fields reference table to the API Integration page.
Changed¶
- Clarified that
encrypted_expiration_yearaccepts both 2-digit (26) and 4-digit (2026) year formats in the Encryption Example page, API Integration page, and OpenAPI spec. - Clarified
phone/customer_phone_numberfield descriptions across Embedded Fields, Hosted Payment Page, and Neogated Direct API Integration pages: phone numbers must be in E.164 format (e.g.,+12125551234) and are validated using Google libphonenumber'sisPossibleNumbercheck, which verifies the number is a plausible length for its country code.
2026-04-21¶
Changed¶
- Environments page now shows the complete OIDC token URL (e.g.
https://auth.example.com/realms/production/protocol/openid-connect/token) instead of separate OIDC URL and Realm fields, and groups UAT and Production values into distinct sections for easier reference
2026-04-20¶
Changed¶
- Moved Handling Declines into its own subsection under References (at
references/handling-declines/index.html)
Added¶
- Added Handling Declines reference page documenting the full list of
processing_codevalues returned by the gateway (families0xxx,1xxx,2xxx,3xxx,4xxx), the distinction between gateway-normalized fields (processing_code,response_message) and raw PSP fields (payment_provider_response_code,payment_provider_response_message), and recommended retry/handling behavior per code family
2026-04-17¶
Added¶
- Account Funding Transaction (AFT) documentation — how to include
options.fundingparameters for VISA and Mastercard funding transactions on PURCHASE and AUTHORIZE - Documented custom 3DS challenge notification URL (
options.three_ds.notification_url) for Direct API integrations, including validation rules, the ACS callback flow, and the requiredauthentication-completedfollow-up call
2026-04-16¶
Added¶
- Added
payment_method_expiryfield to the Transaction Processed Webhook — an ISO-8601 date representing the last day of the payment method's expiry month (e.g.,2027-12-31), nullable - Added AI-Assisted Integration page under Getting Started with brand-specific
llms.txtandllms-full.txtURLs and usage examples for Claude, Cursor, GitHub Copilot, and other AI tools - Added
<link rel="alternate">meta tags to every page's<head>for automatic discovery ofllms.txtandllms-full.txtby AI agents and crawlers - Added tip callout on the homepage pointing to the AI-Assisted Integration page
2026-04-15¶
Added¶
- New Recipes section with step-by-step 3DS card payment integration guide
- Encryption example now includes Node.js and Java examples (runnable single-file snippets)
- Access token example in recipe includes curl, Node.js, and Java tabs
- Introduced documentation changelog
Fixed¶
- Fixed redirect URLs for 3DS authentication flows
2026-04-13¶
Added¶
- Simulator documentation for card and 3DS flows
2026-04-10¶
Changed¶
- Removed
x-api-keyfrom hosted payment page docs
2026-04-08¶
Fixed¶
- Corrected maximum retry limits for 3DS authentication
Added¶
- Documentation for 3DS fallback behavior and repeated authentication
2026-04-01¶
Fixed¶
- Use exact 3DS action type values (
THREE_DS_2_FINGERPRINT,THREE_DS_2_CHALLENGE)
2026-03-31¶
Changed¶
- Replaced
/api/oauth2/login/tokenwith OIDC client credentials in HPP example
Added¶
- Payment (deposit) documentation
- 3D Secure integration documentation
2026-03-19¶
Added¶
- Payout documentation with INR bank transfer support
- Google Pay integration docs and PDF generation
Changed¶
- Added integration type limitation warning to OCT docs
- Added note that HPP and Embedded Fields are not supported for OCT transactions
- Added note that HPP and Embedded Fields are not supported for payouts
- Removed
/api/tokenendpoints from docs
Fixed¶
- Removed
{.md-button}from Google Pay PDF download link - Added
pymdownx.emojiextension for Material icon rendering
2026-03-16¶
Added¶
- Neogated (BLIK) payment method documentation
- Google Pay integration documentation
2026-03-13¶
Added¶
- OCT (Original Credit Transaction) documentation
2026-03-08¶
Fixed¶
- Updated
submitPaymentcustomer postal code field fromziptopostalCode
2026-03-04¶
Added¶
- Network Token payment method documentation
Changed¶
- Updated Network Token docs for ECI and source field changes
Fixed¶
- Removed erroneous redirect for API integration page
2026-01-29¶
Changed¶
- Updated Embedded Fields documentation with brand-specific initialization notes, component types, lifecycle management, and supported locales
2026-01-13¶
Changed¶
- Updated Embedded Fields documentation with current integration details
2026-01-12¶
Added¶
- Field Configuration documentation for Embedded Fields
2025-11-10¶
Added¶
- Support for
return_url_targetparameter in Paysafe redirect
2025-10-21¶
Added¶
- API integration documentation for card tokenization and saved cards
2025-10-20¶
Added¶
- Documentation for saving and using saved cards in HPP
Changed¶
- Updated tokenization requirements and
customer_idbehavior
2025-10-15 — Initial version¶
Added¶
- Initial documentation import