Webhooks
Payment Requests
Payment Handle Payable
Condition for Webhook Trigger: Triggered when first time customer Venmo QR code is scanned or an existing customer.
Webhook Response
{
"payload":
{
"accountId":"1005731030",
"id":"33e82d3b-9706-4495-80b1-a387fcfcbbae",
"merchantRefNum":"hhj90097k99oo29",
"paymentHandleToken":"PHu44cSJ0fLdkGXR",
"transactionType":"PAYMENT",
"amount":500,
"currencyCode":"USD",
"status":"PAYABLE",
"paymentType":"VENMO",
"billingDetails":{"zip":"05713570","country":"US"},
"statusTime":"2022-06-27T17:52:05Z",
"updatedTime":"2022-06-27T17:52:05Z",
"customerIp":"10.195.188.95",
"profile":
{
"firstName":"John",
"lastName":"Deo"
},
"txnTime":"2022-06-27T17:50:16Z"
},
"eventType":"PAYMENT_HANDLE_PAYABLE",
"attemptNumber":"1",
"resourceId":"33e82d3b-9706-4495-80b1-a387fcfcbbae",
"eventDate":"2022-06-27T17:50:16Z",
"links":[{"href":"https://api.dev.paysafe.com/alternatepayments/v1/accounts/1005731030/paymenthandles/33e82d3b-9706-4495-80b1-a387fcfcbbae","rel":"payment_handle"}],
"mode":"live",
"eventName":"PAYMENT_HANDLE_PAYABLE"
}
API Response
{
"id": "33e82d3b-9706-4495-80b1-a387fcfcbbae",
"paymentType": "VENMO",
"paymentHandleToken": "PHu44cSJ0fLdkGXR",
"merchantRefNum": "hhj90097k99oo29",
"currencyCode": "USD",
"txnTime": "2022-06-27T17:50:16Z",
"billingDetails": {
"zip": "05713570",
"country": "US"
},
"customerIp": "10.195.188.95",
"status": "PAYABLE",
"links": [
{
"rel": "redirect_payment",
"href": "https://api.dev.paysafe.com/alternatepayments/v1/redirect?accountId=1005731030&paymentHandleId=33e82d3b-9706-4495-80b1-a387fcfcbbae&token=eyJhbGciOiJIUzI1NiJ9.eyJhY2QiOiIxMDA1NzMxMDMwIiwicHlkIjoiMzNlODJkM2ItOTcwNi00NDk1LTgwYjEtYTM4N2ZjZmNiYmFlIiwiZXhwIjoxNjU2MzU0MDE2fQ.DwQoeUGzJfCXcEJd6ahjRODc3FDPTrqeqhtlvXJV6Mw"
}
],
"liveMode": false,
"usage": "SINGLE_USE",
"action": "REDIRECT",
"executionMode": "SYNCHRONOUS",
"amount": 500,
"timeToLiveSeconds": 438,
"gatewayResponse": {
"brainTreeCustomerId": "251887807",
"profile": {
"email": "hemanthchoppala@gmail.com",
"firstName": "Hemanth",
"lastName": "Choppala"
},
"userName": "@HemanthChoppala",
"processor": "BRAINTREE"
},
"returnLinks": [
{
"rel": "default",
"href": "http://www.amazon.ca"
},
{
"rel": "on_failed",
"href": "http://www.costco.ca"
},
{
"rel": "on_completed",
"href": "http://www.paysafe.com"
},
{
"rel": "on_error",
"href": "http://www.google.ca"
},
{
"rel": "on_cancelled",
"href": "http://www.bestbuy.ca"
}
],
"transactionType": "PAYMENT",
"updatedTime": "2022-06-27T17:52:05Z",
"statusTime": "2022-06-27T17:52:05Z",
"profile": {
"firstName": "John",
"lastName": "Deo"
},
"venmo": {
"consumerId": "customer12320"
}
}
Payment Handle Expired
Status: Y
Condition for Webhook Trigger: Triggered when the get request to check the status of PHID was used.
Standalone Credit Requests
Standalone Credit Completed
Condition for Webhook Trigger: Triggered when SCT is completed.
Webhook Response
{
"payload":
{
"accountId":"1020543340",
"id":"b885e54c-0d6e-452d-9a6a-98546e672113",
"merchantRefNum":"1658413227",
"paymentHandleToken":"PHZjkj2IAiHlDXP9",
"transactionType":"STANDALONE_CREDIT",
"amount":888,"currencyCode":"USD",
"status":"COMPLETED",
"paymentType":"VENMO",
"statusTime":"2022-07-21T14:29:36Z",
"updatedTime":"2022-07-21T14:29:36Z",
"customerIp":"10.195.189.182",
"txnTime":"2022-07-21T14:20:27Z"
},
"eventType":"PAYMENT_HANDLE_COMPLETED",
"attemptNumber":"1",
"resourceId":"b885e54c-0d6e-452d-9a6a-98546e672113",
"eventDate":"2022-07-21T14:20:27Z",
"links":[{"href":"https://api.qa.paysafe.com/alternatepayments/v1/accounts/1020543340/paymenthandles/b885e54c-0d6e-452d-9a6a-98546e672113","rel":"payment_handle"}],
"mode":"live",
"eventName":"PAYMENT_HANDLE_COMPLETED"
}
API Response
{
"id":"b885e54c-0d6e-452d-9a6a-98546e672113",
"paymentType":"VENMO",
"paymentHandleToken":"PHZjkj2IAiHlDXP9",
"merchantRefNum":"1658413227",
"currencyCode":"USD",
"txnTime":"2022-07-21T14:20:27Z",
"billingDetails":{"street":"jackpot team","city":"Atlanta","zip":"30339","state":"Georgia","country":"US"},
"customerIp":"10.195.189.182",
"status":"COMPLETED",
"liveMode":false,
"usage":"SINGLE_USE",
"action":"NONE",
"executionMode":"SYNCHRONOUS",
"amount":888,"timeToLiveSeconds":0,"gatewayResponse":{"processor":"PAYPAL"},
"returnLinks":[{"rel":"on_cancelled","href":"http://www.google.ca"},{"rel":"default","href":"http://www.amazon.ca"}],
"transactionType":"STANDALONE_CREDIT",
"gatewayReconciliationId":"5017fdd8-f825-4077-a431-a09fc44a582b",
"updatedTime":"2022-07-21T14:29:36Z",
"statusTime":"2022-07-21T14:29:36Z",
"profile":
{
"firstName":"jackpot",
"lastName":"team",
"email":"jackpotteam1234@gmail.com",
"dateOfBirth":{"day":14,"month":12,"year":1992},"phone":"1234567890"},
"venmo":
{
"recipientType":"USER_ID",
"consumerId":"jackpot-team777",
"consumerMessage":"My note to payer"
}
}
Standalone Credit Failed
Condition for Webhook Trigger: Triggered when SCT Payment Handle call is made without Payment.
Webhook Response
{
"payload":
{
"accountId":"1020543340",
"id":"1c954717-85ec-4b8e-b6f4-e0af6c570ade",
"merchantRefNum":"ed8f9565-7ede-46ed-bc15-7712aeb6df6f",
"transactionType":"PAYMENT",
"amount":10000,
"currencyCode":"USD",
"status":"ERROR",
"paymentType":"VENMO",
"statusTime":"2022-07-21T12:48:32Z",
"updatedTime":"2022-07-21T12:48:32Z",
"customerIp":"10.195.189.159",
"txnTime":"2022-07-21T12:48:32Z",
"error":{
"code":"5068",
"message":"Field error(s)",
"details":["Either you submitted a request that is missing a mandatory field or the value of a field does not match the format expected."]
}
},
"eventType":"PAYMENT_HANDLE_ERRORED",
"attemptNumber":"1",
"resourceId":"1c954717-85ec-4b8e-b6f4-e0af6c570ade",
"eventDate":"2022-07-21T12:48:32Z",
"links":[{"href":"https://api.qa.paysafe.com/alternatepayments/v1/accounts/1020543340/paymenthandles/1c954717-85ec-4b8e-b6f4-e0af6c570ade","rel":"payment_handle"}],
"mode":"live",
"eventName":"PAYMENT_HANDLE_ERRORED"
}
Standalone Credit Errored
Condition for Webhook Trigger: Triggered when SCT failing with batch job.
Webhook Response
{
"payload":
{
"accountId":"1020543340",
"id":"02093285-e57f-4582-8df7-42952f439d03",
"merchantRefNum":"dbcd23d4e17af96ee971",
"paymentHandleToken":"PHTVDbf3nqYnAqk9",
"amount":777,
"currencyCode":"USD",
"status":"ERROR",
"paymentType":"VENMO",
"txnTime":"2022-07-21T11:57:20Z",
"error":
{
"code":"5283",
"message":"Payment Handle is invalid",
"details":["The requested operation can only be executed on a Payment Handle with status PAYABLE."]
},
"statusTime":"2022-07-21T11:57:20Z","updatedTime":"2022-07-21T11:57:20Z"
},
"eventType":"SA_CREDIT_ERRORED",
"attemptNumber":"1",
"resourceId":"02093285-e57f-4582-8df7-42952f439d03",
"eventDate":"2022-07-21T11:57:20Z",
"links":[{"href":"https://api.qa.paysafe.com/alternatepayments/v1/accounts/1020543340/standalonecredits/02093285-e57f-4582-8df7-42952f439d03","rel":"standalone_credit"}],
"mode":"live",
"eventName":"SA_CREDIT_ERRORED"
}
Was this page helpful?
On this Page