Actions35
- Payment Actions
- Customer Actions
- Invoice Actions
- Product Actions
- Price Actions
- Subscription Actions
- Payout Actions
- Balance Actions
Payment → Create a Payment
AI-generatedSummary
Create a payment intent in SouthPay with a specified amount and currency, optionally associating it with an order ID, and specifying URLs to redirect after success or failure.
Inputs
- Amount (required) — The payment amount as a string, e.g., '49.99'.
- Currency (required) — The currency code for the payment, selectable from supported currencies loaded dynamically (default is 'USD').
- Order ID — Optional order identifier to associate with the payment intent.
- Success URL — Optional URL to which the user is redirected upon successful payment.
- Failed URL — Optional URL to which the user is redirected if the payment fails.
Output shape
a single record
Returns the created payment intent object containing details such as payment ID and status upon successful creation.
Examples
Example 1: Create a payment intent of amount 49.99 USD linked to order '1234', with URLs to redirect after payment outcome
Set Amount to '49.99', Currency to 'USD', Order ID to '1234', Success URL and Failed URL to appropriate endpoints.