{ "item": [ { "name": "PaysafeCash Cashout - REST", "description": "REST API calls used to initiate and manage merchant cashout transactions.", "item": [ { "id": "eda33e48-9667-425d-8e43-5f92a4e6c546", "name": "Initiate Cashout", "request": { "name": "Initiate Cashout", "description": { "content": "Creates a PaysafeCash merchant cashout transaction.\n\nUpon successfully executing this request, the status of the transaction\nis `INITIATED`.\n\nThe optional `Correlation-ID` header can be used to set part of the\ngenerated cashout id.\n\nThe `customer_takeover_data` object can be used to prefill customer\ninformation in the barcode application and to supply KYC document data\nwhen KYC reliance is enabled.\n", "type": "text/plain" }, "url": { "path": [ "cashouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"customer\": {\n \"id\": \"\"\n },\n \"submerchant_id\": \"\",\n \"expiration_time_minutes\": \"\",\n \"webhook_url\": \"\",\n \"customer_takeover_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"address1\": \"\",\n \"postcode\": \"\",\n \"city\": \"\",\n \"country_iso2\": \"\",\n \"phone_number\": \"\",\n \"email\": \"\",\n \"document\": {\n \"id_number\": \"\",\n \"type\": \"\",\n \"issuing_authority\": \"\",\n \"date_of_issuance\": \"\",\n \"date_of_expiry\": \"\"\n },\n \"kyc_level\": \"\",\n \"tax_id\": \"\",\n \"place_of_birth\": \"\",\n \"ip_address\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "01704af4-e197-4d25-bfa2-487a1501666b", "name": "Cashout transaction created successfully.", "originalRequest": { "url": { "path": [ "cashouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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 \"customer\": {\n \"id\": \"\"\n },\n \"submerchant_id\": \"\",\n \"expiration_time_minutes\": \"\",\n \"webhook_url\": \"\",\n \"customer_takeover_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"address1\": \"\",\n \"postcode\": \"\",\n \"city\": \"\",\n \"country_iso2\": \"\",\n \"phone_number\": \"\",\n \"email\": \"\",\n \"document\": {\n \"id_number\": \"\",\n \"type\": \"\",\n \"issuing_authority\": \"\",\n \"date_of_issuance\": \"\",\n \"date_of_expiry\": \"\"\n },\n \"kyc_level\": \"\",\n \"tax_id\": \"\",\n \"place_of_birth\": \"\",\n \"ip_address\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"status\": \"\",\n \"expiration_timestamp\": \"\",\n \"auth_url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14dd92c9-efd0-4286-8a10-773a0864c769", "name": "Invalid cashout request.", "originalRequest": { "url": { "path": [ "cashouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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 \"customer\": {\n \"id\": \"\"\n },\n \"submerchant_id\": \"\",\n \"expiration_time_minutes\": \"\",\n \"webhook_url\": \"\",\n \"customer_takeover_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"address1\": \"\",\n \"postcode\": \"\",\n \"city\": \"\",\n \"country_iso2\": \"\",\n \"phone_number\": \"\",\n \"email\": \"\",\n \"document\": {\n \"id_number\": \"\",\n \"type\": \"\",\n \"issuing_authority\": \"\",\n \"date_of_issuance\": \"\",\n \"date_of_expiry\": \"\"\n },\n \"kyc_level\": \"\",\n \"tax_id\": \"\",\n \"place_of_birth\": \"\",\n \"ip_address\": \"\"\n }\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 \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d850ca0e-f6e8-4234-8878-c0e5229013fe", "name": "Authentication failed.", "originalRequest": { "url": { "path": [ "cashouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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 \"customer\": {\n \"id\": \"\"\n },\n \"submerchant_id\": \"\",\n \"expiration_time_minutes\": \"\",\n \"webhook_url\": \"\",\n \"customer_takeover_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"address1\": \"\",\n \"postcode\": \"\",\n \"city\": \"\",\n \"country_iso2\": \"\",\n \"phone_number\": \"\",\n \"email\": \"\",\n \"document\": {\n \"id_number\": \"\",\n \"type\": \"\",\n \"issuing_authority\": \"\",\n \"date_of_issuance\": \"\",\n \"date_of_expiry\": \"\"\n },\n \"kyc_level\": \"\",\n \"tax_id\": \"\",\n \"place_of_birth\": \"\",\n \"ip_address\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccf10a7d-a648-4bbf-8977-b49a38f8710f", "name": "Max amount exceeded.", "originalRequest": { "url": { "path": [ "cashouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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 \"customer\": {\n \"id\": \"\"\n },\n \"submerchant_id\": \"\",\n \"expiration_time_minutes\": \"\",\n \"webhook_url\": \"\",\n \"customer_takeover_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"address1\": \"\",\n \"postcode\": \"\",\n \"city\": \"\",\n \"country_iso2\": \"\",\n \"phone_number\": \"\",\n \"email\": \"\",\n \"document\": {\n \"id_number\": \"\",\n \"type\": \"\",\n \"issuing_authority\": \"\",\n \"date_of_issuance\": \"\",\n \"date_of_expiry\": \"\"\n },\n \"kyc_level\": \"\",\n \"tax_id\": \"\",\n \"place_of_birth\": \"\",\n \"ip_address\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64319826-fbc1-4ae3-8ea7-6f871de87d16", "name": "POS cashout feature disabled.", "originalRequest": { "url": { "path": [ "cashouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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 \"customer\": {\n \"id\": \"\"\n },\n \"submerchant_id\": \"\",\n \"expiration_time_minutes\": \"\",\n \"webhook_url\": \"\",\n \"customer_takeover_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"address1\": \"\",\n \"postcode\": \"\",\n \"city\": \"\",\n \"country_iso2\": \"\",\n \"phone_number\": \"\",\n \"email\": \"\",\n \"document\": {\n \"id_number\": \"\",\n \"type\": \"\",\n \"issuing_authority\": \"\",\n \"date_of_issuance\": \"\",\n \"date_of_expiry\": \"\"\n },\n \"kyc_level\": \"\",\n \"tax_id\": \"\",\n \"place_of_birth\": \"\",\n \"ip_address\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46d57be0-af34-41fb-9e66-c0834a729ee3", "name": "Retrieve Cashout", "request": { "name": "Retrieve Cashout", "description": { "content": "Retrieves the details of a PaysafeCash POS cashout transaction.\n\nIf the optional `Correlation-ID` header was used during the initiate\ncashout request, the same value can be used to retrieve the transaction\ndetails instead of the transaction id.\n", "type": "text/plain" }, "url": { "path": [ "cashouts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "46a85cc1-b190-4bf7-a003-afd037b289bf", "name": "Cashout transaction retrieved successfully.", "originalRequest": { "url": { "path": [ "cashouts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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 \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"status\": \"\",\n \"expiration_timestamp\": \"\",\n \"auth_url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e25de181-7e1e-4943-b740-317d8944554f", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "cashouts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "543dfb6f-aea8-475e-aa0b-ae7057523df0", "name": "Authentication failed.", "originalRequest": { "url": { "path": [ "cashouts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54a37a9e-d2f1-4405-9975-b25ffd5cef22", "name": "Transaction not found or POS cashout feature disabled.", "originalRequest": { "url": { "path": [ "cashouts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "49fe0c03-71bb-49b5-b9ab-85a7e47ab70b", "name": "Cancel Cashout", "request": { "name": "Cancel Cashout", "description": { "content": "Cancels a PaysafeCash POS cashout transaction with status `INITIATED`.\n\nUpon successfully executing this request, the status of the transaction\nis `CANCELED_MERCHANT`.\n\nA successful response to this request has an empty body.\n\nIf the optional `Correlation-ID` header was used during the initiate\ncashout request, the same value can be used to cancel the transaction\ninstead of the transaction id.\n", "type": "text/plain" }, "url": { "path": [ "cashouts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "3df53f75-d716-4b95-8f87-27c8d605f8fb", "name": "Cashout transaction cancelled successfully.", "originalRequest": { "url": { "path": [ "cashouts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2da62448-e9d3-4b19-8be4-91ef88201476", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "cashouts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43d95bd7-d105-4186-a57f-c55e6d5df673", "name": "Authentication failed.", "originalRequest": { "url": { "path": [ "cashouts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56bc0ed7-f2ad-4c20-b620-cff0566bc097", "name": "Transaction not found or POS cashout feature disabled.", "originalRequest": { "url": { "path": [ "cashouts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "PaysafeCash Cashout - Barcodes", "description": "REST API calls used to generate and retrieve cashout barcodes.", "item": [ { "id": "e2b6eb57-0adb-4085-b51a-c5499513c524", "name": "Generate Cashout Barcodes", "request": { "name": "Generate Cashout Barcodes", "description": { "content": "Generates a barcode for a PaysafeCash POS cashout transaction when\nbackend integration is in use.\n\nIf the optional `Correlation-ID` header was used during the initiate\ncashout request, the same value can be used to generate the barcode\ninstead of the transaction id.\n", "type": "text/plain" }, "url": { "path": [ "cashouts", ":id", "barcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"country\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "1cf2e887-355a-4564-92e6-4b878acd0064", "name": "Cashout barcodes created successfully.", "originalRequest": { "url": { "path": [ "cashouts", ":id", "barcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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 \"currency\": \"\",\n \"country\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"barcode\": \"\",\n \"visualization\": \"\",\n \"expiration_timestamp\": \"\",\n \"country\": \"\"\n },\n {\n \"barcode\": \"\",\n \"visualization\": \"\",\n \"expiration_timestamp\": \"\",\n \"country\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6626b998-a662-413b-a2db-3a3b9dc57447", "name": "Invalid barcode request.", "originalRequest": { "url": { "path": [ "cashouts", ":id", "barcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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 \"currency\": \"\",\n \"country\": \"\"\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 \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b016272-f80a-43fd-9fe5-9fb95bffdc34", "name": "Authentication failed.", "originalRequest": { "url": { "path": [ "cashouts", ":id", "barcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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 \"currency\": \"\",\n \"country\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "900c9f04-8452-46f4-95de-824a360048b8", "name": "Transaction not found or POS cashout feature disabled.", "originalRequest": { "url": { "path": [ "cashouts", ":id", "barcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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 \"currency\": \"\",\n \"country\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c681a3b-8725-44fb-a87f-85f98d9be4e8", "name": "Retrieve Cashout Barcodes", "request": { "name": "Retrieve Cashout Barcodes", "description": { "content": "Retrieves a barcode previously generated for a PaysafeCash POS cashout\ntransaction.\n\nIf the optional `Correlation-ID` header was used during the initiate\ncashout request, the same value can be used to retrieve the barcode\ninstead of the transaction id.\n", "type": "text/plain" }, "url": { "path": [ "cashouts", ":id", "barcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] } }, "response": [ { "id": "12859da8-1827-4aba-8918-0205f8a3e8e7", "name": "Cashout barcodes retrieved successfully.", "originalRequest": { "url": { "path": [ "cashouts", ":id", "barcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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 {\n \"barcode\": \"\",\n \"visualization\": \"\",\n \"expiration_timestamp\": \"\",\n \"country\": \"\"\n },\n {\n \"barcode\": \"\",\n \"visualization\": \"\",\n \"expiration_timestamp\": \"\",\n \"country\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dc594d3-5e6f-4afa-91ee-1c0a4ae0c544", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "cashouts", ":id", "barcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53c523e9-a1c7-4b28-addd-14c73ab6e036", "name": "Authentication failed.", "originalRequest": { "url": { "path": [ "cashouts", ":id", "barcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41490a01-344b-4aa7-b1d1-b43a609633d1", "name": "Transaction not found or POS cashout feature disabled.", "originalRequest": { "url": { "path": [ "cashouts", ":id", "barcodes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique cashout transaction identifier from the initiate cashout request.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional identifier that can become part of the generated cashout id.\n\nMaximum length is 41 characters. Allowed characters are `a-z`, `A-Z`,\n`0-9`, `-`, and `_`. The value must always be unique.\n", "type": "text/plain" }, "key": "Correlation-ID", "value": "IV9r9vJ_e3" }, { "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": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"number\": \"\",\n \"param\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "PaysafeCash Cashout Notifications", "description": "JSON webhook payloads sent for PaysafeCash cashout updates.", "item": [ { "id": "6486c453-38a7-4796-aee0-8499cae1f455", "name": "Cashout Webhook Notification", "request": { "name": "Cashout Webhook Notification", "description": { "content": "Sends a JSON webhook notification to the business partner endpoint\nprovided in the `webhook_url` field of the initiate cashout request as\nsoon as a transaction is successful, cancelled, or expires.\n\nThe business partner server must respond with HTTP `200`. The\nauthenticity of the webhook notification must be verified before the\ntransaction is processed.\n\nIn case of technical errors or application errors, the webhook\nnotification is resubmitted at a regular interval of one minute until\none of the following criteria is fulfilled:\n\n- The webhook notification is successfully delivered (HTTP `200`\n response from the server).\n- The maximum number of retry attempts has been reached (currently\n configured at five retries).\n", "type": "text/plain" }, "url": { "path": [ "webhooks", "paysafecash", "cashout" ], "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\": \"\",\n \"mtid\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b33cb4f0-d56b-49b1-97dc-ff3ef4d1eeb9", "name": "Cashout webhook notification received successfully.", "originalRequest": { "url": { "path": [ "webhooks", "paysafecash", "cashout" ], "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\": \"\",\n \"mtid\": \"\"\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": "932a2d27-70d6-4149-9a8a-eb03d1682148", "name": "PaysafeCash Cashout API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "## Overview\n\nThis API reference contains PaysafeCash merchant cashout REST API calls.\n\nMerchant cashout allows business partners to initiate cash withdrawal\ntransactions for customers. Customers receive a barcode and complete the\ncashout at a participating PaysafeCash point of sale.\n\nThis API is not used for distributor POS cashout flows.\n", "type": "text/plain" } } }