GET
/
payments
/
list
curl --request GET \
  --url https://sandbox.hyperswitch.io/payments/list \
  --header 'api-key: <api-key>'
[
  {
    "size": 1,
    "data": [
      {
        "payment_id": "pay_mbabizu24mvu3mela5njyhpit4",
        "merchant_id": "merchant_1668273825",
        "status": "succeeded",
        "amount": 100,
        "net_amount": 110,
        "amount_capturable": 6540,
        "amount_received": 6540,
        "connector": "stripe",
        "client_secret": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
        "created": "2022-09-10T10:11:12Z",
        "currency": "AED",
        "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
        "description": "It's my first payment request",
        "refunds": [
          {
            "refund_id": "<string>",
            "payment_id": "<string>",
            "amount": 123,
            "currency": "<string>",
            "status": "succeeded",
            "reason": "<string>",
            "metadata": {},
            "error_message": "<string>",
            "error_code": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "connector": "stripe",
            "profile_id": "<string>",
            "merchant_connector_id": "<string>"
          }
        ],
        "disputes": [
          {
            "dispute_id": "<string>",
            "dispute_stage": "pre_dispute",
            "dispute_status": "dispute_opened",
            "connector_status": "<string>",
            "connector_dispute_id": "<string>",
            "connector_reason": "<string>",
            "connector_reason_code": "<string>",
            "challenge_required_by": "2023-11-07T05:31:56Z",
            "connector_created_at": "2023-11-07T05:31:56Z",
            "connector_updated_at": "2023-11-07T05:31:56Z",
            "created_at": "2023-11-07T05:31:56Z"
          }
        ],
        "attempts": [
          {
            "attempt_id": "<string>",
            "status": "started",
            "amount": 123,
            "currency": "AED",
            "connector": "<string>",
            "error_message": "<string>",
            "payment_method": "card",
            "connector_transaction_id": "<string>",
            "capture_method": "automatic",
            "authentication_type": "three_ds",
            "cancellation_reason": "<string>",
            "mandate_id": "<string>",
            "error_code": "<string>",
            "payment_token": "<string>",
            "connector_metadata": "<any>",
            "payment_experience": "redirect_to_url",
            "payment_method_type": "ach",
            "reference_id": "993672945374576J",
            "unified_code": "<string>",
            "unified_message": "<string>"
          }
        ],
        "captures": [
          {
            "capture_id": "<string>",
            "status": "started",
            "amount": 123,
            "currency": "AED",
            "connector": "<string>",
            "authorized_attempt_id": "<string>",
            "connector_capture_id": "<string>",
            "capture_sequence": 123,
            "error_message": "<string>",
            "error_code": "<string>",
            "error_reason": "<string>",
            "reference_id": "<string>"
          }
        ],
        "mandate_id": "mandate_iwer89rnjef349dni3",
        "mandate_data": {
          "customer_acceptance": {
            "acceptance_type": "online",
            "accepted_at": "2022-09-10T10:11:12Z",
            "online": {
              "ip_address": "123.32.25.123",
              "user_agent": "<string>"
            }
          },
          "mandate_type": {
            "single_use": {
              "amount": 6540,
              "currency": "AED",
              "start_date": "2022-09-10T00:00:00Z",
              "end_date": "2023-09-10T23:59:59Z",
              "metadata": {}
            }
          }
        },
        "setup_future_usage": "off_session",
        "off_session": true,
        "capture_on": "2022-09-10T10:11:12Z",
        "capture_method": "automatic",
        "payment_method": "ach",
        "payment_method_data": "card",
        "payment_token": "187282ab-40ef-47a9-9206-5099ba31e432",
        "shipping": {
          "address": {
            "city": "New York",
            "country": "AF",
            "line1": "123, King Street",
            "line2": "Powelson Avenue",
            "line3": "Bridgewater",
            "zip": "08807",
            "state": "New York",
            "first_name": "John",
            "last_name": "Doe"
          },
          "phone": {
            "number": "9999999999",
            "country_code": "+1"
          }
        },
        "billing": {
          "address": {
            "city": "New York",
            "country": "AF",
            "line1": "123, King Street",
            "line2": "Powelson Avenue",
            "line3": "Bridgewater",
            "zip": "08807",
            "state": "New York",
            "first_name": "John",
            "last_name": "Doe"
          },
          "phone": {
            "number": "9999999999",
            "country_code": "+1"
          }
        },
        "order_details": "[{\n        \"product_name\": \"gillete creme\",\n        \"quantity\": 15,\n        \"amount\" : 900\n    }]",
        "email": "johntest@test.com",
        "name": "John Test",
        "phone": "3141592653",
        "return_url": "https://hyperswitch.io",
        "authentication_type": "three_ds",
        "statement_descriptor_name": "Hyperswitch Router",
        "statement_descriptor_suffix": "Payment for shoes purchase",
        "next_action": {
          "redirect_to_url": "<string>",
          "type": "redirect_to_url"
        },
        "cancellation_reason": "<string>",
        "error_code": "E0001",
        "error_message": "Failed while verifying the card",
        "unified_code": "<string>",
        "unified_message": "<string>",
        "payment_experience": "redirect_to_url",
        "payment_method_type": "ach",
        "connector_label": "stripe_US_food",
        "business_country": "AF",
        "business_label": "<string>",
        "business_sub_label": "<string>",
        "allowed_payment_method_types": [
          "ach"
        ],
        "ephemeral_key": {
          "customer_id": "<string>",
          "created_at": 123,
          "expires": 123,
          "secret": "<string>"
        },
        "manual_retry_allowed": true,
        "connector_transaction_id": "993672945374576J",
        "frm_message": {
          "frm_name": "<string>",
          "frm_transaction_id": "<string>",
          "frm_transaction_type": "<string>",
          "frm_status": "<string>",
          "frm_score": 123,
          "frm_reason": "<any>",
          "frm_error": "<string>"
        },
        "metadata": {},
        "connector_metadata": {
          "apple_pay": {
            "session_token_data": {
              "certificate": "<string>",
              "certificate_keys": "<string>",
              "merchant_identifier": "<string>",
              "display_name": "<string>",
              "initiative": "<string>",
              "initiative_context": "<string>"
            }
          },
          "airwallex": {
            "payload": "<string>"
          },
          "noon": {
            "order_category": "<string>"
          }
        },
        "feature_metadata": {
          "redirect_response": {
            "param": "<string>",
            "json_payload": {}
          }
        },
        "reference_id": "993672945374576J",
        "payment_link": {
          "link": "<string>",
          "payment_link_id": "<string>"
        },
        "profile_id": "<string>",
        "surcharge_details": {
          "surcharge_amount": 123,
          "tax_amount": 123
        },
        "attempt_count": 123,
        "merchant_decision": "<string>",
        "merchant_connector_id": "<string>",
        "incremental_authorization_allowed": true,
        "authorization_count": 123,
        "incremental_authorizations": [
          {
            "authorization_id": "<string>",
            "amount": 123,
            "status": "success",
            "error_code": "<string>",
            "error_message": "<string>",
            "previously_authorized_amount": 123
          }
        ],
        "fingerprint": "<string>"
      }
    ]
  }
]

Authorizations

api-key
string
headerrequired

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.

Query Parameters

customer_id
string
required

The identifier for the customer

starting_after
string
required

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

ending_before
string
required

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

limit
integer
required

Limit on the number of objects to return

created
string
required

The time at which payment is created

created_lt
string
required

Time less than the payment created time

created_gt
string
required

Time greater than the payment created time

created_lte
string
required

Time less than or equals to the payment created time

created_gte
string
required

Time greater than or equals to the payment created time

Response

200 - application/json
size
integer
required

The number of payments included in the list

data
object[]
required