Create A Purchase Session

The Create endpoint allows you to create a new payment request and retrieve URLs for making and monitoring payments.

If the request is associated with an agreement, the system first checks whether it can be automatically processed according to the agreement rules. If it cannot be processed automatically, a unique payment URL will be generated where the user can complete the payment manually.

In production, the minimum scheduling frequency for recurring payments is once per day. In the test environment, you can schedule as frequently as once per minute for development and testing.

Field descriptions

• name (string) — Display name for the payment request (e.g., product or service name).
• details (string) — Additional description of the payment request.
• currency (string) — Payment currency (e.g., USDC).
• recurring (boolean) — Whether the payment is recurring.
• amount (number) — Payment amount.
• metadata (object) — Arbitrary key-value pairs you provide. Returned in every webhook for both success and failure events. Example: set customerId from your system to tie all webhook events to a single customer.
• success_url (string) — Redirect URL after a successful payment.
• cancel_url (string) — Redirect URL if the customer cancels the payment.
• interval (string) — Interval unit for recurring payments (e.g., Minute, Hour, Day, Month).
• frequency (string) — Number of intervals between each recurring charge (e.g., "2" with interval: "Minute" → every 2 minutes).
• duration (string) — Number of intervals the subscription will run before ending. "0" means no fixed end.
• expires_in_hours (number) — Number of hours before the payment request expires. After expiration, no purchase requests or signature submission requests will be processed.