Skip to main content

Return URLs

Several API methods contain return URLs as the returnSuccessUrl and returnFailedUrl parameters, whose usage depends on the provider. Both parameters have URL validation.

providerCodeType of usage
banxaAfter a completed checkout, Banxa redirects a user to the returnSuccessUrl or returnFailedUrl URL. It doesn't append anything to the URL as query parameters.
moonpayAfter a completed transaction, Moonpay redirects a user to the returnSuccessUrl or returnFailedUrl URL. It appends the transaction's ID and status to the URL as query parameters. Also, it is possible to pass deeplinks and other custom parameters.
transakAfter a completed transaction, Transak redirects a user to the returnSuccessUrl or returnFailedUrl URL. It appends additional order info to the URL as query parameters. More details about the return URLs in the official Transak documentation.