{ "item": [ { "name": "PaysafeCard direct and PaysafeCash API Requests", "description": "Requests available in the PaysafeCard direct and PaysafeCash REST API.", "item": [ { "id": "d9099f7a-5c34-4ccd-b246-07f275a58826", "name": "Prepare order", "request": { "name": "Prepare order", "description": { "content": "Verifies the feasibility of the request without causing side effects in the system. For a prepare order request, `capture` must be `false`.\n\nThe optional `Correlation-ID` header lets the business partner set part of the order `id`. The value must be unique, contain no more than 41 characters, and use only `a-z`, `A-Z`, `0-9`, `_`, or `-`.", "type": "text/plain" }, "url": { "path": [ "orders", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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\": \"ACCOUNT\",\n \"utc_offset\": \"\",\n \"shop_id\": \"\",\n \"terminal_id\": \"\",\n \"customer\": {\n \"id_type\": \"ACCOUNT\",\n \"id\": \"\"\n },\n \"capture\": false,\n \"retailer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "ce8bbf58-00dd-43b1-afd2-065b75b13d56", "name": "Order prepared successfully.", "originalRequest": { "url": { "path": [ "orders", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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\": \"ACCOUNT\",\n \"utc_offset\": \"\",\n \"shop_id\": \"\",\n \"terminal_id\": \"\",\n \"customer\": {\n \"id_type\": \"ACCOUNT\",\n \"id\": \"\"\n },\n \"capture\": false,\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 \"distributor_id\": \"\",\n \"order_id\": \"\",\n \"product_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24f6922e-e91b-4cca-be60-305882293b2c", "name": "PaysafeCard direct or PaysafeCash request error. See PaysafeCardDirectPaysafeCashErrorCode.", "originalRequest": { "url": { "path": [ "orders", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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\": \"ACCOUNT\",\n \"utc_offset\": \"\",\n \"shop_id\": \"\",\n \"terminal_id\": \"\",\n \"customer\": {\n \"id_type\": \"ACCOUNT\",\n \"id\": \"\"\n },\n \"capture\": false,\n \"retailer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c2868f31-b402-4f71-b677-456e62682587", "name": "Confirm order", "request": { "name": "Confirm order", "description": { "content": "Confirms and executes a previously prepared order.\n\nThis request can only be called after a successful prepare order request.\nOnly successfully confirmed transactions appear in the reconciliation\nfile. The source documentation specifies no time frame between prepare\norder and confirm order requests.\n\nThe `Correlation-ID` header can be used instead of the order ID in the URI.\n", "type": "text/plain" }, "url": { "path": [ "orders", ":id", "capture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Order identifier returned by a successful prepare or confirm order request.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "307b5554-daf1-447d-9973-24d002eb7efb", "name": "Order confirmed successfully.", "originalRequest": { "url": { "path": [ "orders", ":id", "capture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Order identifier returned by a successful prepare or confirm order request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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": {} }, "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 \"product_id\": \"\"\n },\n \"product_id\": \"\",\n \"distributor_id\": \"\",\n \"order_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59a1a508-4d4b-4b7d-a596-ce62e1daf32a", "name": "PaysafeCard direct or PaysafeCash request error. See PaysafeCardDirectPaysafeCashErrorCode.", "originalRequest": { "url": { "path": [ "orders", ":id", "capture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Order identifier returned by a successful prepare or confirm order request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4466dd38-35ac-41ee-96bf-d618929419ce", "name": "Retrieve order", "request": { "name": "Retrieve order", "description": { "content": "Retrieves the status and information of an order.\n\nThe business partner can retrieve an order at any time.\n\nThe `Correlation-ID` header can be used instead 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) Order identifier returned by a successful prepare or confirm order request.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "1fd32b42-8230-445b-bbd0-1ccbcd5e9306", "name": "Order retrieved successfully.", "originalRequest": { "url": { "path": [ "orders", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Order identifier returned by a successful prepare or confirm order request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"card\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"serial\": \"\",\n \"product_id\": \"\"\n },\n \"distributor_id\": \"\",\n \"order_id\": \"\",\n \"product_id\": \"\",\n \"shop_id\": \"\",\n \"terminal_id\": \"\",\n \"order_status\": \"DELIVERED\",\n \"delivery_type\": \"ACCOUNT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b087122-f339-4e58-9a31-e7a030b697a8", "name": "PaysafeCard direct or PaysafeCash request error. See PaysafeCardDirectPaysafeCashErrorCode.", "originalRequest": { "url": { "path": [ "orders", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Order identifier returned by a successful prepare or confirm order request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e0b9ef1-0d00-4455-a861-79ffe63b84f9", "name": "Cancel order", "request": { "name": "Cancel order", "description": { "content": "Undoes a previous order and invalidates the amount associated with it.\n\nCancellation is successful when the cool-down period has not elapsed and\nthe order status is `PREPARED` or `DELIVERED`. During the cool-down period,\nthe amount is temporarily frozen. The documented default cool-down period\nis five minutes. After it elapses, cancellation might fail because the\ncustomer may already have used the amount associated with the order.\n\nImplementing this request is mandatory when a previous order must be\nundone because the customer cannot pay for the transaction at the POS.\nA successful cancellation does not appear on the distributor invoice,\nbut does appear in the daily reconciliation file.\n\nThe `Correlation-ID` header can be used instead 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) Order identifier returned by a successful prepare or confirm order request.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "b68fe299-352c-4436-a49b-fb3d1baced76", "name": "Order cancelled successfully.", "originalRequest": { "url": { "path": [ "orders", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Order identifier returned by a successful prepare or confirm order request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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": "b92bf67c-3dbb-4a2b-9924-afa3a798c10d", "name": "PaysafeCard direct or PaysafeCash request error. See PaysafeCardDirectPaysafeCashErrorCode.", "originalRequest": { "url": { "path": [ "orders", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Order identifier returned by a successful prepare or confirm order request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "PaysafeCash POS cashout API Requests", "description": "PaysafeCash POS cashout requests.", "item": [ { "id": "e1f67cbe-dace-4812-b012-ced342967007", "name": "Prepare order", "request": { "name": "Prepare order", "description": { "content": "Verifies the feasibility of a PaysafeCash POS cashout request without causing side effects.\nThe optional Correlation-ID can set part of the order id and must be unique.\n", "type": "text/plain" }, "url": { "path": [ "cashouts", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"country\": \"\",\n \"shop_id\": \"\",\n \"terminal_id\": \"\",\n \"utc_offset\": \"\",\n \"barcode\": \"\",\n \"retailer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "221e5db6-244d-448d-8dc5-a329fa000d00", "name": "Cashout order prepared successfully.", "originalRequest": { "url": { "path": [ "cashouts", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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 \"shop_id\": \"\",\n \"terminal_id\": \"\",\n \"utc_offset\": \"\",\n \"barcode\": \"\",\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 \"distributor_id\": \"\",\n \"order_id\": \"\",\n \"product_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d8dcb72-0a82-40b0-b0c2-0ebd5d540066", "name": "PaysafeCard direct or PaysafeCash request error. See PaysafeCardDirectPaysafeCashErrorCode.", "originalRequest": { "url": { "path": [ "cashouts", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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 \"shop_id\": \"\",\n \"terminal_id\": \"\",\n \"utc_offset\": \"\",\n \"barcode\": \"\",\n \"retailer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0709205-d254-4c6f-8bdb-49ddd9e03183", "name": "Confirm order", "request": { "name": "Confirm order", "description": { "content": "Confirms and executes a previously prepared PaysafeCash POS cashout order.\n\nThis request can only be called after a successful prepare order request.\nOnly successfully confirmed transactions appear in the reconciliation\nfile. There is no documented time frame between the prepare order and\nconfirm order requests.\n\nThe `Correlation-ID` header can be used instead of the order ID in the URI.\n", "type": "text/plain" }, "url": { "path": [ "cashouts", ":id", "capture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Cashout order identifier.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "e548d002-4211-4b28-a934-e15358878fe3", "name": "Cashout order confirmed successfully.", "originalRequest": { "url": { "path": [ "cashouts", ":id", "capture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cashout order identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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": {} }, "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 \"product_id\": \"\"\n },\n \"distributor_id\": \"\",\n \"order_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8315074-4a7f-473e-a75d-9fe6cdb5dfda", "name": "PaysafeCard direct or PaysafeCash request error. See PaysafeCardDirectPaysafeCashErrorCode.", "originalRequest": { "url": { "path": [ "cashouts", ":id", "capture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cashout order identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b6a3b37-e09e-404d-9074-1b8b0c69d7b7", "name": "Cancel order", "request": { "name": "Cancel order", "description": { "content": "Undoes a previous PaysafeCash POS cashout order.\n\nCancellation succeeds when the five-minute cool-down period has not elapsed and the order status is `PREPARED` or `DELIVERED`. During the cool-down period, the amount associated with the order is temporarily frozen. After the cool-down period elapses, cancellation might fail because the customer may already have used the amount associated with the order.\n\nImplementing this request is mandatory when a previous order must be undone because there is not enough money available at the POS to give to the customer. A successful cancellation does not appear on the distributor invoice, but does appear in the daily reconciliation file. The `Correlation-ID` header can be used instead of the order ID in the URI.", "type": "text/plain" }, "url": { "path": [ "cashouts", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Cashout order identifier.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "450a4acd-93d6-487c-84f1-4404c944ff5b", "name": "Cashout order cancelled successfully.", "originalRequest": { "url": { "path": [ "cashouts", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cashout order identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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": "5d7f8b17-79d2-42e2-959a-1695ca0275d3", "name": "PaysafeCard direct or PaysafeCash request error. See PaysafeCardDirectPaysafeCashErrorCode.", "originalRequest": { "url": { "path": [ "cashouts", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cashout order identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e099e969-8799-4ce7-9f2d-3f09f2aa4d78", "name": "Retrieve order", "request": { "name": "Retrieve order", "description": { "content": "Retrieves the status and information of a PaysafeCash POS cashout order. The business partner can retrieve an order at any time. The `Correlation-ID` header can be used instead of the order ID in the URI.", "type": "text/plain" }, "url": { "path": [ "cashouts", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Cashout order identifier.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "3148a5e6-e2aa-4a55-8519-546b21fe2e85", "name": "Cashout order retrieved successfully.", "originalRequest": { "url": { "path": [ "cashouts", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cashout order identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"card\": {\n \"amount\": \"\",\n \"currency\": \"\",\n \"serial\": \"\",\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\": \"ACCOUNT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78943436-5308-43fc-a21a-f1f15696b2b8", "name": "PaysafeCard direct or PaysafeCash request error. See PaysafeCardDirectPaysafeCashErrorCode.", "originalRequest": { "url": { "path": [ "cashouts", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Cashout order identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Unique value that can be used instead of the order ID in the URI. The\nvalue can contain a maximum of 41 characters and may use only letters,\ndigits, underscores, or hyphens.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "tYNyo" }, { "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\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://distributor.test.paysafecard.com/v1" } ], "info": { "_postman_id": "c0946ac7-9f0b-4a22-a5f7-b9eecc9dbb0d", "name": "PaysafeCard direct and PaysafeCash REST API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The PaysafeCard direct and PaysafeCash REST API enables business partners\nto process barcode-based transactions at the point of sale.\n\nBoth products follow the same initial order flow. The business partner\nprepares the transaction, verifies the product returned by the API, and\nconfirms the order. The final customer-facing step differs between the\nstandard PaysafeCard direct or PaysafeCash payment flow and the PaysafeCash\nPOS cashout flow.\n\n## PaysafeCard direct and PaysafeCash process\n\nA PaysafeCard direct or PaysafeCash order is processed as follows:\n\n1. The customer brings a barcode to the point of sale.\n\n2. The POS employee scans the barcode or enters the barcode number manually.\n The product and fee model are detected automatically from the selected\n barcode.\n\n3. The business partner sends the `prepareOrder` request to the PaysafeCard\n system.\n\n4. PaysafeCard performs validation checks, including limits and account\n status. A successful response returns the order with the status\n `PREPARED`.\n\n5. Optionally, the business partner can send the `cancelOrder` request at\n this stage. The resulting order status is `WITHDRAWN`.\n\n6. The business partner compares the product detected from the barcode with\n the product returned by `prepareOrder`. This check helps prevent barcode\n manipulation.\n\n7. The business partner sends the `confirmOrder` request using the order ID\n returned by `prepareOrder`.\n\n8. PaysafeCard performs another set of validation checks, including limits\n and account status. A successful response returns the order with the\n status `DELIVERED`.\n\n9. The business partner system prints a voucher containing the required\n transaction information and gives it to the customer.\n\n10. An optional cool-down period begins. The documented default is five\n minutes. During this period, the business partner can send the\n `cancelOrder` request. A successfully cancelled order has the status\n `CANCELLED`.\n\n If the order is cancelled, the business partner system prints a\n cancellation receipt and gives it to the customer.\n\n11. PaysafeCard executes the payment and notifies the customer.\n\n## PaysafeCash POS cashout process\n\nA PaysafeCash POS cashout order is processed as follows:\n\n1. The customer brings a barcode to the point of sale.\n\n2. The POS employee scans the barcode or enters the barcode number manually.\n The product and fee model are detected automatically from the selected\n barcode.\n\n3. The business partner sends the `prepareOrder` request to the PaysafeCard\n system.\n\n4. PaysafeCard performs validation checks, including limits and account\n status. A successful response returns the order with the status\n `PREPARED`.\n\n5. Optionally, the business partner can send the `cancelOrder` request at\n this stage. The resulting order status is `WITHDRAWN`.\n\n6. The business partner compares the product detected from the barcode with\n the product returned by `prepareOrder`. This check helps prevent barcode\n manipulation.\n\n7. The business partner sends the `confirmOrder` request using the order ID\n returned by `prepareOrder`.\n\n8. PaysafeCard performs another set of validation checks, including limits\n and account status. A successful response returns the order with the\n status `DELIVERED`.\n\n9. The business partner system prints a voucher containing the required\n transaction information. The voucher and the correct cash amount are\n given to the customer.\n\n10. An optional cool-down period begins. The documented default is five\n minutes. During this period, the business partner can send the\n `cancelOrder` request. A successfully cancelled order has the status\n `CANCELLED`.\n\n If the order is cancelled, the business partner system prints a\n cancellation receipt and gives it to the customer.\n\n\nErrors not listed in the catalog may be communicated as `general_technical_error`. For further information, use the appropriate PaysafeCard integration or technical support contact.\n\n## Operational reference\n\n- [PaysafeCash POS cashout API response objects](#paysafecash-pos-cashout-api-response-objects)\n- [PaysafeCash POS cashout error codes](#paysafecash-pos-cashout-error-codes)\n- [How to handle a lost response](#how-to-handle-a-lost-response)\n- [Customer limits](#customer-limits)\n- [Shop registration](#shop-registration)\n- [Reconciliation and sales reporting](#reconciliation-and-sales-reporting)\n\n### PaysafeCash POS cashout API response objects\n\nThe reusable schemas for the POS cashout operations are available in the Schemas section:\n\n- `PrepareCashoutResponse` for prepare order\n- `ConfirmCashoutOrderResponse` and `CashoutCard` for confirm order\n- `CancelCashoutOrderResponse` for cancel order\n- `RetrieveCashoutOrderResponse`, `RetrieveCashoutCard`, and `OrderStatus` for retrieve order\n\nThe response objects use the following fields where applicable:\n\n- `amount`: The order amount.\n- `currency`: The order currency.\n- `card.amount`: The face value of the card assigned to the order.\n- `card.currency`: The currency of the order in ISO 4217 format.\n- `card.serial`: The serial number of the card assigned to the order.\n- `card.product_id`: The product ID of the card assigned to the order.\n- `distributor_id`: The business partner ID assigned by PaysafeCard.\n- `order_id`: The order ID generated by the API or derived from the `Correlation-ID` header.\n- `shop_id`: The shop from which the request was made.\n- `terminal_id`: The terminal from which the request was made.\n- `order_status`: `PREPARED`, `DELIVERED`, `REJECTED`, `WITHDRAWN`, `CANCELLED`, or `EXPIRED`.\n- `delivery_type`: Always `ACCOUNT` for PaysafeCash.\n\n### PaysafeCash POS cashout error codes\n\nComing soon.\n\nNo POS-cashout-specific error-code catalog is defined in the available source.\n\n### How to handle a lost response\n\nIf the business partner does not receive a response to a prepare order or confirm order request, a lost-response mechanism must be implemented to avoid an order mismatch between the business partner system and PaysafeCard.\n\nThe recommended flow is:\n\n1. A prepare order or confirm order response is lost because of a timeout.\n2. Send cancel order.\n3. If cancel order succeeds, the order is cancelled.\n4. If cancel order does not succeed, retry cancel order three times at 30-second intervals.\n5. If the retry counter is exceeded, end the retry flow.\n\nIt is crucial to use `Correlation-ID` so cancel order can target the correct order ID.\n\n![Lost response flow](/assets/paysafecard-paysafecash/img/last_response_rest_cashouts.png)\n\n### Customer limits\n\nFully verified PaysafeCard customers with account status FDD are not affected by existing Pin-on-Demand terminal limits. A separate terminal limit applies to these customers.\n\nThe documented limit is EUR 2,500 for 12 hours, or the equivalent value in another currency. When the limit is reached, the system returns:\n\n```json\n{\n \"code\": \"fdd_terminal_limit_reached\",\n \"message\": \"FDD terminal limit reached\",\n \"number\": 3202\n}\n```\n\n### Shop registration\n\nAccurate information about where a Paysafe product sale takes place must be provided for regulatory reasons.\n\nSee [Shop registration](https://www.paysafecard.com/fileadmin/api/pin-on-demand.html#/reference/shop-registration).\n\n### Reconciliation and sales reporting\n\nPaysafeCard direct and PaysafeCash orders are included in the daily Pin-on-Demand reconciliation file. The order type can be distinguished by the ninth parameter, customer identification type, and the tenth parameter, delivery type.\n\n- Classic vouchers use customer identification type `NONE`; PaysafeCard direct and PaysafeCash use `ACCOUNT`.\n- Classic vouchers use delivery type `RETURN`; PaysafeCard direct and PaysafeCash use `ACCOUNT`.\n\nThe displayed reconciliation example contains these fields in sequence:\n\n`Distributor order id`, `UTC offset`, `Order date and time`, `Distributor id`, `Retailer id`, `Shop id`, `Terminal id`, `Customer identification type`, `Delivery type`, `Country code`, `Face value`, `Product id`, `Serial`, `Order status`, and `Error code`.\n", "type": "text/plain" } } }