{
"item": [
{
"name": "SafetyPay Payments - SOAP",
"description": "SOAP operations used to create and retrieve SafetyPay payment dispositions.",
"item": [
{
"id": "f23597ce-cf38-4b30-bc20-f58fe58e4d5c",
"name": "Create a SafetyPay Disposition",
"request": {
"name": "Create a SafetyPay Disposition",
"description": {
"content": "Creates a SafetyPay disposition for the payment option selected by the\ncustomer at merchant checkout.\n\nThe customer is redirected directly to the SafetyPay payment page.\n\nThe `dispositionRestrictions` array supports the following restriction\nkeys:\n\n- `INSTRUMENT`\n- `INSTRUMENT_SUBTYPE`\n- `BANK_IDS`\n\nPossible restriction values include:\n\n- `INSTRUMENT`: `paysafecard`, `safetypay`\n- `INSTRUMENT_SUBTYPE`: `cash`, `online`\n- `BANK_IDS`: one or more supported SafetyPay bank IDs\n\nError code `2039` indicates that the value supplied for `INSTRUMENT`\nis invalid.\n",
"type": "text/plain"
},
"url": {
"path": [
"createDisposition"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n (string)\n (number)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n \n (string)\n (string)\n (string)\n (string)\n \n \n (string)\n (string)\n \n \n (string)\n (string)\n \n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
},
"auth": null
},
"response": [
{
"id": "f6d5130e-3f0a-4afd-becf-19685a2c9f90",
"name": "SafetyPay disposition created successfully.",
"originalRequest": {
"url": {
"path": [
"createDisposition"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n (string)\n (number)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n \n (string)\n (string)\n (string)\n (string)\n \n \n (string)\n (string)\n \n \n (string)\n (string)\n \n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": "\n\n \n (string)\n (integer)\n (integer)\n \n",
"cookie": [],
"_postman_previewlanguage": "xml"
},
{
"id": "d98d09ef-0e9b-4498-a5a6-2002045c2540",
"name": "Invalid disposition restriction.",
"originalRequest": {
"url": {
"path": [
"createDisposition"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n (string)\n (number)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n \n (string)\n (string)\n (string)\n (string)\n \n \n (string)\n (string)\n \n \n (string)\n (string)\n \n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": "\n\n \n (string)\n (integer)\n (integer)\n \n",
"cookie": [],
"_postman_previewlanguage": "xml"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "a7c9bf02-8210-4308-8230-9b2653ea010b",
"name": "Get Serial Numbers",
"request": {
"name": "Get Serial Numbers",
"description": {
"content": "Retrieves payment details for a SafetyPay disposition.\n\nThe response can include the payment instrument, payment instrument\nsubtype, and the bank used for the payment.\n\nThe legacy source does not show the request payload for this operation.\nThe request schema can be added when the corresponding source content\nis available.\n",
"type": "text/plain"
},
"url": {
"path": [
"getSerialNumbers"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {},
"auth": null
},
"response": [
{
"id": "46bc8c4c-3301-420d-bd80-e2dd538c61b8",
"name": "SafetyPay disposition details retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"getSerialNumbers"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": "\n\n \n (string)\n (integer)\n (integer)\n (number)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n \n",
"cookie": [],
"_postman_previewlanguage": "xml"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "d99cabae-adf3-41a5-b215-5486732eec66",
"name": "Execute Debit",
"request": {
"name": "Execute Debit",
"description": {
"content": "Completes a SafetyPay payment after `getSerialNumbers` returns\ndisposition state `S`. Set `close` to `1` to close the transaction.\n",
"type": "text/plain"
},
"url": {
"path": [
"executeDebit"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (integer)\n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
},
"auth": null
},
"response": [
{
"id": "c11c8f81-eaf7-4735-8be6-2c22ba5d3744",
"name": "SafetyPay debit execution result.",
"originalRequest": {
"url": {
"path": [
"executeDebit"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (integer)\n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": "\n\n (string)\n (string)\n (integer)\n (integer)\n",
"cookie": [],
"_postman_previewlanguage": "xml"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
},
{
"name": "SafetyPay Payouts - SOAP",
"description": "SOAP operations used to validate, capture, and retrieve SafetyPay payouts and payout limits.",
"item": [
{
"id": "fc1ffc35-9881-4657-adae-0d8782577ed1",
"name": "Validating a Payout",
"request": {
"name": "Validating a Payout",
"description": {
"content": "Validates a SafetyPay payout without transferring funds.\n\nSet `validationOnly` to `true` to validate the payout. Upon successful\nexecution, the payout status is set to `VALIDATION_SUCCESSFUL`.\n\nThe payout transaction ID, `ptid`, must be unique even when a previous\ntransaction failed. It must also differ from any `mtid` used during a\npayment.\n",
"type": "text/plain"
},
"url": {
"path": [
"payout",
"validate"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n (string)\n (string)\n (number)\n (string)\n (string)\n (string)\n (string)\n (string)\n (boolean)\n (string)\n (string)\n \n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n \n \n (string)\n (string)\n \n (string)\n \n (string)\n (string)\n \n (string)\n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
},
"auth": null
},
"response": [
{
"id": "17e052d1-6f65-4274-b076-fb5a9f1b8a79",
"name": "Payout validation processed successfully.",
"originalRequest": {
"url": {
"path": [
"payout",
"validate"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n (string)\n (string)\n (number)\n (string)\n (string)\n (string)\n (string)\n (string)\n (boolean)\n (string)\n (string)\n \n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n \n \n (string)\n (string)\n \n (string)\n \n (string)\n (string)\n \n (string)\n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": "\n\n \n (string)\n (string)\n (number)\n (boolean)\n (integer)\n (integer)\n (string)\n \n",
"cookie": [],
"_postman_previewlanguage": "xml"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "ef8f6e7f-4b94-4ef6-b3db-0d34e1cdbaa7",
"name": "Capturing a Prevalidated Payout",
"request": {
"name": "Capturing a Prevalidated Payout",
"description": {
"content": "Captures a payout that was previously validated successfully.\n\nSet `validationOnly` to `false`. Upon successful execution, the\nSafetyPay payout status transitions to `PENDING`.\n",
"type": "text/plain"
},
"url": {
"path": [
"payout",
"capture-prevalidated"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n (string)\n (string)\n (number)\n (string)\n (string)\n (string)\n (string)\n (string)\n (boolean)\n (string)\n (string)\n \n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n \n \n (string)\n (string)\n \n (string)\n \n (string)\n (string)\n \n (string)\n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
},
"auth": null
},
"response": [
{
"id": "4ecb708c-69e5-4252-be15-33f89503a818",
"name": "Prevalidated payout captured successfully.",
"originalRequest": {
"url": {
"path": [
"payout",
"capture-prevalidated"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n (string)\n (string)\n (number)\n (string)\n (string)\n (string)\n (string)\n (string)\n (boolean)\n (string)\n (string)\n \n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n \n \n (string)\n (string)\n \n (string)\n \n (string)\n (string)\n \n (string)\n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": "\n\n \n (string)\n (string)\n (number)\n (boolean)\n (integer)\n (integer)\n (string)\n \n",
"cookie": [],
"_postman_previewlanguage": "xml"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "8f105a51-9e16-4e8e-bfdb-78b13603e773",
"name": "Capturing a Payout Without Validation",
"request": {
"name": "Capturing a Payout Without Validation",
"description": {
"content": "Captures a SafetyPay payout directly without a preceding validation\nrequest.\n\nSet `validationOnly` to `false`.\n",
"type": "text/plain"
},
"url": {
"path": [
"payout",
"capture-without-validation"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n (string)\n (string)\n (number)\n (string)\n (string)\n (string)\n (string)\n (string)\n (boolean)\n (string)\n (string)\n \n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n \n \n (string)\n (string)\n \n (string)\n \n (string)\n (string)\n \n (string)\n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
},
"auth": null
},
"response": [
{
"id": "70b341d9-3eb0-4ca3-a8fe-48b8e7ff3877",
"name": "Payout captured successfully.",
"originalRequest": {
"url": {
"path": [
"payout",
"capture-without-validation"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n (string)\n (string)\n (number)\n (string)\n (string)\n (string)\n (string)\n (string)\n (boolean)\n (string)\n (string)\n \n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n (string)\n \n \n (string)\n (string)\n \n (string)\n \n (string)\n (string)\n \n (string)\n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": "\n\n \n (string)\n (string)\n (number)\n (boolean)\n (integer)\n (integer)\n (string)\n \n",
"cookie": [],
"_postman_previewlanguage": "xml"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "8311cbe7-b2d8-4787-9ad9-2e98f5d0df6a",
"name": "Retrieve Payout Limits",
"request": {
"name": "Retrieve Payout Limits",
"description": {
"content": "Retrieves payout-limit information.\n\nThe response returns the associated MID limit information grouped by\ncurrency.\n",
"type": "text/plain"
},
"url": {
"path": [
"getPayoutState"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
},
"auth": null
},
"response": [
{
"id": "2b23c1c6-d068-4e9d-ae84-5ae07ebe4bbf",
"name": "Payout limits retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"getPayoutState"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": "\n\n \n (integer)\n (integer)\n (string)\n \n (string)\n (string)\n (number)\n (number)\n (number)\n (number)\n (number)\n (number)\n (number)\n \n \n (string)\n (string)\n (number)\n (number)\n (number)\n (number)\n (number)\n (number)\n (number)\n \n \n",
"cookie": [],
"_postman_previewlanguage": "xml"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "75c28353-71c7-42a4-b660-b7c2209a9f89",
"name": "Retrieve Payout Banks",
"request": {
"name": "Retrieve Payout Banks",
"description": {
"content": "Retrieves the list of supported payout banks for a specified country.\n",
"type": "text/plain"
},
"url": {
"path": [
"getPayoutBanks"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n (string)\n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
},
"auth": null
},
"response": [
{
"id": "311c04f2-47fc-45ad-9f72-96d00cdb9b79",
"name": "Supported payout banks retrieved successfully.",
"originalRequest": {
"url": {
"path": [
"getPayoutBanks"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/xml"
},
{
"key": "Accept",
"value": "application/xml"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "\n\n (string)\n (string)\n (string)\n",
"options": {
"raw": {
"headerFamily": "xml",
"language": "xml"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/xml"
}
],
"body": "\n\n \n (integer)\n (integer)\n (string)\n (string)\n \n (string)\n (string)\n \n \n (string)\n (string)\n \n \n",
"cookie": [],
"_postman_previewlanguage": "xml"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
]
}
],
"event": [],
"variable": [
{
"key": "baseUrl",
"value": "https://soatest.paysafecard.com/psc/services/PscService"
}
],
"info": {
"_postman_id": "224fad84-e26a-4396-b8c9-6af1e24f24cc",
"name": "SafetyPay SOPG API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"description": {
"content": "## Overview\n\nThis API reference describes the SafetyPay SOAP operations used for\npayment disposition and payout processing.\n",
"type": "text/plain"
}
}
}