API Reference

Post V 1 Checkout Sessions

Headers

idempotency-keystringRequired

Client-generated key; a repeated key returns the original session.

Request

This endpoint expects an object.
amountintegerRequired

Amount to charge, in FJD cents (minor units).

currencyenumRequired
Always FJD in v1.
Allowed values:
successUrlstringOptionalformat: "uri"<=2048 characters

Where the hosted checkout sends the Customer after the payment succeeds. HTTPS only. Transxact appends session_id=<Checkout Session id>; confirm the outcome with GET /v1/checkout-sessions/{id} rather than trusting the redirect.

cancelUrlstringOptionalformat: "uri"<=2048 characters

Where the hosted checkout sends the Customer if they cancel or the payment doesn’t go through. HTTPS only. Transxact appends session_id=<Checkout Session id>; confirm the outcome with GET /v1/checkout-sessions/{id} rather than trusting the redirect.

metadatamap from strings to stringsOptional

Up to 20 string key/value pairs (keys ≤40 chars, values ≤500) for matching the session to your own records. Returned on retrieve and in webhooks; never shown to the Customer. Don’t put secrets or personal data here.

expiresAtintegerOptional
Unix ms timestamp, 30 minutes to 24 hours from now, after which the session can't be paid and is cancelled. Defaults to 24 hours.

Response

Checkout Session created (or replayed from the Idempotency-Key).

idstring
Checkout Session identifier.
statusenum
Current status of the Checkout Session.
Allowed values:
amountinteger

Amount to charge, in FJD cents (minor units).

currencyenum
Always FJD in v1.
Allowed values:
hostedUrlstring

Transxact-hosted URL to redirect the Customer to.

metadatamap from strings to strings

Your own key/value data from creation; empty object if none was set.

expiresAtinteger

Unix ms timestamp after which no payment can start; a still-pending session is then cancelled.

Errors

401
Unauthorized Error
409
Conflict Error