> ## Documentation Index > Fetch the complete documentation index at: https://docs.payaza.africa/llms.txt > Use this file to discover all available pages before exploring further. # Fetch Payment Links > It retrieves the list of payment links that have been created. ## OpenAPI ````yaml /openapi.json get /payment-link/merchant/fetch-payment-links?search=&page=3&size=10 openapi: 3.0.1 info: title: Payaza Documentation version: 2.0.0 description: >- API reference for processing payments using Card, Bank Transfer, USSD, and QR Code methods. servers: - url: https://api.payaza.africa/live security: - ApiKeyAuth: [] - TenantID: [] - ProductID: [] tags: - name: Transfers description: >- Transfers are transactions made from your Payaza account to beneficiaries. Merchants can instantly transfer funds from their available balance. For every transfer, you need to specify the amount and the beneficiary’s details. You become eligible to make transfers after you have been verified. (you sign up, finish account activation and KYC verification). - name: Payaza Account description: >- This is our internal account that can be used to make payouts to other bank accounts, in single or in bulk. The Payaza account can also be used to receive settlements. It can also be used to track the transfer status of your transactions and check your balance instantly - name: Sub Accounts description: >- This enables you to establish Sub Payaza accounts for your customers. Each sub-account comes with an assigned static virtual account, facilitating direct funding for individual accounts. Furthermore, the Main Payaza account can directly initiate funding for each sub-account. These sub-accounts serve the purpose of managing unique account positions or balances and facilitating disbursements from these positions to specified beneficiaries. - name: EUR Accounts description: >- This endpoints enable you to create EUR subaccounts which can be used to make transfers as required . - name: Apple Pay and Google Pay description: >- Apple Pay and Google Pay give your customers a fast, familiar, and secure way to complete payments. Our APIs provide a gateway to provide these services to your users for a smooth payment experience. - name: Virtual Accounts description: >- Virtual Accounts are bank accounts that are created for a specific purpose and last for specified durations. Virtual accounts are issued by Payaza’s partner banks. Our virtual account APIs can be used to create virtual accounts and perform other tasks relevant to virtual accounts. Virtual accounts are created to foster easy payment collections for your business and platform. Static/Reserved Account: This virtual account is created by the merchant and remains valid indefinitely. It can be used multiple times and does not expire. Dynamic Account: This virtual account is generated for a specific transaction or purpose. Please note that dynamic virtual account remains valid for a temporary period of time or until a payment of the specified amount is received. Upon expiry, a merchant can generate another one for a different purpose. - name: Card Collection description: >- The Card Collection APIs can be used to make card transactions, refund transactions that have been performed, check the status of a transaction and so much more. - name: Card Tokenisation description: >- The Card Tokenisation APIs are used to create card tokens, charge cards using tokens, retrieve all tokens created by a merchant account and deleting any card token as desired. - name: Refunds And Chargebacks description: >- The Refunds and Chargeback APIs are used to initiate refunds, view your refund and chargeback history and so much more. - name: Branches description: >- The Refunds and Chargeback APIs are used to initiate refunds, view your refund and chargeback history and so much more. - name: Auth-Capture-Void description: >- The Auth-Capture-Void APIs provide a two-phase payment process where transactions are first authorized, then captured or voided. This allows merchants to hold funds and complete the transaction in the future. - name: Momo and ZAR Collections description: APIs for MoMo, ZAR and XOF collections. - name: Check Transaction Status(Merchant Reference) description: >- This endpoint is used to check the transaction status of a transaction using the Merchant Reference.. paths: /payment-link/merchant/fetch-payment-links?search=&page=3&size=10: get: tags: - Payment Links summary: Fetch Payment Links description: It retrieves the list of payment links that have been created. parameters: - name: search in: query required: false schema: type: string default: '' description: The search term to filter payment links. - name: page in: query required: true schema: type: integer default: 10 description: The page number to be retrieved. - name: size in: query required: true schema: type: integer default: 3 description: The number of records per page. responses: '200': description: Request Successful content: application/json: schema: $ref: '#/components/schemas/fetchPaymentLinksResponse' examples: Fetch Payment Links: summary: Fetch Payment Links value: status: true message: Payment Links fetched successfully data: items: - id: 10011 link: https://business.payaza.africa/pay/devconference has_fixed_amount: true created_date: '2026-01-10T08:30:00.000000' start_date: '2026-01-10T08:30:00.000000' business_name: Tech Solutions Ltd payment_amount: 5000 payment_link_name: DevConference fee_bearer: Pay by Customer requested_information: - id: 991 attribute_index: 3 attribute_name: CUSTOMER_EMAIL reference_type: Email Address total_collected_amount: 15000 number_of_usage: 3 collect_customer_email: true is_single_use: false - id: 10012 link: https://business.payaza.africa/pay/charityfund has_fixed_amount: false created_date: '2026-02-15T14:22:10.123456' start_date: '2026-02-15T14:25:00.000000' business_name: Global Charity Org payment_description: Support our annual charity drive payment_link_name: CharityFund fee_bearer: Pay by Business redirect_url: https://example.com/thank-you requested_information: - id: 992 attribute_index: 1 attribute_name: CUSTOMER_FIRST_NAME reference_type: First Name - id: 993 attribute_index: 2 attribute_name: CUSTOMER_LAST_NAME reference_type: Last Name - id: 994 attribute_index: 3 attribute_name: CUSTOMER_EMAIL reference_type: Email Address total_collected_amount: 8500.5 number_of_usage: 12 collect_customer_first_and_last_name: true collect_customer_email: true is_single_use: false - id: 10013 link: https://business.payaza.africa/pay/premiumconsult has_fixed_amount: true created_date: '2026-03-01T09:15:00.000000' start_date: '2026-03-05T09:00:00.000000' business_name: Consulting Experts Group payment_amount: 150000 payment_description: 1-hour premium consultation session payment_link_name: PremiumConsult fee_bearer: Pay by Customer requested_information: [] total_collected_amount: 0 number_of_usage: 0 collect_customer_email: false is_single_use: true pagination: total: 3 per_page: 10 current_page: 1 total_pages: 1 '400': description: Invalid request security: - ApiKeyAuth: - Payaza {{Public API Key In Base64}} components: schemas: fetchPaymentLinksResponse: title: Fetch Payment Links Response type: object properties: status: type: boolean description: Indicates whether the request was successful. example: true message: type: string description: A descriptive message regarding the outcome of the operation. example: Payment Links fetched successfully data: type: object description: >- The payload containing the list of payment links and pagination details. properties: items: type: array description: An array of payment link records. items: type: object properties: id: type: integer description: The unique internal identifier for the payment link. example: 10293 link: type: string format: uri description: The publicly accessible URL for the payment link. example: https://business.payaza.africa/pay/samplelink has_fixed_amount: type: boolean description: >- Indicates if the payment link charges a specific, fixed amount. example: true created_date: type: string format: date-time description: The timestamp when the payment link was created. example: '2024-01-15T10:30:00.000000' start_date: type: string format: date-time description: The timestamp when the payment link became active. example: '2024-01-15T10:30:00.000000' business_name: type: string description: The name of the business that owns the payment link. example: Acme Corporation branch_id: type: integer description: The identifier of the business branch, if applicable. example: 101 payment_amount: type: number description: The fixed amount to be paid (if has_fixed_amount is true). example: 1500 payment_description: type: string description: A brief description of what the payment link is for. example: Conference registration fee payment_link_name: type: string description: The custom name or title of the payment link. example: Event Payment fee_bearer: type: string description: Indicates who bears the transaction processing fee. example: Pay by Customer redirect_url: type: string description: >- The URL the customer is redirected to after a successful payment. example: https://example.com/success requested_information: type: array description: >- A list of data fields requested from the customer during checkout. items: type: object properties: id: type: integer description: The unique identifier for the requested attribute. example: 99281 attribute_index: type: integer description: The ordering index of the requested attribute. example: 3 attribute_name: type: string description: The system name of the requested attribute. example: CUSTOMER_EMAIL reference_type: type: string description: >- The human-readable label for the requested attribute. example: Email Address total_collected_amount: type: number description: >- The total sum of money collected through this payment link so far. example: 4500 number_of_usage: type: integer description: >- The total number of successful transactions made using this link. example: 3 collect_customer_email: type: boolean description: Indicates if the customer's email is collected. example: true collect_customer_first_and_last_name: type: boolean description: Indicates if the customer's full name is collected. example: true collect_customer_phone_number: type: boolean description: Indicates if the customer's phone number is collected. example: false is_single_use: type: boolean description: >- Indicates whether the link expires after one successful payment. example: false pagination: type: object description: Metadata for navigating through pages of payment link records. properties: total: type: integer description: The total number of payment links available. example: 150 per_page: type: integer description: The number of payment links returned per page. example: 10 current_page: type: integer description: The current page number being returned. example: 1 total_pages: type: integer description: The total number of pages available. example: 15 securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: Payaza {{Public API Key in Base 64}} TenantID: type: apiKey in: header name: X-TenantID description: live or test ProductID: type: apiKey in: header name: X-ProductID description: 'default value is ‟app” ' ````