Payments - List

To list the payments

GET /payments/list

Payments - List

cURL

curl --request GET \
  --url https://sandbox.hyperswitch.io/payments/list \
  --header 'api-key: <api-key>'

import requests

url = "https://sandbox.hyperswitch.io/payments/list"

headers = {"api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'api-key': '<api-key>'}};

fetch('https://sandbox.hyperswitch.io/payments/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.hyperswitch.io/payments/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.hyperswitch.io/payments/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.hyperswitch.io/payments/list")
  .header("api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.hyperswitch.io/payments/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

[
  {
    "size": 1,
    "data": [
      {
        "payment_id": "pay_mbabizu24mvu3mela5njyhpit4",
        "merchant_id": "merchant_1668273825",
        "status": "requires_confirmation",
        "amount": 6540,
        "net_amount": 6540,
        "amount_capturable": 6540,
        "processor_merchant_id": "merchant_1689512302",
        "attempt_count": 123,
        "shipping_cost": 6540,
        "amount_received": 6540,
        "sdk_authorization": "cHJvZmlsZV9pZD1wcm9mXzEyMyxwdWJsaXNoYWJsZV9rZXk9cGtfbGl2ZV8xMjM=",
        "connector": "stripe",
        "state_metadata": {
          "total_refunded_amount": 123,
          "total_disputed_amount": 123,
          "post_capture_void": {
            "updated_at": "2023-11-07T05:31:56Z",
            "connector_reference_id": "<string>",
            "description": "<string>"
          }
        },
        "client_secret": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
        "created": "2022-09-10T10:11:12Z",
        "modified_at": "2022-09-10T10:11:12Z",
        "connector_customer_id": "cus_Rnm2pDKGyQi506",
        "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
        "customer": {
          "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
          "name": "John Doe",
          "email": "[e-mail]",
          "phone": "9123456789",
          "phone_country_code": "+1",
          "customer_document_details": {
            "document_number": "12345678911"
          }
        },
        "description": "It's my first payment request",
        "refunds": [
          {
            "refund_id": "<string>",
            "payment_id": "<string>",
            "amount": 6540,
            "currency": "<string>",
            "connector": "stripe",
            "reason": "<string>",
            "metadata": {},
            "error_message": "<string>",
            "error_code": "<string>",
            "unified_code": "<string>",
            "unified_message": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "profile_id": "<string>",
            "merchant_connector_id": "<string>",
            "split_refunds": {
              "stripe_split_refund": {
                "revert_platform_fee": true,
                "revert_transfer": true
              }
            },
            "issuer_error_code": "<string>",
            "issuer_error_message": "<string>",
            "raw_connector_response": "<string>",
            "connector_refund_id": "<string>"
          }
        ],
        "disputes": [
          {
            "dispute_id": "<string>",
            "amount": "<string>",
            "connector_status": "<string>",
            "connector_dispute_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "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"
          }
        ],
        "attempts": [
          {
            "attempt_id": "<string>",
            "amount": 6540,
            "created_at": "2022-09-10T10:11:12Z",
            "modified_at": "2022-09-10T10:11:12Z",
            "order_tax_amount": 6540,
            "connector": "<string>",
            "error_message": "<string>",
            "connector_transaction_id": "<string>",
            "authentication_type": "three_ds",
            "cancellation_reason": "<string>",
            "mandate_id": "<string>",
            "error_code": "<string>",
            "payment_token": "<string>",
            "connector_metadata": "<unknown>",
            "reference_id": "993672945374576J",
            "unified_code": "<string>",
            "unified_message": "<string>",
            "client_source": "<string>",
            "client_version": "<string>",
            "error_details": {
              "unified_details": {
                "message": "<string>",
                "description": "<string>",
                "user_guidance_message": "<string>"
              },
              "issuer_details": {
                "code": "<string>",
                "message": "<string>",
                "network_details": {
                  "advice_code": "<string>",
                  "advice_message": "<string>"
                }
              },
              "connector_details": {
                "code": "<string>",
                "message": "<string>",
                "reason": "<string>"
              }
            }
          }
        ],
        "captures": [
          {
            "capture_id": "<string>",
            "amount": 6540,
            "connector": "<string>",
            "authorized_attempt_id": "<string>",
            "capture_sequence": 123,
            "connector_capture_id": "<string>",
            "error_message": "<string>",
            "error_code": "<string>",
            "error_reason": "<string>",
            "reference_id": "<string>"
          }
        ],
        "mandate_id": "mandate_iwer89rnjef349dni3",
        "mandate_data": {
          "update_mandate_id": "<string>",
          "customer_acceptance": {
            "accepted_at": "2022-09-10T10:11:12Z",
            "online": {
              "ip_address": "123.32.25.123",
              "user_agent": "<string>"
            }
          },
          "mandate_type": {
            "single_use": {
              "amount": 6540,
              "start_date": "2022-09-10T00:00:00Z",
              "end_date": "2023-09-10T23:59:59Z",
              "metadata": {}
            }
          }
        },
        "off_session": true,
        "capture_on": "2022-09-10T10:11:12Z",
        "payment_method_data": {
          "card": {
            "last4": "<string>",
            "card_type": "<string>",
            "card_issuer": "<string>",
            "card_issuing_country": "<string>",
            "card_isin": "<string>",
            "card_extended_bin": "<string>",
            "card_exp_month": "<string>",
            "card_exp_year": "<string>",
            "card_holder_name": "<string>",
            "payment_checks": null,
            "authentication_data": null,
            "auth_code": "<string>"
          },
          "billing": {
            "address": {
              "city": "New York",
              "line1": "123, King Street",
              "line2": "Powelson Avenue",
              "line3": "Bridgewater",
              "zip": "08807",
              "state": "New York",
              "first_name": "John",
              "last_name": "Doe",
              "origin_zip": "08807"
            },
            "phone": {
              "number": "9123456789",
              "country_code": "+1"
            },
            "email": "<string>"
          }
        },
        "payment_token": "187282ab-40ef-47a9-9206-5099ba31e432",
        "shipping": {
          "address": {
            "city": "New York",
            "line1": "123, King Street",
            "line2": "Powelson Avenue",
            "line3": "Bridgewater",
            "zip": "08807",
            "state": "New York",
            "first_name": "John",
            "last_name": "Doe",
            "origin_zip": "08807"
          },
          "phone": {
            "number": "9123456789",
            "country_code": "+1"
          },
          "email": "<string>"
        },
        "billing": {
          "address": {
            "city": "New York",
            "line1": "123, King Street",
            "line2": "Powelson Avenue",
            "line3": "Bridgewater",
            "zip": "08807",
            "state": "New York",
            "first_name": "John",
            "last_name": "Doe",
            "origin_zip": "08807"
          },
          "phone": {
            "number": "9123456789",
            "country_code": "+1"
          },
          "email": "<string>"
        },
        "order_details": "[{\n        \"product_name\": \"gillete creme\",\n        \"quantity\": 15,\n        \"amount\" : 900\n    }]",
        "email": "[e-mail]",
        "name": "John Test",
        "phone": "9123456789",
        "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>",
        "error_details": {
          "unified_details": {
            "message": "<string>",
            "description": "<string>",
            "user_guidance_message": "<string>"
          },
          "issuer_details": {
            "code": "<string>",
            "message": "<string>",
            "network_details": {
              "advice_code": "<string>",
              "advice_message": "<string>"
            }
          },
          "connector_details": {
            "code": "<string>",
            "message": "<string>",
            "reason": "<string>"
          }
        },
        "connector_label": "stripe_US_food",
        "business_label": "<string>",
        "business_sub_label": "<string>",
        "allowed_payment_method_types": [],
        "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": null,
          "frm_error": "<string>"
        },
        "metadata": {},
        "connector_metadata": {
          "apple_pay": {
            "session_token_data": {
              "payment_processing_certificate": "<string>",
              "payment_processing_certificate_key": "<string>",
              "payment_processing_details_at": "Hyperswitch",
              "certificate": "<string>",
              "certificate_keys": "<string>",
              "merchant_identifier": "<string>",
              "display_name": "<string>",
              "initiative_context": "<string>"
            }
          },
          "airwallex": {
            "payload": "<string>"
          },
          "noon": {
            "order_category": "<string>"
          },
          "braintree": {
            "merchant_account_id": "<string>",
            "merchant_config_currency": "<string>"
          },
          "adyen": {
            "testing": {
              "holder_name": "<string>"
            }
          },
          "peachpayments": {
            "rrn": "<string>"
          },
          "santander": {
            "boleto": {
              "discount_rules": {
                "tiers": [
                  {
                    "amount": "5.50",
                    "end_date": "2027-12-31"
                  }
                ]
              },
              "penalties": {
                "fixed_penalty": {
                  "value": "2.00",
                  "grace_period_days": 1
                },
                "interest": {
                  "interest_percentage": "5.00",
                  "iof_percentage": "32.45325"
                }
              },
              "collection_actions": {
                "legal_protest": {
                  "days_after_due_date": 30
                },
                "auto_write_off_days": 60
              },
              "payment_constraints": {
                "type": "fixed_amount"
              },
              "beneficiary": {
                "name": "João da Silva",
                "document_number": "9615865832"
              }
            }
          }
        },
        "connector_response_metadata": {
          "santander": {
            "end_to_end_id": "<string>"
          }
        },
        "feature_metadata": {
          "redirect_response": {
            "param": "<string>",
            "json_payload": {}
          },
          "search_tags": [
            "<string>"
          ],
          "apple_pay_recurring_details": {
            "payment_description": "<string>",
            "regular_billing": {
              "label": "<string>",
              "recurring_payment_start_date": "2023-09-10T23:59:59Z",
              "recurring_payment_end_date": "2023-09-10T23:59:59Z",
              "recurring_payment_interval_count": 123
            },
            "management_url": "https://hyperswitch.io",
            "billing_agreement": "<string>"
          },
          "pix_additional_details": {
            "immediate": {
              "time": 1,
              "pix_key": {
                "type": "cpf",
                "value": "<string>"
              }
            }
          },
          "boleto_additional_details": {
            "due_date": "2026-12-31",
            "covenant_code": "3568253",
            "pix_key": {
              "type": "cpf",
              "value": "<string>"
            },
            "discount_rules": {
              "tiers": [
                {
                  "amount": "5.50",
                  "end_date": "2027-12-31"
                }
              ]
            },
            "penalties": {
              "fixed_penalty": {
                "value": "2.00",
                "grace_period_days": 1
              },
              "interest": {
                "interest_percentage": "5.00",
                "iof_percentage": "32.45325"
              }
            },
            "collection_actions": {
              "legal_protest": {
                "days_after_due_date": 30
              },
              "auto_write_off_days": 60
            },
            "payment_constraints": {
              "type": "fixed_amount"
            },
            "beneficiary": {
              "name": "João da Silva",
              "document_number": "9615865832"
            }
          },
          "pix_automatico_additional_details": {
            "time": 3600,
            "type": "pix_automatico_push",
            "retry_policy": true,
            "mandate_details": {
              "fixed_recurring_amount": 6540,
              "min_recurring_amount": 6540,
              "start_date": "2026-12-31",
              "end_date": "2026-12-31"
            }
          },
          "finix_additional_details": {
            "fraud_session_id": "1234567890abcdef"
          }
        },
        "reference_id": "993672945374576J",
        "payment_link": {
          "link": "<string>",
          "payment_link_id": "<string>",
          "secure_link": "<string>"
        },
        "profile_id": "<string>",
        "surcharge_details": {
          "surcharge_amount": 6540,
          "tax_amount": 123
        },
        "merchant_decision": "<string>",
        "merchant_connector_id": "<string>",
        "incremental_authorization_allowed": true,
        "authorization_count": 123,
        "incremental_authorizations": [
          {
            "authorization_id": "<string>",
            "amount": 6540,
            "previously_authorized_amount": 123,
            "error_code": "<string>",
            "error_message": "<string>"
          }
        ],
        "external_authentication_details": {
          "electronic_commerce_indicator": "<string>",
          "ds_transaction_id": "<string>",
          "version": "<string>",
          "error_code": "<string>",
          "error_message": "<string>"
        },
        "external_3ds_authentication_attempted": true,
        "expires_on": "2022-09-10T10:11:12Z",
        "fingerprint": "<string>",
        "browser_info": {
          "color_depth": 1,
          "java_enabled": true,
          "java_script_enabled": true,
          "language": "<string>",
          "screen_height": 1,
          "screen_width": 1,
          "time_zone": 123,
          "ip_address": "<string>",
          "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
          "user_agent": "<string>",
          "os_type": "<string>",
          "os_version": "<string>",
          "device_model": "<string>",
          "accept_language": "<string>",
          "referer": "<string>"
        },
        "payment_channel": "ecommerce",
        "payment_method_id": "<string>",
        "network_transaction_id": "<string>",
        "network_transaction_link_id": "<string>",
        "updated": "2022-09-10T10:11:12Z",
        "split_payments": {
          "stripe_split_payment": {
            "charge_type": {},
            "application_fees": 6540,
            "transfer_account_id": "<string>",
            "charge_id": "<string>",
            "on_behalf_of": "acct_1234567890"
          }
        },
        "frm_metadata": {},
        "extended_authorization_applied": true,
        "extended_authorization_last_applied_at": "2022-09-10T10:11:12Z",
        "request_extended_authorization": false,
        "capture_before": "2023-11-07T05:31:56Z",
        "merchant_order_reference_id": "Custom_Order_id_123",
        "order_tax_amount": 123,
        "connector_mandate_id": "<string>",
        "force_3ds_challenge": true,
        "force_3ds_challenge_trigger": true,
        "issuer_error_code": "<string>",
        "issuer_error_message": "<string>",
        "is_iframe_redirection_enabled": true,
        "whole_connector_response": "<string>",
        "enable_partial_authorization": false,
        "enable_overcapture": true,
        "is_overcapture_enabled": true,
        "network_details": {
          "network_advice_code": "<string>"
        },
        "is_stored_credential": true,
        "billing_descriptor": {
          "name": "The Online Retailer",
          "city": "San Francisco",
          "phone": "9123456789",
          "statement_descriptor": "<string>",
          "statement_descriptor_suffix": "<string>",
          "reference": "<string>"
        },
        "partner_merchant_identifier_details": {
          "partner_details": {
            "name": "<string>",
            "version": "1.0.0",
            "integrator": "<string>"
          },
          "merchant_details": {
            "name": "<string>",
            "version": "<string>"
          }
        },
        "payment_method_tokenization_details": {
          "payment_method_id": "<string>",
          "psp_tokenization": true,
          "network_tokenization": true,
          "is_eligible_for_mit_payment": true,
          "network_transaction_id": "<string>",
          "network_transaction_link_id": "<string>"
        },
        "installment_options": [
          {
            "installments": [
              {
                "number_of_installments": "<string>",
                "billing_frequency": "month",
                "interest_rate": 123
              }
            ]
          }
        ],
        "installment_data": {
          "number_of_installments": 1,
          "billing_frequency": "month",
          "installment_interest": 123
        },
        "sender_payment_instrument_id": "<string>"
      }
    ]
  }
]

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.

Query Parameters

customer_id · string | null

The identifier for the customer

starting_after · string | null

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

ending_before · string | null

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

limit · integer<int64> | null

Limit on the number of objects to return

created · string<date-time> | null

The time at which payment is created

created_lt · string<date-time> | null

Time less than the payment created time

created_gt · string<date-time> | null

Time greater than the payment created time

created_lte · string<date-time> | null

Time less than or equals to the payment created time

created_gte · string<date-time> | null

Time greater than or equals to the payment created time

Response

200

application/json

Successfully retrieved a payment list

size · integer · required

The number of payments included in the list

Required range: x >= 0

data · object[] · required

Show child attributes