Platform setup

Before you start

• A Stripe account your company operates. Not a merchant’s account.
• PayShare from the Stripe App Marketplace. No invite is required.
• A server that can store secrets and sign HTTPS requests.

No merchant is involved yet. You do this once for the whole platform.

Create the platform

1. 1

   Install PayShare on your platform’s Stripe account

   Use the Stripe account your company operates, not a merchant’s. Install on Stripe.

2. 2

   Choose “I operate a platform”

   PayShare asks how your checkout is managed the first time you open it.

3. 3

   Enter your platform name

   This is the name merchants search for when they connect. Each name can be used by one platform.

Build PayShare into your product

PayShare shows three setup steps. The first two are in your product. The third is your platform key and the signed verify request below.

1. Add PayShare to payment settings

Give each merchant a PayShare setting, per property or store, usually beside your other payment options. It needs:

• a field for the merchant’s connection code and a Connect action;
• an on and off switch for PayShare;
• a place to store the merchant’s Stripe account for that property, if you do not already have it.

Connect and the switch call PayShare from your server. See Merchant connection.

2. Add Split with others to checkout

Add the official button under Pay now in the checkout you run, once for all merchants. Render it only for properties that are connected with PayShare turned on. See Checkout.

Your platform credentials

PayShare shows your platform ID and platform key after you register. The key starts ps_conn_.

• Platform ID goes in the X-PayShare-Platform header.
• Platform key signs every request. It stays on your server.
• Merchants never see either value.

Store them securely

Send one signed verify request so PayShare knows your server is connected. The signing helper is on Merchant connection. This step ticks in PayShare when it passes.

POSThttps://app.payshare.nz/api/connector/platform/redeem

// callPayShare signs with your platform ID and key. See Merchant connection → Signing requests.
const result = await callPayShare({ action: "verify", externalPropertyId: "" });

{ "verified": true, "platformId": "your-platform" }

{ "error": { "message": "We couldn't connect PayShare. Please try again or contact PayShare support." } }

Sending it again is safe. If you generate a new key, the old one stops working immediately, so update your server and send the verify request again.

Merchant instructions (optional)

Add plain-text instructions for merchants, for example where to find your PayShare setting. Merchants see them in PayShare after choosing your platform. Up to 2,000 characters, no HTML.

Confirm setup

Select Confirm set up is done, tick both steps, and confirm. PayShare will not confirm until your server has passed the signed verify request. After this, your platform appears to merchants who choose A platform manages my checkout.

Rename or remove your platform

You can change the name merchants search for in PayShare. Deleting your platform, which asks you to type its name, disconnects every merchant, stops open connection codes working and revokes your platform key. Existing sessions and payments are not affected.

Next: Connect your first merchant →