Get the available templates - Confirma Payment Platform

Request

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://sandbox.api.confirmapay.com//v1/gift-card/payment-channel//templates?accountId' \
--header 'Authorization: Bearer <token>'

Responses

🟢200 - Provides list of templatesSuccess

application/json

Provides list of templates

Body

Example

{
    "data": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "notificationChannel": 0,
            "maxAmount": 0,
            "minAmount": 0,
            "isActive": true,
            "salesStartDate": "2019-08-24T14:15:22.123Z",
            "salesEndDate": "2019-08-24T14:15:22.123Z",
            "usageStartDate": "2019-08-24T14:15:22.123Z",
            "validityInSeconds": 0,
            "pinRequired": true,
            "currencyCode": 36,
            "reloadable": true,
            "preview": {
                "onlineContent": {
                    "type": "string",
                    "data": "string"
                },
                "printableContent": {
                    "type": "string",
                    "data": "string"
                },
                "smsContent": {
                    "type": "string",
                    "data": "string"
                }
            },
            "personalizedMessageLength": {
                "sms": 0,
                "online": 0,
                "printable": 0
            },
            "discount": {
                "type": 1,
                "value": 0
            }
        }
    ],
    "description": {
        "code": "string",
        "message": "string"
    },
    "narrative": {
        "code": "string",
        "message": "string"
    }
}

🟠400 - Gift card not supported for this payment method and collection prompt channelSuccess