{ "item": [ { "name": "Gift Card Payments - REST", "description": "REST API calls used to initiate gift card payments.", "item": [ { "id": "8fb71bd9-322d-4fef-a063-9f29ad48c819", "name": "initiate payment request", "request": { "name": "initiate payment request", "description": { "content": "Initiates a payment.\n\nThe `restrictions` array containing the `payment_instrument` and\n`payment_instrument_subtype` gives the possibility to initiate a\npayment for the specific option chosen by the customer at the\nmerchant's checkout.\n\nError number `2039` indicates that one of the values passed in\n`payment_instrument` or `payment_instrument_subtype` is not a valid\nvalue.\n", "type": "text/plain" }, "url": { "path": [ "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"PAYSAFECARD\",\n \"amount\": \"\",\n \"currency\": \"XLT\",\n \"redirect\": {\n \"success_url\": \"\",\n \"failure_url\": \"\"\n },\n \"notification_url\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"min_age\": \"\",\n \"kyc_level\": \"SIMPLE\",\n \"country_restriction\": \"\"\n },\n \"restrictions\": {\n \"payment_instrument\": \"paysafecard\",\n \"payment_instrument_subtype\": \"openbuckscard\"\n },\n \"submerchant_id\": \"\",\n \"shop_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "e64ef469-ab7f-45d0-93eb-66e5a00cc472", "name": "Payment initiated successfully.", "originalRequest": { "url": { "path": [ "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"PAYSAFECARD\",\n \"amount\": \"\",\n \"currency\": \"XLT\",\n \"redirect\": {\n \"success_url\": \"\",\n \"failure_url\": \"\"\n },\n \"notification_url\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"min_age\": \"\",\n \"kyc_level\": \"SIMPLE\",\n \"country_restriction\": \"\"\n },\n \"restrictions\": {\n \"payment_instrument\": \"paysafecard\",\n \"payment_instrument_subtype\": \"openbuckscard\"\n },\n \"submerchant_id\": \"\",\n \"shop_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"PAYMENT\",\n \"id\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"currency\": \"WDQ\",\n \"status\": \"\",\n \"type\": \"PAYSAFECARD\",\n \"redirect\": {\n \"success_url\": \"\",\n \"failure_url\": \"\",\n \"auth_url\": \"\"\n },\n \"customer\": {\n \"id\": \"\"\n },\n \"amount\": \"\",\n \"notification_url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab53baa3-758c-4077-a8f4-0cf1ba205aed", "name": "Invalid restriction value.\n\nError number `2039` indicates that one of the values passed in\n`payment_instrument` or `payment_instrument_subtype` is not a\nvalid value.", "originalRequest": { "url": { "path": [ "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"PAYSAFECARD\",\n \"amount\": \"\",\n \"currency\": \"XLT\",\n \"redirect\": {\n \"success_url\": \"\",\n \"failure_url\": \"\"\n },\n \"notification_url\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"min_age\": \"\",\n \"kyc_level\": \"SIMPLE\",\n \"country_restriction\": \"\"\n },\n \"restrictions\": {\n \"payment_instrument\": \"paysafecard\",\n \"payment_instrument_subtype\": \"openbuckscard\"\n },\n \"submerchant_id\": \"\",\n \"shop_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Gift Card Notifications", "description": "JSON notification payloads sent for gift card payment updates.", "item": [ { "id": "5d22bbf6-a5f9-4317-9a4b-b6432df24290", "name": "JSON payment notification", "request": { "name": "JSON payment notification", "description": { "content": "The payment notification is used to notify the merchant independently\nof the customer's behavior after the payment authorization.\n\nThis service ensures that payments can be completed before the top-up\nof the customer's account and is, therefore, highly recommended in\norder to avoid incomplete payments.\n\nIn case of technical errors (e.g. socket timeout), or application\nerrors (e.g. HTTP 500 response), the payment notification is\nresubmitted at a regular interval until one of the following criteria\nis fulfilled:\n\n- The payment notification is successfully delivered (i.e. HTTP 200\n response from payment server).\n- The maximum number of retry attempts has been reached (currently\n configured at 5 retries).\n\nA JSON version of the payment notification with all the possible\nparameters, including the `payment_instrument` used, is available.\n\nThis operation is sent by paysafecard to the merchant's\n`notification_url`. It is documented here to describe the payload.\n", "type": "text/plain" }, "url": { "path": [ "payment-notification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"timestamp\": \"\",\n \"eventType\": \"\",\n \"version\": \"\",\n \"data\": {\n \"mid\": \"0675586833\",\n \"customer\": {\n \"id\": \"\"\n },\n \"payment_id\": \"\",\n \"payment_instrument\": \"giftcard\",\n \"payment_instrument_subtype\": \"openbuckscard\",\n \"card_details\": [\n {\n \"serial\": \"\",\n \"currency\": \"JTL\",\n \"amount\": \"\",\n \"type\": \"\",\n \"country\": \"KS\"\n },\n {\n \"serial\": \"\",\n \"currency\": \"LJL\",\n \"amount\": \"\",\n \"type\": \"\",\n \"country\": \"SZ\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e3bf1e50-b4bb-40cf-b284-992da4a14578", "name": "Payment notification successfully delivered. The payment server\nexpects an HTTP 200 response, otherwise the notification is\nresubmitted.", "originalRequest": { "url": { "path": [ "payment-notification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"timestamp\": \"\",\n \"eventType\": \"\",\n \"version\": \"\",\n \"data\": {\n \"mid\": \"0675586833\",\n \"customer\": {\n \"id\": \"\"\n },\n \"payment_id\": \"\",\n \"payment_instrument\": \"giftcard\",\n \"payment_instrument_subtype\": \"openbuckscard\",\n \"card_details\": [\n {\n \"serial\": \"\",\n \"currency\": \"JTL\",\n \"amount\": \"\",\n \"type\": \"\",\n \"country\": \"KS\"\n },\n {\n \"serial\": \"\",\n \"currency\": \"LJL\",\n \"amount\": \"\",\n \"type\": \"\",\n \"country\": \"SZ\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://apitest.paysafecard.com/v1" } ], "info": { "_postman_id": "2c4d09bc-469f-462c-8dd7-08686d82737b", "name": "Gift Cards API Calls", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "## Overview\n\nThis API reference contains Gift Card REST API calls.\n\nThe `restrictions` object of the payment request allows a payment to be\ninitiated for the specific gift card option chosen by the customer at the\nmerchant's checkout.\n\nThe current minimum amount for gift card payments is `0.10` USD and the\ncurrent maximum amount is `1000.00` USD. If a gift card payment is created\nfor an amount smaller than `0.10` USD, the customer sees an error message\nin the payment panel.\n", "type": "text/plain" } } }