Contact
API DOCUMENTATION

Confirm your assigned profile. Draft sections and verification limits are marked.

View open points →

PAYSTAR / DEVELOPER DOCUMENTATION

API documentation

Build deposits, payouts and status checks with the right contract for your payment flow.

[01]

Your first integration

Start with the assigned profile.

Confirm the payment flow, test mode and required fields. Then create an order, keep both identifiers and follow its status.

Read the quick start
  1. 01
    Configure access

    One pipeline, its own credentials.

  2. 02
    Create an order

    A numeric amount and a unique merchant ID.

  3. 03
    Resolve the outcome

    Check status before retrying an uncertain request.

[02]

Choose your payment flow

H2H/H2C · secure.paystar.uk

P2P deposit

One request returns payment instructions and a PayStar form URL. Choose your own checkout or the hosted form.

Open guide ECOM H2H · draft

Card acquiring

Direct card collection and a possible 3DS step. The dedicated contract is under review.

Open guide H2C · init.paystar.uk

Hosted checkout

Send the customer to a hosted card-entry page. Do not collect card data yourself.

Open guide TOKEN H2H · token.paystar.uk

Tokenized deposit

Use an approved stored-card token. Customer action may still be required.

Open guide H2H · secure.paystar.uk

Payout

Create a withdrawal using the fields assigned to your payout profile.

Open guide

[03]

Find the detail you need

Status & balanceReconcile an order by either ID.Callbacks & eventsReceive updates and understand their integrity boundaries.Field & code referenceCurrencies, additional fields, banks, errors and history.OpenAPI & PostmanStatic, credential-free integration files.

[04]

Status operation shortcuts

Deposit status by merchant IDRequest, response and verification scope.Deposit status by PayStar IDRequest, response and verification scope.Payout status by merchant IDRequest, response and verification scope.Payout status by PayStar IDRequest, response and verification scope.Merchant balanceRequest, response and verification scope.
What has been verified?Review notes

The approved baseline and dated sandbox observations are shown separately. P2P has a recorded create-to-status success; other profiles have additional verification limits.

Read coverage, known differences and decisions still required →

Building an internal payment dashboard?

PayStar can provide API methods and reusable frontend components for an internal payment dashboard with the operational depth of its own interfaces.

Discuss dashboard integration with Yegor ↗

Need the required fields, currencies or limits for your pipeline?

Confirm your profile with Yegor ↗

Building an APM provider adapter? Explore Self-integration and request the current adapter interface documentation.

Discuss adapter development with Yegor ↗