public

GET `/v1/pay/partner/{token}`

A partner's domain order, for the customer paying it. Unauthenticated.

Authentication

This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/pay/partner/{token}

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

No authentication and no session. The token in the path is the whole authorisation and it reaches exactly one order that a partner placed. Returns the lines, subtotal, tax, total, currency, the payment rails on offer, the partner's display name and the two exits (cancel_url while payable, return_url once paid) — nothing about the tenancy. Labels arrive translated for locale. An unknown, malformed, expired, cancelled or used link answers the same 404 sentence; a paid link can still be read for 30 minutes.

Parameters

Name	Type	Required	What it is
`token (path)`	`string`	Yes	—
`locale (query)`	`string`	No	—

Response

Name	Type	Required	What it is
`order`	`string`	Yes	The order's human reference.
`status`	`string<payable, paid>`	Yes	—
`partner`	`string`	Yes	—
`currency`	`string`	Yes	—
`lines`	`PartnerPaymentLine[]`	Yes	—
`subtotal`	`string`	Yes	—
`tax`	`string`	Yes	—
`total`	`string`	Yes	—
`total_minor`	`integer`	Yes	—
`rails`	`string<card>[]`	Yes	—
`return_url`	`string`	Yes	Set once paid; empty otherwise.
`cancel_url`	`string`	Yes	Set while payable; empty once paid.
`labels`	`object`	Yes	—
`locale`	`string`	Yes	—
`direction`	`string<ltr, rtl>`	Yes	—

Errors this endpoint can return

404 · 429

GET /v1/pay/partner/{token}