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
    • Worldline 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
      • 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
        • Save a receipt for a transaction
        • Get merchant 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
    • Schemas
      • v1
      • AdditionalPaymentMethods
      • SupportedPaymentChannel
      • ResponseDto
      • AdditionalPaymentMethods
      • SupportedPaymentChannelListResponseDto
      • ApplicationMessageDto
      • BooleanResponseDto
      • BrandColour
      • CancelIntentDto
      • CancelIntentDtoResponseDto
      • ClientOverrideDto
      • CollectionPromptChannel
      • CollectionPromptChannelDto
      • CreateAccountRequestDto
      • CreateAccountResponseDto
      • CreateAccountResponseDtoResponseDto
      • CurrencyCodes
      • CustomerDisplayType
      • CustomerInfoDto
      • DeviceConfiguration
      • DeviceSpecificationDto
      • EndDayRequestDto
      • ErrorResponseDto
      • GenericRefundPaymentIntentDto
      • POSType
      • PanEntryMode
      • PaymentIntentDto
      • PaymentAdditionalInfoDto
      • PaymentChannelType
      • PaymentChannelMetaData
      • PaymentChannelOptionsForGenericRefundDto
      • PaymentChannelOptionsForRefundDto
      • PaymentIntentDtoResponseDto
      • PaymentMethod
      • PaymentMethodDto
      • PaymentStatus
      • PrintResponseDto
      • ReasonCode
      • RefundPaymentIntentDto
      • ReportResponseDto
      • ReportResponseDtoResponseDto
      • ReportType
      • SaveOnsiteTerminalReportDto
      • TokenRequestDto
      • TokenResponseDto
      • TokenResponseDtoResponseDto
      • TransactionStatusDto
      • TransactionStatusDtoResponseDto
      • UpdateTransactionDto
      • VivaChannelOptions
      • TerminalDetailsResponseDto
      • TerminalStatus
      • TransactionType
      • TerminalDetailsResponseDtoResponseDto
      • CreatePaymentIntentDto
      • ContentDto
      • CreateGiftCardRequestDto
      • DiscountDetailsDto
      • DiscountType
      • EpassiChannelOptions
      • GiftCardDetailsDto
      • GiftCardDetailsDtoResponseDto
      • GiftCardPersonalizedMessageLengthDto
      • GiftCardPreviewDto
      • GiftCardStatus
      • GiftCardTemplateDetailsDto
      • GiftCardTemplateDetailsDtoListResponseDto
      • GiftCardTemplateDetailsDtoResponseDto
      • NotificationChannel
      • NotificationOptions
      • TopupGiftCardRequestDto
      • ObjectResponseDto
      • PaymentChannelOptionsDto
      • PaymentChannelOptionsDto
      • ReceiptResponseDto
      • ReceiptResponseDtoResponseDto
      • ReceiptType
      • SaveOnsiteTerminalReceiptDto
      • VivaIsvSettingsDto
      • GetCardDetailsRequestDto
      • CustomerType
      • OrderItemDto
      • OrderItemType
      • PaymentFlowType
      • PaymentSubStatus
      • ResursChannelOptions
      • CountryCode
      • LegalLink
      • PaymentMethodBasicInfoResponseDto
      • PaymentMethodBasicInfoResponseDtoListResponseDto
      • PaymentMethodContentResponseDto
      • PaymentMethodContentResponseDtoResponseDto
      • PriceSignagePreview
      • StoreDetailsDto
      • StoreDetailsDtoListResponseDto
      • AddressDto
      • AvailablePaymentChannelDetailDto
      • AvailablePaymentChannelDetailDtoListResponseDto
      • PaymentChannelConfigurationFieldsDto
      • PaymentChannelConfigurationSchemaDto
      • PaymentChannelConfigurationSchemaDtoResponseDto
      • PaymentChannelMetaDataVerifoneVim
      • StringObjectDictionaryResponseDto
      • StringResponseDto
      • VerifoneVimChannelOptions
      • MerchantsInformationDto
      • MerchantsInformationDtoListResponseDto
      • SoftPayChannelOptions
      • Tip
      • SupportedPaymentChannelDto
      • SupportedPaymentChannelDtoListResponseDto
      • Void
      • NexiChannelOptions
      • PaymentChannelMetaDataWorldline
      • PaymentChannelMetaDataWorldline
      • PrintOnTerminalRequestDto
      • PrintOnTerminalRequestDto
      • PrintOnTerminalResponseDto
      • PrintOnTerminalResponseDto
      • PrintOnTerminalResponseDtoResponseDto
      • PrintOnTerminalResponseDtoResponseDto
      • Retain24ChannelOptions
      • Retain24ChannelOptions
      • WorldLineChannelOptions
      • WorldLineChannelOptions
      • WorldLineRefundOptions
      • WorldLineRefundOptions
      • EndDayResponseDto
      • PrintOnTerminalRequestDto

    CreatePaymentIntentDto

    Request structure for creating a payment request.

    {
        "amount": 0,
        "currencyCode": 36,
        "orderId": "string",
        "storeId": "string",
        "posType": 1,
        "paymentChannelId": 1,
        "preferredPaymentMethodId": 0,
        "collectionPromptChannelId": 0,
        "paymentFlowType": 1,
        "fee": 0,
        "tipAmount": 0,
        "terminalId": "string",
        "customer": {
            "id": "string",
            "firstName": "string",
            "lastName": "string",
            "fullName": "string",
            "email": "string",
            "phone": "string",
            "preferredLanguage": "string",
            "type": 1,
            "deliveryAddress": {
                "fullName": "string",
                "firstName": "string",
                "lastName": "string",
                "addressRow1": "string",
                "addressRow2": "string",
                "postalArea": "string",
                "postalCode": "string",
                "countryCode": 4
            },
            "billingAddress": {
                "fullName": "string",
                "firstName": "string",
                "lastName": "string",
                "addressRow1": "string",
                "addressRow2": "string",
                "postalArea": "string",
                "postalCode": "string",
                "countryCode": 4
            },
            "isDeliveryRecipient": true
        },
        "deviceSpec": {
            "os": "string",
            "isBrowserBased": true
        },
        "overrides": {
            "useDeepLink": true,
            "vivaOptions": {
                "isvMerchantId": "string",
                "isvSourceCode": "string"
            },
            "verifoneVimOptions": {
                "confirmation": true,
                "pinCode": "string"
            }
        },
        "options": {
            "epassiOptions": {
                "accessKey": "string"
            },
            "resursOptions": {
                "storeId": "string",
                "paymentMethodId": "string"
            },
            "softPayOptions": {
                "employeeReference": "string",
                "merchantReference": "string",
                "tipping": {
                    "enableTipping": true,
                    "percentageOptions": [
                        0
                    ]
                }
            },
            "retain24Options": {
                "accountId": "string"
            },
            "nexiOptions": {
                "customerPresentForRefund": true,
                "cashBackAmount": 0
            },
            "worldLineOptions": {
                "cashierIdentification": "string"
            }
        },
        "qrCode": "string",
        "giftCardIdentifierCode": "string",
        "pin": "string",
        "orderItems": [
            {
                "description": "string",
                "referenceId": "string",
                "quantity": 0,
                "quantityUnit": "string",
                "amount": 0,
                "vatAmount": 0,
                "vatRate": 0,
                "type": 1
            }
        ]
    }
    Built with