Confirma Payment Platform
  1. Payment
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
        POST
      • Marks the day end
        POST
    • 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
  1. Payment

Create a new payment request

POST
/{tenantCode}/v1/payment
This is the common endpoint to create a new payment request for both NG and Non-NG POS

Request

Path Params

Header Params

Body Params application/json

Example
{
    "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
                ]
            }
        }
    },
    "qrCode": "string",
    "giftCardIdentifierCode": "string",
    "pin": "string",
    "orderItems": [
        {
            "description": "string",
            "referenceId": "string",
            "quantity": 0,
            "quantityUnit": "string",
            "amount": 0,
            "vatAmount": 0,
            "vatRate": 0,
            "type": 1
        }
    ]
}

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 --request POST 'https://sandbox.api.confirmapay.com//v1/payment' \
--header 'Device-Id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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
                ]
            }
        }
    },
    "qrCode": "string",
    "giftCardIdentifierCode": "string",
    "pin": "string",
    "orderItems": [
        {
            "description": "string",
            "referenceId": "string",
            "quantity": 0,
            "quantityUnit": "string",
            "amount": 0,
            "vatAmount": 0,
            "vatRate": 0,
            "type": 1
        }
    ]
}'

Responses

🟢200Success
application/json
Payment request created
Body

Example
{
    "data": {
        "orderId": "string",
        "transactionId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "status": 1,
        "subStatus": 1000,
        "deepLinkUrl": "string",
        "customerRedirectUrl": "string",
        "merchantRedirectUrl": "string",
        "paymentChannelMetaData": {
            "verifoneVim": {
                "transactionType": 1,
                "verifoneVimTerminalTransactionId": "string"
            }
        }
    },
    "description": {
        "code": "string",
        "message": "string"
    },
    "narrative": {
        "code": "string",
        "message": "string"
    }
}
🟢200Success
🟢200Success
🟢200Success
🟢200Success
🟢200Success
🟢200Success
🟢200Success
🟢200Success
Modified at 2025-11-24 05:00:19
Previous
Cancel the last topup of the card
Next
Marks the day end
Built with