---
agentTools:
  projectIndex: https://apidocs.tryspeed.com/llms.txt
---

# Filter all payment links

Filter the list of payment links using this endpoint.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Production",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.tryspeed.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/payment-links/filter": {
      "get": {
        "summary": "Filter all payment links",
        "description": "Filter the list of payment links using this endpoint.",
        "operationId": "payment-link-filter",
        "parameters": [
          {
            "name": "speed-version",
            "in": "header",
            "description": "In this parameter, you can specify the version you want. As of now, there are two versions (2022-04-15 and 2022-10-15). Version 2022-10-15 supports on-chain, lightning, Ethereum, Solana and Tron payment methods. Whereas the 2022-04-15 version only supports lightning payments.",
            "schema": {
              "type": "string",
              "enum": [
                "2022-04-15",
                "2022-10-15"
              ],
              "default": "2022-04-15"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "status": {
                    "type": "array",
                    "description": "Please specify the status for which the list should be filtered.",
                    "default": [
                      "active"
                    ],
                    "items": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"has_more\": false,\n  \"object\": \"list\",\n  \"data\": [\n  {\n    \"id\": \"plink_test_lgak4lx51cW6qppo\",\n    \"object\": \"payment.link\",\n    \"livemode\": false,\n    \"status\": \"active\",\n    \"url\": \"https://buy.tryspeed.dev/plink_test_lgak4lx51cW6qppo\",\n    \"currency\": \"INR\",\n    \"amount\": 1059,\n    \"target_currency\": null,\n    \"statement_descriptor\": null,\n    \"success_url\": \"https://www.tryspeed.com\",\n    \"success_message\": \"Thank you for the payment\",\n    \"title\": \"Donation\",\n    \"title_description\": \"Joy of giving\",\n    \"title_image\": \"https://23477318.fs1na1.net/23477/x400.jpg\",\n    \"metadata\": {\n      \"key_1\": \"value_1\",\n      \"key_2\": \"value_2\"\n  },\n    \"cashback\": {\n       \"id\": \"cb_xxxxxxxxxxxxxxxxx\"\n    },\n    \"custom_fields\": [\n    {\n      \"id\": \"cf_live_xxxxxxxxxx\",\n      \"type\": \"dropdown\",\n      \"label\": \"state\",\n      \"options\": [\n        \"California\",\n        \"Texas\",\n        \"Florida\"\n      ],\n      \"is_optional\": false\n    },\n    {\n      \"id\": \"cf_live_xxxxxxxxxx\",\n      \"type\": \"number\",\n      \"label\": \"zip code\",\n      \"is_optional\": false\n    },\n    {\n      \"id\": \"cf_live_xxxxxxxxxx\",\n      \"type\": \"text\",\n      \"label\": \"Will you by our product again?\",\n      \"is_optional\": true\n    }\n  ],\n    \"created\": 1681114432505,\n    \"modified\": 1681114432505\n}\n  ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "has_more": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "object": {
                      "type": "string",
                      "example": "list"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "plink_test_lgak4lx51cW6qppo"
                          },
                          "object": {
                            "type": "string",
                            "example": "payment.link"
                          },
                          "livemode": {
                            "type": "boolean",
                            "example": false,
                            "default": true
                          },
                          "status": {
                            "type": "string",
                            "example": "active"
                          },
                          "url": {
                            "type": "string",
                            "example": "https://buy.tryspeed.dev/plink_test_lgak4lx51cW6qppo"
                          },
                          "currency": {
                            "type": "string",
                            "example": "INR"
                          },
                          "amount": {
                            "type": "integer",
                            "example": 1059,
                            "default": 0
                          },
                          "target_currency": {},
                          "statement_descriptor": {},
                          "success_url": {
                            "type": "string",
                            "example": "https://www.tryspeed.com"
                          },
                          "success_message": {
                            "type": "string",
                            "example": "Thank you for the payment"
                          },
                          "title": {
                            "type": "string",
                            "example": "Donation"
                          },
                          "title_description": {
                            "type": "string",
                            "example": "Joy of giving"
                          },
                          "title_image": {
                            "type": "string",
                            "example": "https://23477318.fs1na1.net/23477/x400.jpg"
                          },
                          "metadata": {
                            "type": "object",
                            "properties": {
                              "key_1": {
                                "type": "string",
                                "example": "value_1"
                              },
                              "key_2": {
                                "type": "string",
                                "example": "value_2"
                              }
                            }
                          },
                          "cashback": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "cb_xxxxxxxxxxxxxxxxx"
                              }
                            }
                          },
                          "custom_fields": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "string",
                                  "example": "cf_live_xxxxxxxxxx"
                                },
                                "type": {
                                  "type": "string",
                                  "example": "dropdown"
                                },
                                "label": {
                                  "type": "string",
                                  "example": "state"
                                },
                                "options": {
                                  "type": "array",
                                  "items": {
                                    "type": "string",
                                    "example": "California"
                                  }
                                },
                                "is_optional": {
                                  "type": "boolean",
                                  "example": false,
                                  "default": true
                                }
                              }
                            }
                          },
                          "created": {
                            "type": "integer",
                            "example": 1681114432505,
                            "default": 0
                          },
                          "modified": {
                            "type": "integer",
                            "example": 1681114432505,
                            "default": 0
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "62566254992a5a04f794e4de:642fd78535e40b006533a4af"
}
```