1. API Reference
VLTZ PAY
  • API Reference
    • Getting Started
      • Create a hosted checkout session
      • Get payment status
    • Core Resources
      • Create a direct payment
      • List application transactions
      • Get transaction dashboard summary
      • Get an application transaction
      • List application payment activity
    • Schemas
      • CheckoutRequest
      • CreatePaymentRequest
      • PaymentRequestBase
      • CardDetails
      • PaymentMethodCode
      • BillingDetails
      • CheckoutBilling
      • LineItem
      • PaymentMetadata
      • CheckoutResponse
      • CreatePaymentResponseEnvelope
      • CreatePaymentResponse
      • ProviderCheckout
      • ProviderResult
      • PaymentRecord
      • PaymentStatus
      • ResolvedPaymentMethod
      • PaymentStatusResponseEnvelope
      • Transaction
      • TransactionResponseEnvelope
      • TransactionListResponseEnvelope
      • TransactionSummaryResponseEnvelope
      • CurrencySummary
      • DailySummary
      • ActivityLogListResponseEnvelope
      • ActivityLog
      • PaymentStatusCallback
      • ErrorEnvelope
  1. API Reference

Getting Started

Introduction#

Integrate VLTZ Pay from your application backend. Import this file into Apidog, set the baseUrl environment variable to the VLTZ Pay URL supplied for your environment, and replace the example appKey with the application key provisioned for your application.

Integration Flow#

1.
Create a unique order reference in your backend. Do not reuse a reference for a new payment.
2.
Create a hosted checkout with POST /checkout, then redirect the customer to checkoutUrl; or create a direct payment with POST / when your provider and PCI obligations allow it.
3.
Handle the customer return URLs configured for your application. Return URLs contain reference and result query parameters and must not be treated as proof of payment.
4.
Confirm the final state with GET /status/{reference}. If the provider supports it, this endpoint refreshes an in-progress payment before returning it.
5.
Optionally configure a server-to-server callbackUri and verify the payment status using the status endpoint before fulfilling an order.

Important Integration Rules#

Call this API from your application server, not browser code. The appKey identifies your application and must not be exposed to end users.
All money values are decimal major currency units, such as 1499.50 PHP. The default currency is PHP.
reference is globally unique. Generate an unguessable reference for every payment attempt.
A callbackUri receives an unsigned status notification only after a configured provider webhook updates the payment. Always verify the payment through GET /status/{reference} before delivering goods or services.
Hosted checkout requires all fields in billing because the checkout flow enforces the billing requirements.
Modified at 2026-07-30 05:51:41
Next
Create a hosted checkout session
Built with