Generate a hosted payment gateway URL for a gift card purchase.
Header Parameters
Accepted for forward compatibility but not currently enforced by the server, so a retry with the same key is processed again. Do not rely on it to prevent duplicates. Deduplicate on your side using your own order reference, and avoid refreshing or replaying payment success pages.
Media type the client can parse. Always application/json for this API.
application/jsonBody Parameters
The promotion-id from GET /getPromotionsList, not the brand-id from GET /getBrands. A brand-id returns no promotion found connection.
End-user UID. From PR
End-user display name. Used to auto-create the user if user_id is not already registered against your publisher (PR
End-user email. Used to auto-create the user if user_id is not already registered against your publisher (PR
User consent indicator.
ISO 4217 currency code.
Monetary amount in the specified currency — the face value the end-user receives.
Response
Hosted payment URL returned. Redirect the user to payment_link.
Response Attributes
Hosted payment-gateway URL. Redirect the user to this URL; they complete payment there.
Echoes the HTTP status code.
Spendstream's internal order ID, retained for reconciliation.
For publishers with a discount-type configuration (PR #355), the amount the end-user is actually charged at checkout after the applicable commission is deducted from amount. For non-discount publishers this equals amount. Emitted from PR #355 onwards.
Request failed validation. Body shape is {"message": "REASON"}; the message
distinguishes the specific failure. Most common is "no promotion found connection", which means
the promo_id is not a promotion-id in your catalogue (a brand-id is a frequent mistake).
Response Attributes
Human-readable failure reason. Safe to surface to integrators but not end-users.
Alternative error message field used by a subset of endpoints (notably getToken
and authentication failures). Integrators should check for both message and
error when parsing failure responses.
Numeric status code echoing the HTTP status (e.g. 400, 401). Populated on
most error paths; a few auth-layer failures omit it.
Authentication failed. Common causes: missing Authorization header, malformed bearer
token, token expired (tokens live 10 hours), or — on getToken itself — HMAC signature
mismatch due to clock drift or wrong secret.
Response Attributes
Human-readable failure reason. Safe to surface to integrators but not end-users.
Alternative error message field used by a subset of endpoints (notably getToken
and authentication failures). Integrators should check for both message and
error when parsing failure responses.
Numeric status code echoing the HTTP status (e.g. 400, 401). Populated on
most error paths; a few auth-layer failures omit it.
Your publisher account has an IP allow-list and the request came from an address that is not on it. The API checks the caller's IP address on every request once a list exists. Ask Spendstream to add the address, or to clear the list if you do not want the restriction. See IP allow-listing in the guide.
Response Attributes
Rate limit exceeded. The POST /getToken endpoint is rate-limited to five requests
per minute, and the limit is currently shared across all publishers; other endpoints may be throttled at the reverse-proxy layer
in response to abusive traffic. Wait and retry with exponential backoff; the
Retry-After header tells you the minimum wait in seconds.
Response Attributes
Human-readable failure reason. Safe to surface to integrators but not end-users.
Alternative error message field used by a subset of endpoints (notably getToken
and authentication failures). Integrators should check for both message and
error when parsing failure responses.
Numeric status code echoing the HTTP status (e.g. 400, 401). Populated on
most error paths; a few auth-layer failures omit it.
Response