Merchants

Platforms, agencies and payment providers create merchants through the Partner API, then act for them with the Phew-Merchant header. See Platforms and agencies for the full flow.

The merchant object

{
  "id": "mer_01JD7Z4K2Q8V6N3R5T7W9Y1A3C",
  "object": "merchant",
  "status": "active",
  "legal_name": "Nordic Bikes AS",
  "organisation_number": "912345678",
  "country": "NO",
  "store_url": "https://nordicbikes.no",
  "reference": "acct_88123",
  "commission": { "partner_share": 0.25 },
  "onboarding_url": null,
  "created_at": "2026-10-20T10:03:18Z"
}

status enum

pending (waiting for the merchant to accept), in_review, active, suspended or closed.

reference string

Your own ID for the merchant. Unique within your partner account.

commission.partner_share number

Share of the merchant commission paid to you, from 0 to 1, within your partner agreement.

onboarding_url string

One-time link for the merchant to accept the terms. Present while pending; single use, expires after 7 days.

Create a merchant

POST partner-api.getphew.com/v1/merchants merchants:write

Request body

legal_name string required

Registered company name.

organisation_number string required

Company registration number in country.

country string required

ISO 3166-1 country code of the company.

store_url string required

The webshop’s URL.

contact_email string required

Where Phew sends the onboarding link and statements.

reference string

Your ID for the merchant.

commission object

partner_share, from 0 to 1. Defaults to your agreement’s default.

Retrieve a merchant

GET partner-api.getphew.com/v1/merchants/{id} merchants:write

List merchants

GET partner-api.getphew.com/v1/merchants merchants:write

Filter with status or reference; paginate with limit and starting_after.

Update a merchant

PATCH partner-api.getphew.com/v1/merchants/{id} merchants:write

You can update store_url, contact_email, reference and commission. Changes to commission take effect from the next statement period.

New onboarding link

POST partner-api.getphew.com/v1/merchants/{id}/onboarding_link merchants:write

Issues a new onboarding_url for a pending merchant and invalidates the previous one.