{ "item": [ { "name": "Pin-on-Demand API Requests", "description": "Pin-on-Demand order and card operations.", "item": [ { "id": "e62969c3-38e5-4b99-9b8f-5a394400609d", "name": "Execute an order", "request": { "name": "Execute an order", "description": { "content": "Purchases one PaysafeCard PIN.\n\nThe optional `Correlation-ID` header lets the business partner set part\nof the order ID. The value must be unique, no longer than 41 characters,\nand contain only `a-z`, `A-Z`, `0-9`, `_`, or `-`.\n", "type": "text/plain" }, "url": { "path": [ "orders", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique correlation identifier. The value must be no longer than 41\ncharacters and may contain only letters, digits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "7qVHS" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"product_id\": \"\",\n \"delivery_type\": \"RETURN\",\n \"utc_offset\": \"\",\n \"shop_id\": \"\",\n \"terminal_id\": \"\",\n \"customer\": {\n \"id_type\": \"NONE\"\n },\n \"capture\": true,\n \"retailer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "e881c063-4346-4447-9112-b33f65914f04", "name": "Order created successfully.", "originalRequest": { "url": { "path": [ "orders", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique correlation identifier. The value must be no longer than 41\ncharacters and may contain only letters, digits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "7qVHS" }, { "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 \"amount\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"product_id\": \"\",\n \"delivery_type\": \"RETURN\",\n \"utc_offset\": \"\",\n \"shop_id\": \"\",\n \"terminal_id\": \"\",\n \"customer\": {\n \"id_type\": \"NONE\"\n },\n \"capture\": true,\n \"retailer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"card\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"serial\": \"\",\n \"pin\": \"\",\n \"product_id\": \"\"\n },\n \"distributor_id\": \"\",\n \"order_id\": \"\",\n \"product_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db275dc8-69f6-46ea-a125-31acd5778932", "name": "Pin-on-Demand error.", "originalRequest": { "url": { "path": [ "orders", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique correlation identifier. The value must be no longer than 41\ncharacters and may contain only letters, digits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "7qVHS" }, { "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 \"amount\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"product_id\": \"\",\n \"delivery_type\": \"RETURN\",\n \"utc_offset\": \"\",\n \"shop_id\": \"\",\n \"terminal_id\": \"\",\n \"customer\": {\n \"id_type\": \"NONE\"\n },\n \"capture\": true,\n \"retailer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"string\",\n \"key_1\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8cf104e-f52c-4455-b124-98b5ad604496", "name": "Retrieve order", "request": { "name": "Retrieve order", "description": { "content": "Retrieves a previous order. The `Correlation-ID` header can be used\ninstead of the order ID in the URI.\n", "type": "text/plain" }, "url": { "path": [ "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Identifier of a successful execute order request.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Unique correlation identifier. The value must be no longer than 41\ncharacters and may contain only letters, digits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "7qVHS" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "8e1e24f5-7d3c-4f7a-a0a8-c373df035542", "name": "Order retrieved successfully.", "originalRequest": { "url": { "path": [ "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of a successful execute order request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique correlation identifier. The value must be no longer than 41\ncharacters and may contain only letters, digits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "7qVHS" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"card\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"serial\": \"\",\n \"pin\": \"\",\n \"product_id\": \"\"\n },\n \"distributor_id\": \"\",\n \"order_id\": \"\",\n \"product_id\": \"\",\n \"shop_id\": \"\",\n \"terminal_id\": \"\",\n \"order_status\": \"REJECTED\",\n \"delivery_type\": \"RETURN\",\n \"order_error_code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c034a8bb-af25-4ae3-b44e-bd745e451ee2", "name": "Pin-on-Demand error.", "originalRequest": { "url": { "path": [ "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of a successful execute order request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique correlation identifier. The value must be no longer than 41\ncharacters and may contain only letters, digits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "7qVHS" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"string\",\n \"key_1\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4215878-8a86-463f-9228-d45cf9da6025", "name": "Cancel order", "request": { "name": "Cancel order", "description": { "content": "Undoes a previous order and invalidates the associated PIN.\n\nCancellation succeeds when the PIN has not been used and the configured\ntimeout has not elapsed. The documented defaults are 5 minutes in the\ntest environment and 20 days in the production environment.\n\nA cancelled order does not appear on the business partner invoice, but\nappears in the reconciliation file. If the PIN is already invoiced, a\ncredit note is issued. The `Correlation-ID` header can be used instead\nof the order ID in the URI.\n", "type": "text/plain" }, "url": { "path": [ "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Identifier of a successful execute order request.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Unique correlation identifier. The value must be no longer than 41\ncharacters and may contain only letters, digits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "7qVHS" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "fe47d6f9-30e4-46d2-984d-8f183904b6c0", "name": "Order cancelled successfully.", "originalRequest": { "url": { "path": [ "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of a successful execute order request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique correlation identifier. The value must be no longer than 41\ncharacters and may contain only letters, digits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "7qVHS" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"distributor_id\": \"\",\n \"order_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bff41ea7-14d3-4e40-9fed-ee92f9280173", "name": "Pin-on-Demand error.", "originalRequest": { "url": { "path": [ "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of a successful execute order request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique correlation identifier. The value must be no longer than 41\ncharacters and may contain only letters, digits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "7qVHS" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"string\",\n \"key_1\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99968a13-91b4-4c8a-9a36-23bc65d7b155", "name": "Cancel card", "request": { "name": "Cancel card", "description": { "content": "Invalidates an unused PaysafeCard PIN by serial number. This request does\nnot cancel the associated order and should only be used after the order\ncancellation period has elapsed.\n", "type": "text/plain" }, "url": { "path": [ "cards", ":sn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "sn", "disabled": false, "description": { "content": "(Required) Serial number from a successful execute order request.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "634f50c8-5e22-4be6-a347-810d0695a739", "name": "Card cancelled successfully.", "originalRequest": { "url": { "path": [ "cards", ":sn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Serial number from a successful execute order request.", "type": "text/plain" }, "type": "any", "value": "", "key": "sn" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"terminal_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fd86dcc-fb2d-4c5c-8abd-9ca9ab0d1c91", "name": "Pin-on-Demand error.", "originalRequest": { "url": { "path": [ "cards", ":sn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Serial number from a successful execute order request.", "type": "text/plain" }, "type": "any", "value": "", "key": "sn" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: basic", "type": "text/plain" }, "key": "Authorization", "value": "Basic " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"string\",\n \"key_1\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Fiscal Code", "description": "Fiscal-code order operation.", "item": [ { "id": "a5724c64-b573-4f6e-9489-6b8ec24f5b6b", "name": "Execute order with fiscal code", "request": { "name": "Execute order with fiscal code", "description": { "content": "Executes an order using a customer fiscal code.\n\nSet `delivery_type` to `ACCOUNT` for direct top-up or `RETURN` for PIN\nsale. Set `customer.id_type` to `CIVIL_NUMBER` and `customer.id` to the\nfiscal code in uppercase without spaces. `capture` must be `true`.\n\nThe values of `delivery_type` and `id_type` are reflected in the\nreconciliation file.\n", "type": "text/plain" }, "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique correlation identifier. The value must be no longer than 41\ncharacters and may contain only letters, digits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "7qVHS" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"product_id\": \"\",\n \"delivery_type\": \"RETURN\",\n \"utc_offset\": \"\",\n \"shop_id\": \"\",\n \"terminal_id\": \"\",\n \"customer\": {\n \"id_type\": \"CIVIL_NUMBER\",\n \"id\": \"U\"\n },\n \"capture\": true,\n \"retailer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "e9ba8d0d-6038-4905-8ffa-276a3575869d", "name": "Order created successfully.", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique correlation identifier. The value must be no longer than 41\ncharacters and may contain only letters, digits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "7qVHS" }, { "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 \"amount\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"product_id\": \"\",\n \"delivery_type\": \"RETURN\",\n \"utc_offset\": \"\",\n \"shop_id\": \"\",\n \"terminal_id\": \"\",\n \"customer\": {\n \"id_type\": \"CIVIL_NUMBER\",\n \"id\": \"U\"\n },\n \"capture\": true,\n \"retailer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"card\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"serial\": \"\",\n \"pin\": \"\",\n \"product_id\": \"\"\n },\n \"distributor_id\": \"\",\n \"order_id\": \"\",\n \"product_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bf65b58-77dd-4aae-80d7-2f8003bc061d", "name": "Pin-on-Demand error.", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique correlation identifier. The value must be no longer than 41\ncharacters and may contain only letters, digits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "7qVHS" }, { "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 \"amount\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"product_id\": \"\",\n \"delivery_type\": \"RETURN\",\n \"utc_offset\": \"\",\n \"shop_id\": \"\",\n \"terminal_id\": \"\",\n \"customer\": {\n \"id_type\": \"CIVIL_NUMBER\",\n \"id\": \"U\"\n },\n \"capture\": true,\n \"retailer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"string\",\n \"key_1\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://distributor.test.paysafecard.com/v1" } ], "info": { "_postman_id": "a9265c23-4e3a-4911-814f-e2411f696652", "name": "Distributor - Pin on Demand REST API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Distributor Pin-on-Demand REST API.", "type": "text/plain" } } }