Skip to main content

ReturnLink

The return link defines the location for redirection

  • DEFAULT - The default return URL that will be used if a specific status return URL is not defined or can not be determined.

  • ON_COMPLETED - Paysafe will return to this merchant URL post succefull payment authorisation.

  • ON_FAILED - Paysafe will return to this merchant url post if the authorization failed.

  • ON_CANCELLED - Paysafe will return to this merchant url post if payment is canceled in PSP.

Not all link types are relevant for all payment methods and supported flows are PSP specific.

relReturnLinkType (string)

The link rel defines a semantic of the merchant url to redirect the payment flow.

DEFAULT - The default return URL that will be used if specific status return URL is not defined or cannot be determined. ON_COMPLETED - Paysafe will return to this merchant url post succeful payment authorisation. ON_FAILED - Paysafe will return to this merchant url post if the authorisation failed. ON_CANCELLED - Paysafe will return to this merchant url post if payment is cancelled in PSP.

Possible values: [DEFAULT, ON_COMPLETED, ON_FAILED, ON_CANCELLED]

Default value: DEFAULT
Example: DEFAULT
hrefstring

The url to be used for further actions.

Example: https://api.paysafe.com/card/redirect/372b5ee7-6360-4403-b444-164f8f1d2709
methodHttpRequestMethod (string)

HTTP request method.

Possible values: [GET, POST]

Example: GET
ReturnLink
{
  "rel": "DEFAULT",
  "href": "https://api.paysafe.com/card/redirect/372b5ee7-6360-4403-b444-164f8f1d2709",
  "method": "GET"
}