Confirma Payment Platform
  1. GiftCard
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
      • Get template by Id
        GET
      • Create and Issue a Card
        POST
      • Top Up a Card
        PATCH
      • Get a Card
        GET
      • Validate a Card
        POST
      • Cancel a card
        DELETE
      • Cancel the last topup of the card
        DELETE
    • 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
  1. GiftCard

Create and Issue a Card

POST
/{tenantCode}/v1/gift-card/payment-channel/{paymentChannelId}
You can create and issue a gift card

Request

Path Params

Header Params

Body Params application/json

Example
{
    "templateId": "string",
    "amount": 0,
    "currencyCode": 36,
    "notificationOptions": [
        {
            "notificationChannel": 0,
            "sendDateTime": "2019-08-24T14:15:22Z",
            "textContent": "string",
            "phone": "string",
            "email": "string"
        }
    ]
}

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/gift-card/payment-channel/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "templateId": "string",
    "amount": 0,
    "currencyCode": 36,
    "notificationOptions": [
        {
            "notificationChannel": 0,
            "sendDateTime": "2019-08-24T14:15:22Z",
            "textContent": "string",
            "phone": "string",
            "email": "string"
        }
    ]
}'

Responses

🟢200Success
application/json
Card created and issued
Body

Example
{
    "data": {
        "id": "string",
        "balance": 0,
        "issuedAt": "2019-08-24T14:15:22Z",
        "expiresAt": "2019-08-24T14:15:22Z",
        "currencyCode": 36,
        "status": 100,
        "reloadable": true,
        "loadable": true,
        "pin": "string",
        "pinRequired": true
    },
    "description": {
        "code": "string",
        "message": "string"
    },
    "narrative": {
        "code": "string",
        "message": "string"
    }
}
🟢200Success
Modified at 2025-11-24 05:00:19
Previous
Get template by Id
Next
Top Up a Card
Built with