API Request and Responses
Payments 
Payments handle request
{
"merchantRefNum": "45cb7c5e-d1e0-459e-bc3b-33a4f3cbfc07",
"transactionType": "PAYMENT",
"paymentType": "PAYPAL",
"amount": 100,
"currencyCode": "USD",
"customerIp": "172.0.0.1",
"paypal": {
"consumerId": "sb-cpfxo1472281@personal.example.com",
"recipientDescription": "My store description",
"language": "US",
"shippingPreference": "NO_SHIPPING",
"consumerMessage": "My note to payer",
"orderDescription": "My order description",
"recipientType": "PAYPAL_ID",
"userAction": "COMPLETE_PURCHASE" // User attribute when you want to have ExpressCheckoutPayment to complete the payment without additional. // interaction from the buyer. Choose this flow when you know the final payment amount when you initiate the checkout flow.
},
"returnLinks": [
{
"rel": "default",
"href": "https://usgaminggamblig.com/payment/return"
}
]
}
Payments handle response
{
"id": "b1b5b853-cd32-4d3d-8149-765b45eef697",
"paymentType": "PAYPAL",
"paymentHandleToken": "PHVVynHrt9vtNMSh",
"merchantRefNum": "45cb7c5e-d1e0-459e-bc3b-33a4f3cbfc07",
"currencyCode": "USD",
"txnTime": "2023-08-08T08:21:09Z",
"customerIp": "172.0.0.1",
"status": "INITIATED",
"links": [
{
"rel": "redirect_payment",
"href": "https://api.test.paysafe.com/alternatepayments/v1/redirect?accountId=1001693410&paymentHandleId=b1b5b853-cd32-4d3d-8149-765b45eef697&token=eyJhbGciOiJIUzI1NiJ9.eyJhY2QiOiIxMDAxNjkzNDEwIiwicHlkIjoiYjFiNWI4NTMtY2QzMi00ZDNkLTgxNDktNzY1YjQ1ZWVmNjk3IiwiZXhwIjoxNjkxNDg0NjcwfQ.6Hscm7TTyb-gfArcyjaFifiCOIYZhoa0-BMIWrmpjt0"
}
],
"liveMode": false,
"simulator": "EXTERNAL",
"usage": "SINGLE_USE",
"action": "REDIRECT",
"executionMode": "SYNCHRONOUS",
"amount": 100,
"timeToLiveSeconds": 899,
"gatewayResponse": {
"payPalInvoiceId": "2ada0747-7a79-43f2-bf9b-eb3111e09b9d",
"processor": "PAYPAL",
"id": "PAYID-MTI7V5Q9ST00331N2860640Y"
},
"returnLinks": [
{
"rel": "default",
"href": "https://usgaminggamblig.com/payment/return"
}
],
"transactionType": "PAYMENT",
"gatewayReconciliationId": "2ada0747-7a79-43f2-bf9b-eb3111e09b9d",
"updatedTime": "2023-08-08T08:21:10Z",
"statusTime": "2023-08-08T08:21:10Z",
"paypal": {
"consumerId": "sb-cpfxo1472281@personal.example.com",
"consumerMessage": "My note to payer",
"recipientDescription": "My store description",
"language": "US",
"shippingPreference": "NO_SHIPPING",
"orderDescription": "My order description",
"userAction": "COMPLETE_PURCHASE"
}
}
Payments request
{
"merchantRefNum": "d51f0f66-1f7b-431e-ae66-6865fcf8abe8",
"amount": 100,
"currencyCode": "USD",
"dupCheck": true,
"settleWithAuth": true,
"paymentHandleToken": "{{paymenthandletoken}}",
"customerIp": "172.0.0.1",
"description": "Magazine subscription"
}
Payments response
{
"id": "8185cd17-525e-46f9-84f5-bad4a7707d1b",
"paymentType": "PAYPAL",
"paymentHandleToken": "PHVVynHrt9vtNMSh",
"merchantRefNum": "d51f0f66-1f7b-431e-ae66-6865fcf8abe8",
"currencyCode": "USD",
"settleWithAuth": true,
"dupCheck": true,
"txnTime": "2023-08-08T08:21:09Z",
"customerIp": "172.0.0.1",
"status": "COMPLETED",
"gatewayReconciliationId": "3eaa9966-8b3e-4843-9df9-e4a9dbd12976",
"amount": 100,
"availableToRefund": 100,
"consumerIp": "172.0.0.1",
"liveMode": false,
"simulator": "EXTERNAL",
"updatedTime": "2023-08-08T08:22:54Z",
"statusTime": "2023-08-08T08:22:54Z",
"gatewayResponse": {
"payerId": "FPBRYAHSQGY52",
"payPalSaleId": "3PP84748N9361135M",
"id": "PAYID-MTI7V5Q9ST00331N2860640Y",
"payPalInvoiceId": "2ada0747-7a79-43f2-bf9b-eb3111e09b9d",
"processor": "PAYPAL",
"profile": {
"firstName": "John",
"lastName": "Doe",
"email": "sb-cpfxo1472281@personal.example.com"
}
},
"availableToSettle": 0,
"paypal": {
"consumerId": "sb-cpfxo1472281@personal.example.com",
"consumerMessage": "My note to payer",
"recipientDescription": "My store description",
"language": "US",
"shippingPreference": "NO_SHIPPING",
"orderDescription": "My order description"
},
"settlements": {
"amount": 100,
"txnTime": "2023-08-08T08:21:09.000+0000",
"availableToRefund": 100,
"merchantRefNum": "d51f0f66-1f7b-431e-ae66-6865fcf8abe8",
"id": "8185cd17-525e-46f9-84f5-bad4a7707d1b",
"status": "COMPLETED"
}
}
Withdrawals
Payments handle request
{
"merchantRefNum": "9052adce-0da1-4123-8ae7-cf3c7b1e0781",
"transactionType": "STANDALONE_CREDIT",
"paymentType": "PAYPAL",
"amount": 101,
"currencyCode": "USD",
"customerIp": "172.0.0.1",
"paypal": {
"consumerId": "LK9HZ65GCHVSH",
"recipientDescription": "Paysafe store description for sct",
"language": "he_IL",
"shippingPreference": "SET_PROVIDED_ADDRESS",
"consumerMessage": "Paysafe consumer message for sct",
"orderDescription": "Paysafe order description for sct ",
"recipientType": "PAYPAL_ID"
},
"profile": {
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@paysafe.com"
}
}
Payments handle response
{
"id": "2fb9e758-ff32-471a-83a2-54ac7504634e",
"paymentType": "PAYPAL",
"paymentHandleToken": "PH02QaxroEWvTZsG",
"merchantRefNum": "9052adce-0da1-4123-8ae7-cf3c7b1e0781",
"currencyCode": "USD",
"txnTime": "2023-08-08T07:35:35Z",
"customerIp": "172.0.0.1",
"status": "PAYABLE",
"liveMode": false,
"simulator": "EXTERNAL",
"usage": "SINGLE_USE",
"action": "NONE",
"executionMode": "SYNCHRONOUS",
"amount": 101,
"timeToLiveSeconds": 899,
"gatewayResponse": {
"processor": "PAYPAL"
},
"transactionType": "STANDALONE_CREDIT",
"gatewayReconciliationId": "a890d728-ce7d-43e1-8dd6-b7b6da5220c5",
"updatedTime": "2023-08-08T07:35:38Z",
"statusTime": "2023-08-08T07:35:38Z",
"paypal": {
"recipientType": "PAYPAL_ID",
"consumerId": "LK9HZ65GCHVSH",
"consumerMessage": "Paysafe consumer message for sct"
},
"profile": {
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@paysafe.com"
}
}
SCT request
{
"amount": 101,
"merchantRefNum": "1691480357",
"currencyCode": "USD",
"paymentHandleToken":"{{paymenthandletoken}}",
"customerIp": "204.91.0.12",
"description": "Winning payment from Loto 649"
}
SCT response
{
"id": "354f9c5a-4ce0-49f3-be80-9e594db0c793",
"paymentType": "PAYPAL",
"paymentHandleToken": "PH02QaxroEWvTZsG",
"merchantRefNum": "1691480357",
"currencyCode": "USD",
"dupCheck": true,
"txnTime": "2023-08-08T07:39:17Z",
"customerIp": "204.91.0.12",
"status": "PROCESSING",
"amount": 101,
"liveMode": false,
"simulator": "EXTERNAL",
"updatedTime": "2023-08-08T07:39:17Z",
"statusTime": "2023-08-08T07:39:17Z",
"paypal": {
"recipientType": "PAYPAL_ID",
"consumerId": "LK9HZ65GCHVSH",
"consumerMessage": "Paysafe consumer message for sct"
},
"profile": {
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@paysafe.com"
}
}
Was this page helpful?
On this Page