# API reference

The calls an integration can make, grouped by product.

    {
      apiGroups.map((group) => (

##

          {specsForApiGroup(group.id).map((spec) => (

 OpenAPI

          ))}

            {group.calls.map((call) => (

-  ``
            ))}

      ))
    }

## Yoursafe ID

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

- `GET /.well-known/openid-configuration` OpenID discovery metadata. ([reference](/en/id-oidc-endpoints#discovery))
- `GET /oauth2/authorize` Start sign-in and consent. ([reference](/en/id-oidc-endpoints#authorize))
- `POST /oauth2/device_authorization` Begin the device authorization flow. ([reference](/en/id-oidc-endpoints#device-authorization))
- `PUT /oauth2/token` Exchange a code or refresh a token. ([reference](/en/id-oidc-endpoints#token))
- `GET /userinfo` Read claims for the access token. ([reference](/en/id-oidc-endpoints#userinfo))
- `POST /oauth2/introspect` Check whether a token is active. ([reference](/en/id-oidc-endpoints#introspection))
- `POST /oauth2/revoke` Revoke a token. ([reference](/en/id-oidc-endpoints#revocation))
- `GET /connect/logout` End the session. ([reference](/en/id-oidc-endpoints#end-session))
- `GET /oauth2/jwks` Signing keys for token verification. ([reference](/en/id-oidc-endpoints#jwks))

## Alias token

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

- `GET https://<aliastoken>.yoursafe.id/?json=1` Account status and screening fields as JSON. ([reference](/en/alias-token-json))

## Flowguard API

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

OpenAPI: https://integrations.yoursafe.com/openapi/flowguard-api.json

- `POST /api/merchant/purchase/start` Start Purchase ([reference](/en/flowguard-api#start-purchase))
- `POST /api/merchant/subscription/cancel` Cancel Subscription ([reference](/en/flowguard-api#cancel-subscription))
- `POST /api/merchant/subscription/start` Start Subscription ([reference](/en/flowguard-api#start-subscription))

## FlexPay

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

OpenAPI: https://integrations.yoursafe.com/openapi/flexpay-purchase.json

OpenAPI: https://integrations.yoursafe.com/openapi/flexpay-subscription.json

- `GET /startorder` Create a purchase order ([reference](/en/flexpay/purchase#purchase-create-a-purchase-order))
- `GET /status/order` Status page request ([reference](/en/flexpay/purchase#purchase-status-page-request))
- `GET /startorder` Create a subscription order ([reference](/en/flexpay/subscription#subscription-create-a-subscription-order))
- `GET /status/order` Status page request ([reference](/en/flexpay/subscription#subscription-status-page-request))
- `GET /cancel-subscription` Cancel subscription request ([reference](/en/flexpay/subscription#subscription-cancel-subscription-request))
- `GET /startorder` Upgrade subscription request ([reference](/en/flexpay/subscription#subscription-upgrade-subscription-request))

## Control Center

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

OpenAPI: https://integrations.yoursafe.com/openapi/control-center-api.json

- `GET /dashboard/announcements` Get currently valid announcements ([reference](/en/control-center-api#get-dashboard-announcements))
- `GET /dashboard/drill-down` Get sale data drilled down by different parameters ([reference](/en/control-center-api#get-dashboard-drill-down))
- `GET /dashboard/totals` Get sale totals for fixed date ranges ([reference](/en/control-center-api#get-dashboard-totals))
- `GET /sale/{id}` Get sale ([reference](/en/control-center-api#get-sale))
- `POST /sale/{id}/cancel` Cancel future billing ([reference](/en/control-center-api#cancel-billing))
- `POST /sale/{id}/downgrade` Downgrade sale ([reference](/en/control-center-api#downgrade-sale))
- `POST /sale/{id}/extend` Extend sale ([reference](/en/control-center-api#extend-sale))
- `POST /sale/{id}/terminate` Terminate sale ([reference](/en/control-center-api#terminate-sale))
- `GET /sale/{id}/transactions` Get sale transactions ([reference](/en/control-center-api#get-sale-transactions))
- `GET /transaction/{id}` Get transaction ([reference](/en/control-center-api#get-transaction))
- `POST /transaction/{id}/refund` Refund sale transaction ([reference](/en/control-center-api#refund-transaction))
- `GET /website/{id}/sales` Get website sales ([reference](/en/control-center-api#get-website-sales))
- `GET /website/{id}/transactions` Get website transactions ([reference](/en/control-center-api#get-website-transactions))
- `GET /websites` Get list of merchant websites ([reference](/en/control-center-api#get-websites))

## Mass Payments

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

OpenAPI: https://integrations.yoursafe.com/openapi/mass-payments-api.json

- `POST /mass-payment-api/upload` Upload mass payment JSON ([reference](/en/mass-payments-api#upload-mass-payment-json))
- `POST /mass-payment-api/validate` Verify mass payment JSON for upload ([reference](/en/mass-payments-api#verify-mass-payment-json-for-upload))
- `POST /mass-payment-api/create-vouchers` Voucher Creation Request ([reference](/en/mass-payments-api#voucher-creation-request))

## YOU Account Linking

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

- `GET /pairaccount` Link a creator who already has a Yoursafe account. ([reference](/en/you-account-linking))
- `GET /pairaccount/register` Register a new Yoursafe account and link it. ([reference](/en/you-account-linking#new-account))