1. Transaction
Confirma Payment Platform
  • Developer Guide
  • Confirma Optio Setup Guide (Onsite-Terminal)
  • Basic Flow Guide
  • Changelog
  • Payment Providers
    • Viva Developers' Guide
    • Epassi Developers' Guide
    • Retain24 Developers' Guide
    • Resurs Developers' Guide
    • SoftPay Developers' Guide
    • Nets Baxi Developers' Guide
    • Worldline Developers' Guide
    • Nexi Developers' Guide
    • Verifone Vim Developers' Guide
    • Nets Baxi Cloud Developers' Guide
  • v1
    • Authentication
      • Obtain a token
    • Callback
      • Redirect transaction flow
    • Device
      • /{tenantCode}/v1/device/configuration
      • Terminal device details
      • Print receipt on Terminal
      • Print receipt on Terminal
    • 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
      • /{tenantCode}/v1/payment-channel/viva
      • Get payment channel stores
      • Get payment method basic details
      • Get payment method content
      • Get payment channel merchants
    • Report
      • Get End Of Day Reports
      • Save End Of Day Reports
      • Get End Of Day Reports by reference
      • Get Last End Of Day Report
    • Transaction
      • Get customer receipt for a transaction
        GET
      • Get the transaction status
        GET
      • Cancel a transaction
        DELETE
      • Refund a transaction
        POST
      • Generic Refund (Without existing Transaction Id)
        POST
      • Save a receipt for a transaction
        POST
      • Get merchant receipt for a transaction
        GET
      • Submit refund pin
        PATCH
    • 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
  • Schemas
    • v1
      • AdditionalPaymentMethods
      • SupportedPaymentChannel
      • ResponseDto
      • AdditionalPaymentMethods
      • SupportedPaymentChannelListResponseDto
      • AccountDetailsDto
      • AccountDetailsDtoListResponseDto
      • AddressDto
      • ApplicationMessageDto
      • AvailablePaymentChannelDetailDto
      • AvailablePaymentChannelDetailDtoListResponseDto
      • BooleanResponseDto
      • BrandColour
      • CancelIntentDto
      • CreateAccountRequestDto
      • CancelIntentDtoResponseDto
      • CreateAccountResponseDto
      • ClientCredentialTokenRequestDto
      • CreateAccountResponseDtoResponseDto
      • ClientOverrideDto
      • CollectionPromptChannel
      • CollectionPromptChannelDto
      • ContentDto
      • CountryCode
      • CreateGiftCardRequestDto
      • CreateNewAccountDto
      • CreateNewAccountResponseDto
      • CreateNewAccountResponseDtoResponseDto
      • CreatePaymentIntentDto
      • CurrencyCodes
      • CustomerDisplayType
      • CustomerInfoDto
      • WorldLineRefundOptions
      • CustomerType
      • DeviceConfiguration
      • DeviceSpecificationDto
      • DiscountDetailsDto
      • DiscountType
      • EndDayRequestDto
      • EndDayResponseDto
      • EndDayResponseDtoResponseDto
      • EpassiChannelOptions
      • ErrorResponseDto
      • GenericRefundPaymentIntentDto
      • GetCardDetailsRequestDto
      • TokenRequestDto
      • GiftCardDetailsDto
      • GiftCardDetailsDtoResponseDto
      • GiftCardPersonalizedMessageLengthDto
      • GiftCardPreviewDto
      • GiftCardStatus
      • GiftCardTemplateDetailsDto
      • GiftCardTemplateDetailsDtoListResponseDto
      • GiftCardTemplateDetailsDtoResponseDto
      • LegalLink
      • NetsBaxiChannelOptions
      • NetsBaxiCloudChannelOptions
      • NexiChannelOptions
      • OnsiteTerminalReportDto
      • NotificationChannel
      • OnsiteTerminalReportDtoResponseDto
      • NotificationOptions
      • ObjectResponseDto
      • OnboardCustomerRequestDto
      • OnboardCustomerResponseDto
      • OnboardCustomerResponseDtoResponseDto
      • OrderItemDto
      • OrderItemType
      • PaymentChannelType
      • POSType
      • PanEntryMode
      • PaymentAdditionalInfoDto
      • PaymentChannelAccountMetadata
      • PaymentChannelConfigurationFieldsDto
      • PaymentChannelConfigurationSchemaDto
      • PaymentChannelConfigurationSchemaDtoResponseDto
      • PaymentChannelMetaData
      • PaymentChannelMetaDataVerifoneVim
      • PaymentChannelMetaDataWestPay
      • PaymentChannelMetaDataWorldline
      • PaymentChannelOptionsDto
      • PaymentChannelOptionsForGenericRefundDto
      • PaymentChannelOptionsForRefundDto
      • PaymentFlowType
      • PaymentIntentDto
      • PaymentIntentDtoResponseDto
      • PaymentMethod
      • PaymentMethodBasicInfoResponseDto
      • PaymentMethodBasicInfoResponseDtoListResponseDto
      • PaymentMethodContentResponseDto
      • PaymentMethodContentResponseDtoResponseDto
      • PaymentMethodDto
      • PaymentStatus
      • PaymentSubStatus
      • PriceSignagePreview
      • PrintOnTerminalRequestDto
      • PrintOnTerminalResponseDto
      • PrintOnTerminalResponseDtoResponseDto
      • StoreDetailsDto
      • PrintResponseDto
      • StoreDetailsDtoListResponseDto
      • ReasonCode
      • ReceiptResponseDto
      • ReceiptResponseDtoResponseDto
      • ReceiptType
      • RefundPaymentIntentDto
      • RefundPaymentPinDto
      • ReportResponseDto
      • ReportResponseDtoResponseDto
      • ReportType
      • ResursChannelOptions
      • Retain24AccountOptions
      • Retain24ChannelOptions
      • SaveOnsiteTerminalReceiptDto
      • SaveOnsiteTerminalReportDto
      • MerchantsInformationDto
      • SoftPayChannelOptions
      • MerchantsInformationDtoListResponseDto
      • StringObjectDictionaryResponseDto
      • StringResponseDto
      • SupportedPaymentChannelDto
      • SupportedPaymentChannelDtoListResponseDto
      • TerminalDetailsResponseDto
      • TerminalDetailsResponseDtoResponseDto
      • TerminalStatus
      • Tip
      • TokenResponseDto
      • TokenResponseDtoResponseDto
      • TopupGiftCardRequestDto
      • TransactionStatusDto
      • TransactionType
      • TransactionStatusDtoResponseDto
      • UpdatePaymentChannelAccountDto
      • UpdateTransactionDto
      • VerifoneVimChannelOptions
      • VivaChannelOptions
      • VivaIsvSettingsDto
      • Void
      • WorldLineChannelOptions
      • PaymentChannelMetaDataWorldline
      • PrintOnTerminalRequestDto
      • PrintOnTerminalResponseDto
      • PrintOnTerminalResponseDtoResponseDto
      • Retain24ChannelOptions
      • WorldLineChannelOptions
      • WorldLineRefundOptions
      • PrintOnTerminalRequestDto
  1. Transaction

Get the transaction status

GET
/{tenantCode}/v1/transaction/{id}
This is the common endpoint to poll the transaction status for both NG and Non-NG POS

Request

Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://sandbox.api.confirmapay.com//v1/transaction/' \
--header 'Authorization: Bearer <token>'

Responses

🟢200 - Current transaction statusSuccess
application/json
Current transaction status
Bodyapplication/json

Example
{
    "data": {
        "id": 0,
        "uuid": "string",
        "statusId": 1,
        "subStatusId": 1000,
        "orderId": "string",
        "amount": 0,
        "tipAmount": 0,
        "originalAmount": 0,
        "currencyCode": 0,
        "paymentChannelType": 1,
        "posType": 1,
        "deviceId": "string",
        "terminalId": "string",
        "storeId": "string",
        "issuer": "string",
        "maskedPAN": "string",
        "transactionDateTime": "2019-08-24T14:15:22.123Z",
        "merchantReceiptText": "string",
        "customerReceiptText": "string",
        "aid": "string",
        "panEntryModeId": 0,
        "panEntryMode": "string",
        "verificationMethod": "string",
        "reasonCode": 99,
        "paymentChannelTransactionRef": "string",
        "transactionType": 1,
        "parentTransactionId": 0,
        "giftCardIdentifierCode": "string",
        "signatureRequired": true,
        "operatorId": "string",
        "receiptNumber": "string"
    },
    "description": {
        "code": "string",
        "message": "string"
    },
    "narrative": {
        "code": "string",
        "message": "string"
    }
}
🟠404 - Transaction not foundSuccess
🟠400 - Polling not supported for this payment method and collection prompt channelSuccess
Modified at 2026-03-27 08:39:14
Previous
Get customer receipt for a transaction
Next
Cancel a transaction
Built with