GET
/
v2
/
payments
/
list
Payments - List
curl --request GET \
  --url https://sandbox.hyperswitch.io/v2/payments/list \
  --header 'api-key: <api-key>'
{
  "count": 1,
  "total_count": 123,
  "data": [
    {
      "id": "12345_pay_01926c58bc6e77c09e809964e72af8c8",
      "merchant_id": "merchant_1668273825",
      "profile_id": "<string>",
      "customer_id": "12345_cus_01926c58bc6e77c09e809964e72af8c8",
      "payment_method_id": "<string>",
      "status": "succeeded",
      "amount": {
        "order_amount": 6540,
        "currency": "AED",
        "shipping_cost": 123,
        "order_tax_amount": 123,
        "external_tax_calculation": "skip",
        "surcharge_calculation": "skip",
        "surcharge_amount": 123,
        "tax_on_surcharge": 123,
        "net_amount": 123,
        "amount_to_capture": 123,
        "amount_capturable": 123,
        "amount_captured": 123
      },
      "created": "2022-09-10T10:11:12Z",
      "payment_method_type": "card",
      "payment_method_subtype": "ach",
      "connector": "authipay",
      "merchant_connector_id": "<string>",
      "customer": {
        "name": "John Doe",
        "email": "johntest@test.com",
        "phone": "9123456789",
        "phone_country_code": "+1"
      },
      "merchant_reference_id": "<string>",
      "connector_payment_id": "993672945374576J",
      "connector_response_reference_id": "<string>",
      "metadata": {},
      "description": "It's my first payment request",
      "authentication_type": "three_ds",
      "capture_method": "automatic",
      "setup_future_usage": "off_session",
      "attempt_count": 123,
      "error": {
        "code": "<string>",
        "message": "<string>",
        "unified_code": "<string>",
        "unified_message": "<string>",
        "network_advice_code": "<string>",
        "network_decline_code": "<string>",
        "network_error_message": "<string>"
      },
      "cancellation_reason": "<string>",
      "order_details": "[{\n        \"product_name\": \"gillete creme\",\n        \"quantity\": 15,\n        \"amount\" : 900\n    }]",
      "return_url": "https://hyperswitch.io",
      "statement_descriptor": "Hyperswitch Router",
      "allowed_payment_method_types": [
        "ach"
      ],
      "authorization_count": 123,
      "modified_at": "2022-09-10T10:11:12Z"
    }
  ]
}

Authorizations

​
api-key
string
header
required

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Path Parameters

​
payment_id
string | null
required

The identifier for payment

​
profile_id
string | null
required

The identifier for business profile

​
customer_id
string | null
required

The identifier for customer

Required string length: 1 - 64
​
starting_after
string | null
required

A cursor for use in pagination, fetch the next list after some object

​
ending_before
string | null
required

A cursor for use in pagination, fetch the previous list before some object

​
limit
integer
default:10
required

limit on the number of objects to return

Required range: 0 <= x <= 100
​
offset
integer | null
required

The starting point within a list of objects

Required range: x >= 0
​
created
string<date-time> | null
required

The time at which payment is created

​
created.lt
string<date-time> | null
required

Time less than the payment created time

​
created.gt
string<date-time> | null
required

Time greater than the payment created time

​
created.lte
string<date-time> | null
required

Time less than or equals to the payment created time

​
created.gte
string<date-time> | null
required

Time greater than or equals to the payment created time

​
start_amount
integer | null
required

The start amount to filter list of transactions which are greater than or equal to the start amount

​
end_amount
integer | null
required

The end amount to filter list of transactions which are less than or equal to the end amount

​
connector
enum<string>[] | null
required

The connector to filter payments list

​
currency
enum<string>[] | null
required

The currency to filter payments list

​
status
enum<string>[] | null
required

The payment status to filter payments list

​
payment_method_type
enum<string>[] | null
required

The payment method type to filter payments list

​
payment_method_subtype
enum<string>[] | null
required

The payment method subtype to filter payments list

​
authentication_type
enum<string>[] | null
required

The authentication type to filter payments list

​
merchant_connector_id
string[] | null
required

The merchant connector id to filter payments list

​
order_on
enum<string>
required

The field on which the payments list should be sorted

Available options:
amount,
created
​
order_by
enum<string>
required

The order in which payments list should be sorted

Available options:
asc,
desc
​
card_network
enum<string>[] | null
required

The card networks to filter payments list

​
merchant_order_reference_id
string | null
required

The identifier for merchant order reference id

Response

200
application/json

Successfully retrieved a payment list

The response is of type object.