Payer return URL

Set a payer return URL once on your business. After a local-rails collection, customers are sent there. If you leave it empty, they see Axra’s payment confirmation page.

Set it

Dashboard: Settings → Payer return URL. API:

curl -X PUT https://api.useaxra.com/api/v1/business/config \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "returnUrl": "https://pay.yourdomain.com/done"
  }'

The URL must be https on your verified business website domain (the registrable domain of your KYB website). Subdomains of that domain are allowed. Send "returnUrl": null to clear it. GET /v1/business/config returns returnUrl and verifiedDomain.

Collections `successUrl` is ignored

POST /v1/business/collections still accepts successUrl, but the field is deprecated and ignored. The payer is returned to the business return URL, or to Axra’s confirmation page if none is configured.

Card 3DS `returnUrl` still works

Server-to-server card charges (POST /v1/business/payment/charge) still honour per-request returnUrl as the payer’s destination after 3DS. After the challenge the payer returns via Axra’s page; we append 3ds=complete or 3ds=failed and paymentId. That URL is never shared with the card processor.

Checkout sessions are unchanged

CheckoutSession.successUrl and cancelUrl still work. They are not gated by this setting.

Errors

Code	Meaning
`RETURN_URL_INVALID`	Not an https URL (or it has credentials, a fragment, an IP, or localhost).
`RETURN_URL_DOMAIN_MISMATCH`	Host is not on your verified KYB domain.
`RETURN_URL_DOMAIN_UNVERIFIED`	No verified business website is on file.

Payments

Treasury

Webhooks

SDKs

Payer return URL

Set it

Collections `successUrl` is ignored

Card 3DS `returnUrl` still works

Checkout sessions are unchanged

Errors

​Set it

​Collections successUrl is ignored

​Card 3DS returnUrl still works

​Checkout sessions are unchanged

​Errors

Set it

Collections `successUrl` is ignored

Card 3DS `returnUrl` still works

Checkout sessions are unchanged

Errors