Actions27
- Payment Actions
- Payout Actions
- Swap Actions
- Common Actions
Payment → Generate Invoice Link
AI-generatedSummary
Generate a payment invoice link for a specified amount and currency, optionally configuring parameters like expiration time, order reference, callback and return URLs, and advanced payment settings.
Inputs
- Amount (required) — The amount for the payment. If Currency is empty, the amount is in USD. If Currency is set, the amount corresponds to the specified currency.
- Currency — Specify the currency symbol to calculate the invoice amount with a specific currency or fiat currency.
- Lifetime — Expiration time for the payment link in minutes (15 to 2280 minutes). Defaults to 60.
- Order ID — Unique order ID for referencing the payment in your system.
- Callback URL — URL to receive payment status notifications.
- Return URL — URL where the payer will be redirected after a successful payment.
- Advanced Settings — Optional settings including fee payer (payer or merchant), sandbox mode, permissible underpaid coverage, cryptocurrency conversion, auto withdrawal, mixed payment permission, payer's email, thank you message, and description of the order.
Output shape
An object containing the generated payment invoice details including the payment URL.
The output provides the full response from the OxaPay API's invoice creation endpoint, containing the generated invoice link and related payment information. Errors are returned as structured objects if operation fails.
Examples
Example 1: Generate an invoice link for $100 USD with a 60-minute expiry
Set Amount to 100 (Currency left empty), Lifetime to 60, with optional Order ID and URLs as needed.