GET
/
api
/
v1
/
payments
List Payments
curl --request GET \
  --url http://localhost:8080/api/v1/payments
[
  {
    "amount": "1500.00",
    "created_at": "2023-11-07T05:31:56Z",
    "currency": "<string>",
    "fail_url": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "language": "<string>",
    "satim_order_number": "<string>",
    "success_url": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "venture_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "action_code": "<string>",
    "action_code_description": "<string>",
    "description": "<string>",
    "form_url": "<string>",
    "masked_pan": "<string>",
    "order_ref": "<string>",
    "paid_at": "2023-11-07T05:31:56Z",
    "satim_error_code": "<string>",
    "satim_order_id": "<string>",
    "satim_order_status": 123
  }
]

Query Parameters

​
limit
integer<int64> | null

Maximum results (default 50, max 100).

​
offset
integer<int64> | null

Number of results to skip.

​
status
null | enum<string>

Filter by status. Lifecycle status of a payment.

Available options:
PENDING,
PAID,
FAILED,
REFUSED,
CANCELED,
REFUNDED,
EXPIRED

Response

List of payments

​
amount
string
required
Example:

"1500.00"

​
created_at
string<date-time>
required
​
currency
string
required
​
fail_url
string
required
​
id
string<uuid>
required
​
language
string
required
​
satim_order_number
string
required
​
status
enum<string>
required

Lifecycle status of a payment.

Available options:
PENDING,
PAID,
FAILED,
REFUSED,
CANCELED,
REFUNDED,
EXPIRED
​
success_url
string
required
​
updated_at
string<date-time>
required
​
venture_id
string<uuid>
required
​
action_code
string | null
​
action_code_description
string | null
​
description
string | null
​
form_url
string | null
​
masked_pan
string | null
​
order_ref
string | null
​
paid_at
string<date-time> | null
​
satim_error_code
string | null
​
satim_order_id
string | null
​
satim_order_status
integer<int32> | null