Get Payments

Production

https://api.simpra.app

GET

/payments

Last modified:2026-07-30 09:21:11

Scope: Global

Query Parameters

Parameter	Default	Description
status		Available statuses: `pending`, `paid`, `unpaid`
only_dealer	false	When `true` returns only dealer payments.
created_date_since		Example `2019-01-21`
created_date_until		Example `2019-01-21`

Request

Authorization

Add parameter in header

Simpra-Access-Token

Example:

Simpra-Access-Token: ********************

Query Params

Header Params

Responses

🟢200OK

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.simpra.app/payments?status=undefined&only_dealer=undefined&created_date_since=undefined&created_date_until=undefined' \
--header 'Simpra-Access-Token: <api-key>' \
--header 'Content-Type: application\json'

Response Example

{
    "payments": [
        {
            "payment_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
            "transaction_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
            "target_type": "Enterprise",
            "target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
            "plan_type": "lite",
            "amount": 99,
            "currency_code": "TRY",
            "licenses_count": 1,
            "tax_rate": 18,
            "payment_type": "Credit Card",
            "status": "Paid",
            "payment_error": null,
            "created_at": 1562918440,
            "target_invoice_attributes": {
                "email": "bigbrother@barcelona.com",
                "address": "Barcelona/Spain",
                "tax_office": "Barcelona",
                "tckn_or_vkn": "10577420736",
                "company_title": "Bigbrother"
            },
            "portal_plus_response": {
                "InvoiceNo": "SEP1023111156465",
                "InvoiceIntId": 432734,
                "ExternalTrackNo": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
                "SendInvoiceResult": null
            },
            "licenses": [
                {
                    "target_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
                    "target_name": "iPad",
                    "target_platform": "ios",
                    "property_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
                    "discount_amount": 0,
                    "original_price": 99,
                    "paid_price": 99,
                    "tax_amount": 15.1,
                    "unit_price": 83.9,
                    "created_at": 1562907640,
                    "activation_at": 1562907640,
                    "license_id": "6f6fc0e2-0839-4e2c-bcd9-dcc58be299af",
                    "key": "F5E05535",
                    "interval_count": 1,
                    "date_of_renewal": "2019-08-12",
                    "expires_at": 1586379600
                }
            ]
        }
    ]
}

Modified at 2026-07-30 09:21:11

Get Payment

Get Future Payments