Confirma Payment Platform
    Confirma Payment Platform
    • Developer Guide
    • Changelog
    • Basic Flow Guide
    • Viva Developers' Guide
    • Epassi Developers' Guide
    • Retain24 Developers' Guide
    • Resurs Developers' Guide
    • SoftPay Developers' Guide
    • Nexi Developers' Guide
    • v1
      • Authentication
        • Obtain a token
      • Callback
        • Redirect transaction flow
      • Device
        • Terminal device details
        • /{tenantCode}/v1/device/configuration
      • GiftCard
        • Get the available templates
        • Get template by Id
        • Create and Issue a Card
        • Top Up a Card
        • Get a Card
        • Validate a Card
        • Cancel a card
        • Cancel the last topup of the card
      • Payment
        • Create a new payment request
        • Marks the day end
      • PaymentChannel
        • Get payment channel merchants
        • Get available payment channels
        • Get configured payment channels
        • Get payment channel configuration requirements
        • Save payment channel configuration
        • Enable payment channel
        • Disable payment channel
        • Create a new account
        • Get payment channel stores
        • Get payment method basic details
        • Get payment method content
        • Get payment channel merchants
        • /{tenantCode}/v1/payment-channel/viva
      • Report
        • Get End Of Day Reports
        • Save End Of Day Reports
      • Transaction
        • Get customer receipt for a transaction
        • Get the transaction status
        • Cancel a transaction
        • Refund a transaction
        • Generic Refund (Without existing Transaction Id)
        • Update transaction status
        • Get merchant receipt for a transaction
        • Save a receipt for a transaction
      • Storage
        • Gets a secure update url for the storage
      • TenantWebhook
        • /{tenantCode}/v1/tenant-webhook/{provider}/viva/account
        • /{tenantCode}/v1/tenant-webhook/{provider}/viva/account
        • /{tenantCode}/v1/tenant-webhook/resurs/authorisation/transactions/{transactionUUID}
        • /{tenantCode}/v1/tenant-webhook/resurs/management/transactions/{transactionUUID}
      • Webhook
        • /v1/webhook/{provider}/viva/account
        • /v1/webhook/{provider}/viva/account
        • /v1/webhook/{provider}/viva/payment-created
        • /v1/webhook/{provider}/viva/payment-created
        • /v1/webhook/{provider}/viva/payment-failed
        • /v1/webhook/{provider}/viva/payment-failed
        • /v1/webhook/{provider}/viva/reversal-created
        • /v1/webhook/{provider}/viva/reversal-created

    Basic Flow Guide

    Basic Flow Guide#

    Payment Channel Flows
    Some payment channels might require a complex flow due to their different approaches in finalising payment. Therefore please refer payment channel specific documentation for better understanding of such flows.
    Debugging & Traceability
    All responses from ConfirmaPay Payment Platform will have a header "x-request-id" which will contain a GUID to help debug and trace issues. Ensure you store it to troubleshoot any issues in production on request basis.
    Initialise Payment
    1
    Create a new payment request
    Invoke a new payment request
    2
    Get the transaction status
    Check the status using the transactionId return from the previous request
    Cancel a transaction
    INFO
    Before the payment is collected.
    1
    Cancel a transaction
    Invoke transaction cancel process
    2
    Get the transaction status
    Check the status of the cancel request
    Refund a transaction
    1
    Refund a transaction
    Invoke transaction refund process
    2
    Get the transaction status
    Check the status of the refund request
    Modified at 2025-05-05 04:01:54
    Previous
    Changelog
    Next
    Viva Developers' Guide
    Built with