Skip to main content

returnLinks

The URL endpoints to redirect the customer to after a redirection to an alternative payment or 3D Secure site. You can customize the return URL based on the transaction status.

relstringrequired

This is the link type that allows different endpoints to be targeted depending on the end state of the transaction.

  • on_completed - Paysafe will return to this merchant url post successful payment.

  • on_failed - Paysafe will return to this merchant url post if payment is failed.

  • on_cancelled - Paysafe will return to this merchant url post if payment is cancelled.

  • default - The default return URL that will be used if specific status return URL is not defined.

Possible values: [default, on_completed, on_failed, on_cancelled]

hrefstringrequired

This is the URI of the resource.

Example: https://US_commerce_site/payment/return/success
methodstringrequired

This is the HTTP method.

Example: GET
returnLinks
{
  "rel": "default",
  "href": "https://US_commerce_site/payment/return/success",
  "method": "GET"
}