API reference

Yoursafe ID

Host accounts.yoursafe.com. The live discovery document is the source for these URLs.

• GET/.well-known/openid-configurationOpenID discovery metadata.
• GET/oauth2/authorizeStart sign-in and consent.
• POST/oauth2/device_authorizationBegin the device authorization flow.
• PUT/oauth2/tokenExchange a code or refresh a token.
• GET/userinfoRead claims for the access token.
• POST/oauth2/introspectCheck whether a token is active.
• POST/oauth2/revokeRevoke a token.
• GET/connect/logoutEnd the session.
• GET/oauth2/jwksSigning keys for token verification.

Alias token

Queried on the public alias host, not on accounts.yoursafe.com.

• GEThttps://<aliastoken>.yoursafe.id/?json=1Account status and screening fields as JSON.

Flowguard API

Start a purchase or subscription, then pass the session to the Flowguard SDK.

Yoursafe Flowguard API OpenAPI

• POST/api/merchant/purchase/startStart Purchase
• POST/api/merchant/subscription/cancelCancel Subscription
• POST/api/merchant/subscription/startStart Subscription

FlexPay

Purchase and subscription calls on the processor host, each on its own page.

FlexPay Purchase documentation OpenAPI

FlexPay Subscription documentation OpenAPI

• GET/startorderCreate a purchase order
• GET/status/orderStatus page request
• GET/startorderCreate a subscription order
• GET/status/orderStatus page request
• GET/cancel-subscriptionCancel subscription request
• GET/startorderUpgrade subscription request

Control Center

Version 2.0.0. Send HTTP basic auth and Accept: application/json; version=2.0.0.

Verotel Control Center API Documentation OpenAPI

• GET/dashboard/announcementsGet currently valid announcements
• GET/dashboard/drill-downGet sale data drilled down by different parameters
• GET/dashboard/totalsGet sale totals for fixed date ranges
• GET/sale/{id}Get sale
• POST/sale/{id}/cancelCancel future billing
• POST/sale/{id}/downgradeDowngrade sale
• POST/sale/{id}/extendExtend sale
• POST/sale/{id}/terminateTerminate sale
• GET/sale/{id}/transactionsGet sale transactions
• GET/transaction/{id}Get transaction
• POST/transaction/{id}/refundRefund sale transaction
• GET/website/{id}/salesGet website sales
• GET/website/{id}/transactionsGet website transactions
• GET/websitesGet list of merchant websites

Mass Payments

Validate and upload payout instructions, and create vouchers, on api.yoursafe.com.

Yoursafe API OpenAPI

• POST/mass-payment-api/uploadUpload mass payment JSON
• POST/mass-payment-api/validateVerify mass payment JSON for upload
• POST/mass-payment-api/create-vouchersVoucher Creation Request

YOU Account Linking

Host you.yoursafe.com. Both calls take pairingReference, platformConnectId, and signature.

• GET/pairaccountLink a creator who already has a Yoursafe account.
• GET/pairaccount/registerRegister a new Yoursafe account and link it.