Actions27
- Payment Actions
- Payout Actions
- Swap Actions
- Common Actions
Payment → Custom Payment API Call
AI-generatedSummary
Make an arbitrary authorized HTTP GET or POST call to the OxaPay Payment API with user-specified endpoint, query parameters, and JSON body to perform custom payment-related requests.
Inputs
- HTTP Method (required) — Select the HTTP method to use for the API call, either GET or POST.
- Endpoint (Path Only) (required) — Specify the payment API endpoint path, excluding the /payment prefix, e.g., /invoice.
- Query Parameters — If using GET, provide optional query parameters as a JSON object to include in the request URL.
- Body (JSON) — If using POST, provide an optional JSON body to include in the request payload.
Output shape
a single JSON object containing the response from the OxaPay Payment API for the custom call
The operation prefixes the endpoint with /payment and uses authentication with the merchant API key. Query parameters and bodies are sanitized to exclude null or empty values. Errors include detailed messages when available and expose HTTP status codes.
Examples
Example 1: Retrieve a list of invoices using a custom GET call
Set HTTP Method to GET, Endpoint to /invoice, and optionally add query parameters as JSON to filter invoices.
Example 2: Create a custom payment invoice with a custom POST call
Set HTTP Method to POST, Endpoint to /invoice, and provide the invoice details in the Body as JSON.