Skip to Content
API ReferencePayment Invoices API

Payment Invoices API

Endpoints for managing payment invoices in the system.

Get Payment Invoices List

Get the complete list of payment invoices.

Request

GET /api/payment-invoices

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Query Parameters

NameTypeDescription
is_paidbooleanOptional. Filter by payment status
user_idintegerOptional. Filter by user ID
pageintegerOptional. Page number
per_pageintegerOptional. Records per page

Response

{ "payment_invoices": [ { "id": 1, "user_id": 123, "gateway": "paypal", "transaction_id": "1AB23456CD789012E", "amount": 100.00, "original_amount": 100.00, "currency_id": 1, "currency": "USD", "is_paid": true, "paid_at": "2023-01-01T01:00:00Z", "created_at": "2023-01-01T00:00:00Z" } ] }

Response Fields

FieldTypeDescription
payment_invoicesarrayArray of payment invoices
idintegerInvoice ID
user_idintegerUser ID
gatewaystringPayment gateway key
transaction_idstringTransaction ID (can be null)
amountnumberPayment amount
original_amountnumberOriginal amount (before discounts)
currency_idintegerCurrency ID
currencystringCurrency code
is_paidbooleanPayment status
paid_atstringPayment date (can be null)
created_atstringCreation date

Response Codes

CodeDescription
200Successful request
401Invalid or missing API key
403Insufficient permissions to perform request

Get Payment Invoice Data

Get detailed information about a specific payment invoice.

Request

GET /api/payment-invoices/{id}

Path Parameters

NameTypeDescription
idintegerPayment invoice ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "payment_invoice": { "id": 1, "user_id": 123, "user": { "id": 123, "name": "John Doe", "email": "[email protected]" }, "gateway": "paypal", "transaction_id": "1AB23456CD789012E", "amount": 100.00, "original_amount": 100.00, "currency_id": 1, "currency": "USD", "is_paid": true, "paid_at": "2023-01-01T01:00:00Z", "created_at": "2023-01-01T00:00:00Z" } }

Response Codes

CodeDescription
200Successful request
401Invalid or missing API key
403Insufficient permissions to perform request
404Payment invoice not found

Create Payment Invoice

Create a new payment invoice in the system.

Request

POST /api/payment-invoices

Headers

NameTypeDescription
X-API-KeystringRequired. API key
Content-TypestringRequired. application/json

Request Body

{ "user_id": 123, "gateway": "stripe", "amount": 75.50, "currency_id": 1, "promo_code": "DISCOUNT10" }

Request Body Parameters

NameTypeDescription
user_idintegerRequired. User ID
gatewaystringRequired. Payment gateway key
amountnumberRequired. Payment amount
currency_idintegerRequired. Currency ID
promo_codestringOptional. Promo code for discount

Response

{ "message": "Payment invoice created successfully", "payment_invoice": { "id": 3, "user_id": 123, "gateway": "stripe", "transaction_id": null, "amount": 67.95, "original_amount": 75.50, "currency_id": 1, "currency": "USD", "is_paid": false, "paid_at": null, "created_at": "2023-03-15T12:00:00Z" } }

Response Codes

CodeDescription
201Payment invoice successfully created
401Invalid or missing API key
403Insufficient permissions to perform request
404User, currency or promo code not found
422Invalid request parameters

Update Payment Invoice Status

Update the status of an existing payment invoice.

Request

PUT /api/payment-invoices/{id}/status

Path Parameters

NameTypeDescription
idintegerPayment invoice ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key
Content-TypestringRequired. application/json

Request Body

{ "is_paid": true, "transaction_id": "XYZ987654321" }

Request Body Parameters

NameTypeDescription
is_paidbooleanRequired. Payment status
transaction_idstringOptional. Transaction ID

Response

{ "message": "Payment invoice status updated successfully", "payment_invoice": { "id": 3, "user_id": 123, "gateway": "stripe", "transaction_id": "XYZ987654321", "amount": 67.95, "is_paid": true, "paid_at": "2023-03-15T12:30:00Z" } }

Response Codes

CodeDescription
200Invoice status successfully updated
401Invalid or missing API key
403Insufficient permissions to perform request
404Payment invoice not found
422Invalid request parameters

Delete Payment Invoice

Delete a payment invoice from the system (only for unpaid invoices).

Request

DELETE /api/payment-invoices/{id}

Path Parameters

NameTypeDescription
idintegerPayment invoice ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "message": "Payment invoice deleted successfully" }

Response Codes

CodeDescription
200Payment invoice successfully deleted
401Invalid or missing API key
403Insufficient permissions to perform request
404Payment invoice not found
422Cannot delete paid invoice