API Contracts
Payments Payment Handle API Request
{
"merchantRefNum": "921e3a0b-e732-458d-9a7f-1df0674d840b",
"transactionType": "PAYMENT",
"accountId":"1020259990",
"profile": {
"firstName": "John",
"lastName": "Doe"
},
"rapidTransfer": {
"consumerId": "csr_fl@sun-fish.com",
"countryCode": "DE"
},
"paymentType": "RAPID_TRANSFER",
"amount": 3000,
"currencyCode": "EUR",
"customerIp": "73.82.192.17",
"billingDetails": {
"street": "71 Cherry Court ",
"city": "Southhampton",
"zip": "SO53 5PD",
"country": "GB"
},
"returnLinks": [
{
"rel": "on_completed",
"href": "http://www.amazon.ca",
"method": "GET"
},
{
"rel": "on_failed",
"href": "http://www.amazon.ca",
"method": "GET"
},
{
"rel": "default",
"href": "http://www.amazon.ca"
}
]
}
Payments Payment Handle API Response
{
"id": "1b30a38d-63e3-4dca-bfa3-8e4d0f2b7194",
"paymentType": "RAPID_TRANSFER",
"paymentHandleToken": "PHzbqsNkWR1ASPP1",
"merchantRefNum": "012182e7-2862-476b-ad1e-df7deb39ba33",
"currencyCode": "EUR",
"txnTime": "2022-05-30T06:17:25Z",
"billingDetails": {
"street": "71 Cherry Court ",
"city": "Southhampton",
"zip": "SO53 5PD",
"country": "DE"
},
"customerIp": "73.82.192.17",
"status": "INITIATED",
"links": [
{
"rel": "redirect_payment",
"href": "https://api.qa.paysafe.com/alternatepayments/v1/redirect?accountId=1020259990&paymentHandleId=1b30a38d-63e3-4dca-bfa3-
e4d0f2b7194&token=eyJhbGciOiJIUzI1NiJ9.eyJhY2QiOiIxMDIwMjU5OTkwIiwicHlkIjoiMWIzMGEzOGQtNjNlMy00ZGNhLWJmYTMtOGU0ZDBmMmI3MT
k0IiwiZXhwIjoxNjUzODkzMjQ2fQ.FuFUArvEXbnN_HamZf6l8vXil_3TVqtpNy6Vxhu4BfQ"
}
],
"liveMode": false,
"simulator": "INTERNAL",
"usage": "SINGLE_USE",
"action": "REDIRECT",
"executionMode": "SYNCHRONOUS",
"amount": 3000,
"timeToLiveSeconds": 899,
"gatewayResponse": {
"processor": "SKRILL_QCO",
"sid": "b99aff356c1542749aa3c174c6c483b0"
},
"returnLinks": [
{
"rel": "on_failed",
"href": "http://www.amazon.ca"
},
{
"rel": "default",
"href": "http://www.amazon.ca"
},
{
"rel": "on_completed",
"href": "http://www.amazon.ca"
}
],
"transactionType": "PAYMENT",
"gatewayReconciliationId": "44eb54d4-3883-41f5-a3eb-412c419804d1",
"updatedTime": "2022-05-30T06:17:26Z",
"statusTime": "2022-05-30T06:17:26Z",
"rapidTransfer": {
"consumerId": "csr_fl@sun-fish.com",
"countryCode": "IE"
},
"profile": {
"firstName": "John",
"lastName": "Doe"
}
}
Payments API Request
{
"merchantRefNum": "5bb81950-bed0-4e4a-8cce-8af39a6192c7",
"amount": 1000,
"currencyCode": "EUR",
"dupCheck": true,
"settleWithAuth": true,
"paymentHandleToken": "PHtxnH0z99GXgc0Z",
"customerIp": "172.0.0.1",
"description": "Test Paysafe"
}
Payments API Response
{
"id": "6f5202a9-ce13-4a35-a521-804c9dd3ea38",
"paymentType": "RAPID_TRANSFER",
"paymentHandleToken": "PHtxnH0z99GXgc0Z",
"merchantRefNum": "4980716b-279d-4e27-bd03-2fe2fa6b0eb5",
"currencyCode": "EUR",
"settleWithAuth": true,
"dupCheck": true,
"txnTime": "2022-05-27T09:55:43Z",
"billingDetails": {
"street1": "100 Queen",
"street2": "Unit 201",
"city": "Frankfurt",
"zip": "M5H 2N2",
"country": "DE"
},
"status": "PROCESSING",
"gatewayReconciliationId": "4c34220d-ca9c-4570-be6a-fbb8e422dddd",
"amount": 1000,
"availableToRefund": 0,
"consumerIp": "172.0.0.1",
"liveMode": false,
"simulator": "EXTERNAL",
"updatedTime": "2022-05-27T09:56:11Z",
"statusTime": "2022-05-27T09:56:11Z",
"gatewayResponse": {
"processor": "SKRILL_QCO",
"sid": "117b6aaf9a0bcff3450f5c9309f4feea"
},
"availableToSettle": 0,
"skrill": {
"consumerId": "parag.p@test.com"
},
"profile": {
"firstName": "Parag",
"lastName": "Paratkar"
},
"settlements": {
"amount": 1000,
"txnTime": "2022-05-27T09:55:43.000+0000",
"availableToRefund": 0,
"merchantRefNum": "4980716b-279d-4e27-bd03-2fe2fa6b0eb5",
"id": "6f5202a9-ce13-4a35-a521-804c9dd3ea38",
"status": "PROCESSING"
}
}
To know more about each parameter, you can visit Payments.
Standalone Credits/ Withdrawals
Standalone Credits Payment Handle API Request
{
"merchantRefNum": "14ffb4c6-a687-4edb-a712-d06a034c06e7",
"transactionType": "STANDALONE_CREDIT",
"accountId":"1020259990",
"profile": {
"firstName": "John",
"lastName": "Doe"
},
"rapidTransfer": {
"consumerId": "csr_fl@sun-fish.com",
"countryCode": "IE",
"emailMessage":"Test",
"emailSubject":"Test",
"paymentId":"ca1a0023-00e9-4f4c-b4a4-14f2b5d98ea3"
},
"paymentType": "RAPID_TRANSFER",
"amount": 30000000000,
"currencyCode": "EUR",
"customerIp": "73.82.192.17",
"billingDetails": {
"street": "71 Cherry Court ",
"city": "Southhampton",
"zip": "SO53 5PD",
"country": "GB"
},
"returnLinks": [
{
"rel": "on_completed",
"href": "http://www.amazon.ca",
"method": "GET"
},
{
"rel": "on_failed",
"href": "http://www.amazon.ca",
"method": "GET"
},
{
"rel": "default",
"href": "http://www.amazon.ca"
}
]
}
Standalone Credits Payment Handle API Response
{
"id": "f457858d-89d6-4e03-b9d4-3af8dbdcbbc6",
"paymentType": "RAPID_TRANSFER",
"paymentHandleToken": "PH9pFHcgzpdqZLQB",
"merchantRefNum": "14ffb4c6-a687-4edb-a712-d06a034c06e7",
"currencyCode": "EUR",
"txnTime": "2022-07-04T10:46:10Z",
"billingDetails": {
"street": "71 Cherry Court ",
"city": "Southhampton",
"zip": "SO53 5PD",
"country": "GB"
},
"customerIp": "73.82.192.17",
"status": "PAYABLE",
"liveMode": false,
"simulator": "EXTERNAL",
"usage": "SINGLE_USE",
"action": "NONE",
"executionMode": "SYNCHRONOUS",
"amount": 3000,
"timeToLiveSeconds": 899,
"gatewayResponse": {
"processor": "SKRILL_QCO"
},
"returnLinks": [
{
"rel": "on_completed",
"href": "http://www.amazon.ca"
},
{
"rel": "on_failed",
"href": "http://www.amazon.ca"
},
{
"rel": "default",
"href": "http://www.amazon.ca"
}
],
"transactionType": "STANDALONE_CREDIT",
"gatewayReconciliationId": "1294cc6b-a5a6-491f-9b1a-d8055ffd6b7b",
"updatedTime": "2022-07-04T10:46:10Z",
"statusTime": "2022-07-04T10:46:10Z",
"rapidTransfer": {
"consumerId": "csr_fl@sun-fish.com",
"emailSubject": "Test",
"emailMessage": "priyanshukumar0309@gmail.com",
"paymentId": "ca1a0023-00e9-4f4c-b4a4-14f2b5d98ea3"
},
"profile": {
"firstName": "John",
"lastName": "Doe"
}
}
Standalone Credits API Request
{
"merchantRefNum": "e10abc4d4be42ba19cf0",
"amount": "3000",
"currencyCode": "EUR",
"dupCheck": true,
"settleWithAuth": true,
"paymentHandleToken": "PH9pFHcgzpdqZLQB",
"customerIp": "172.0.0.1",
"description": "Magazine subscription"
}
Standalone Credits API Response
{
"id": "47279f4a-9916-434b-8a84-8f9319c275ad",
"paymentType": "RAPID_TRANSFER",
"paymentHandleToken": "PH9pFHcgzpdqZLQB",
"merchantRefNum": "e10abc4d4be42ba19cf0",
"currencyCode": "EUR",
"dupCheck": true,
"txnTime": "2022-07-04T10:48:03Z",
"billingDetails": {
"street1": "71 Cherry Court ",
"city": "Southhampton",
"zip": "SO53 5PD",
"country": "GB"
},
"customerIp": "172.0.0.1",
"status": "PENDING",
"gatewayReconciliationId": "AIAAAAIKOM",
"amount": 3000,
"returnLinks": [
{
"rel": "on_failed",
"href": "http://www.amazon.ca"
},
{
"rel": "default",
"href": "http://www.amazon.ca"
},
{
"rel": "on_completed",
"href": "http://www.amazon.ca"
}
],
"liveMode": false,
"simulator": "EXTERNAL",
"updatedTime": "2022-07-04T10:48:07Z",
"statusTime": "2022-07-04T10:48:07Z",
"gatewayResponse": {
"status_msg": "pending",
"id": "299929770",
"processor": "SKRILL_QCO",
"sid": "08cd5f7742309db7ebdc7e7a26ec3da5",
"status": "0"
},
"rapidTransfer": {
"consumerId": "csr_fl@sun-fish.com",
"emailSubject": "Test",
"emailMessage": "priyanshukumar0309@gmail.com",
"paymentId": "ca1a0023-00e9-4f4c-b4a4-14f2b5d98ea3"
},
"profile": {
"firstName": "John",
"lastName": "Doe"
}
}
Refunds
Refunds API Request
{
"merchantRefNum": "db1c255c-3081-4e04-8838-fe1ab2545445",
"amount": 2500,
"dupCheck": true
}
Refunds API Response
{
"id": "a591bf40-442b-465c-aa82-26aa3074b277",
"paymentType": "RAPID_TRANSFER",
"merchantRefNum": "db1c255c-3081-4e04-8838-fe1ab2545445113sadsdasdaasdsdsaf12dassasd211",
"currencyCode": "EUR",
"txnTime": "2022-07-04T13:18:58Z",
"status": "PENDING",
"gatewayReconciliationId": "299932090",
"amount": 10,
"updatedTime": "2022-07-04T13:18:59Z",
"statusTime": "2022-07-04T13:18:59Z",
"liveMode": false,
"simulator": "EXTERNAL",
"gatewayResponse": {
"id": "299932090",
"status": "0",
"merchant_id": "297496309",
"processor": "SKRILL_QCO"
},
"source": "SingleAPI"
}