Custom form fields defined on this payment link. Absent when the link has no customer fields.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"HUB2 Documentation","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/hub2-83/aPkTvmVeXN9HXpuW/assets/logo/hub2.png?fit=max\u0026auto=format\u0026n=aPkTvmVeXN9HXpuW\u0026q=85\u0026s=18f9f70abbe4d6234bad47152927237a","dark":"https://mintcdn.com/hub2-83/aPkTvmVeXN9HXpuW/assets/logo/hub2.png?fit=max\u0026auto=format\u0026n=aPkTvmVeXN9HXpuW\u0026q=85\u0026s=18f9f70abbe4d6234bad47152927237a"},"favicon":"https://mintcdn.com/hub2-83/aPkTvmVeXN9HXpuW/assets/favicon.png?fit=max\u0026auto=format\u0026n=aPkTvmVeXN9HXpuW\u0026q=85\u0026s=d71426a9f8f85b6c6ccce6d36247bf39","api":{"openapi":"https://api.hub2.io/docs-json"},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/hub2","website":"https://www.hub2.io"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hub2-83","hasAudioNarration":false,"actualSubdomain":"hub2-83","customDomains":["docs.hub2.io"],"gitSource":{"type":"github","owner":"technohub2","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae16defdd9644647b4200dd","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Référence de l'API","count":86},{"language":"default","tag":"Integration","count":44},{"language":"default","tag":"Intégration","count":44},{"language":"default","tag":"Payments","count":18},{"language":"default","tag":"Webhooks","count":17},{"language":"default","tag":"Documentation","count":16},{"language":"default","tag":"Transfers","count":11},{"language":"default","tag":"Compliance","count":10},{"language":"default","tag":"Payment Links","count":10},{"language":"default","tag":"Processing Only","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"assets/style.css","content":"table{display:table!important}.table-scroll{overflow:scroll}table tbody tr:nth-child(odd){background:#FAFAFA}html.dark table tbody tr:nth-child(odd){background:#1A1A1A}"}],"page":{"pagePath":"api-reference/payment_links/list_payment_links","slug":"/api-reference/payment_links/list_payment_links","pageMetadata":{"openapi":"get /payment-links","title":"List Payment Links","description":"Retrieve a list of payment links with optional filtering","href":"/api-reference/payment_links/list_payment_links"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve a list of payment links with optional filtering\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /payment-links","title":"List Payment Links","description":"Retrieve a list of payment links with optional filtering","href":"/api-reference/payment_links/list_payment_links"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/hub2-83/0ef60d836fa10d10/assets/mermaid.js"],"openApiReferenceData":{"operation":{"description":"Retrieve a list of payment links with optional filtering","operationId":"PaymentLinksController_getPaymentLinks","parameters":["82f531fe-c1fc-4a1a-8309-fc95d604cf2f","c09f6cbf-e780-4897-af99-1dc8d56faf79","acfd3bee-4105-4c09-ba13-1b8725dc0336","5e970810-21d5-4e74-8eb8-f543ac1bac88","4db2d6ec-27c3-440b-b2af-12d297378930","d538c529-efa0-446b-a07b-61bf7a42af0a","afe6955c-7d55-4e71-8537-3ae0d796599a","2f928bd8-26b5-417b-80c2-554f26253221","ddf052a0-9696-46a6-980a-0c75e25c5e09"],"responses":{"200":"1216f014-19f4-4db8-8ef0-8e66786ac07f","400":"b7918609-cd16-42c2-bbea-3585077eb4ab","401":"530d9bf3-b9f5-4f7a-aea3-494198961da9","403":"b9af65fe-1089-4fbb-a27d-81a87b551d1b","429":"ef71208a-a4cb-4369-9f81-759f2309a6b6","500":"607d56fb-4f14-4194-bccd-3a8b865be203"},"summary":"List Payment Links","tags":["Payment Links"],"method":"get","type":"path","servers":[],"security":[],"path":"/payment-links","baseUrlOptions":[],"title":"List Payment Links","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"82f531fe-c1fc-4a1a-8309-fc95d604cf2f":{"name":"fromCreatedAt","required":false,"in":"query","description":"Filter by creation date from (ISO 8601) - inclusive start date","schema":{"example":"2024-01-15T00:00:00.000Z","type":"string","isRequired":false,"description":"Filter by creation date from (ISO 8601) - inclusive start date","uniqueKey":"","typeLabel":"string"}},"c09f6cbf-e780-4897-af99-1dc8d56faf79":{"name":"toCreatedAt","required":false,"in":"query","description":"Filter by creation date to (ISO 8601) - inclusive end date","schema":{"example":"2024-01-15T23:59:59.999Z","type":"string","isRequired":false,"description":"Filter by creation date to (ISO 8601) - inclusive end date","uniqueKey":"","typeLabel":"string"}},"acfd3bee-4105-4c09-ba13-1b8725dc0336":{"name":"fromExpirationDate","required":false,"in":"query","description":"Filter by expiration date from (ISO 8601) - inclusive start date","schema":{"example":"2024-01-15T00:00:00.000Z","type":"string","isRequired":false,"description":"Filter by expiration date from (ISO 8601) - inclusive start date","uniqueKey":"","typeLabel":"string"}},"5e970810-21d5-4e74-8eb8-f543ac1bac88":{"name":"toExpirationDate","required":false,"in":"query","description":"Filter by expiration date to (ISO 8601) - inclusive end date","schema":{"example":"2024-01-15T23:59:59.999Z","type":"string","isRequired":false,"description":"Filter by expiration date to (ISO 8601) - inclusive end date","uniqueKey":"","typeLabel":"string"}},"4db2d6ec-27c3-440b-b2af-12d297378930":{"name":"status","required":false,"in":"query","description":"Filter by payment link status","schema":{"example":"active","type":"string","enum":["active","expired","closed","completed"],"isRequired":false,"description":"Filter by payment link status","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"d538c529-efa0-446b-a07b-61bf7a42af0a":{"name":"purchaseReference","required":false,"in":"query","description":"Filter by exact purchase reference (idempotency lookups)","schema":{"example":"bp_9f8a2c1e0b3d4f5a6c7e8d9f","type":"string","isRequired":false,"description":"Filter by exact purchase reference (idempotency lookups)","uniqueKey":"","typeLabel":"string"}},"afe6955c-7d55-4e71-8537-3ae0d796599a":{"name":"ApiKey","in":"header","description":"Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.","required":true,"schema":{"type":"string","isRequired":true,"description":"Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.","uniqueKey":"","typeLabel":"string"}},"2f928bd8-26b5-417b-80c2-554f26253221":{"name":"MerchantId","in":"header","description":"Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.","required":true,"schema":{"type":"string","isRequired":true,"description":"Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.","uniqueKey":"","typeLabel":"string"}},"ddf052a0-9696-46a6-980a-0c75e25c5e09":{"name":"Environment","in":"header","description":"Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.","required":true,"schema":{"type":"string","enum":["live","sandbox"],"isRequired":true,"description":"Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"1216f014-19f4-4db8-8ef0-8e66786ac07f":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the payment link","example":"pl_z1urYtVFgEebtcj8fxp4v","isRequired":true,"uniqueKey":"items.[INDEX].id","typeLabel":"string"},"url":{"type":"string","description":"URL for the payment link","example":"https://pay.hub2.com/pl_z1urYtVFgEebtcj8fxp4v","isRequired":true,"uniqueKey":"items.[INDEX].url","typeLabel":"string"},"status":{"type":"string","description":"Current status of the payment link","enum":["active","expired","closed","completed"],"example":"active","isRequired":true,"uniqueKey":"items.[INDEX].status","typeLabel":"enum\u003cstring>"},"purchaseReference":{"type":"string","description":"Merchant reference for the payment","example":"ORDER-12345","isRequired":true,"uniqueKey":"items.[INDEX].purchaseReference","typeLabel":"string"},"amount":{"oneOf":[{"type":"object","description":"Amount intended to be charged in the smallest currency unit. Null when openAmount is true.","example":1000,"isRequired":true,"uniqueKey":"items.[INDEX].amount.oneOf.0","typeLabel":"object"},{"type":"null","description":"Amount intended to be charged in the smallest currency unit. Null when openAmount is true.","example":1000,"isRequired":true,"uniqueKey":"items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].amount","typeLabel":"object | null"},"currency":{"type":"string","description":"Three-letter ISO 4217 currency code","example":"XOF","isRequired":true,"uniqueKey":"items.[INDEX].currency","typeLabel":"string"},"currentSuccessCount":{"type":"number","description":"Number of successful payments recorded for this link","example":0,"isRequired":true,"uniqueKey":"items.[INDEX].currentSuccessCount","typeLabel":"number"},"maximumAttempts":{"type":"number","description":"Maximum number of failed payments allowed per user","example":3,"isRequired":true,"uniqueKey":"items.[INDEX].maximumAttempts","typeLabel":"number"},"createdAt":{"type":"string","description":"Creation date in ISO 8601 format","example":"2024-01-15T12:00:00.000Z","isRequired":true,"uniqueKey":"items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Last update date in ISO 8601 format","example":"2024-01-15T12:30:00.000Z","isRequired":true,"uniqueKey":"items.[INDEX].updatedAt","typeLabel":"string"},"expirationDate":{"type":"string","description":"Expiration date in ISO 8601 format","example":"2024-01-15T14:30:00.000Z","isRequired":true,"uniqueKey":"items.[INDEX].expirationDate","typeLabel":"string"},"customerPhoneNumber":{"type":"string","description":"Restricted MSISDN","example":"123456789","isRequired":true,"uniqueKey":"items.[INDEX].customerPhoneNumber","typeLabel":"string"},"type":{"type":"string","description":"Type of the payment link","enum":["single_use","multi_use","bill_payment"],"example":"single_use","isRequired":true,"uniqueKey":"items.[INDEX].type","typeLabel":"enum\u003cstring>"},"paymentAttempts":{"description":"List of payment attempts for this payment link","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the Payment","example":"pay_QW2d6JnqiatcH8KhK0mD1","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].id","typeLabel":"string"},"intentId":{"type":"string","description":"Unique identifier for the PaymentIntent owning this Payment","example":"pi_z1urYtVFgEebtcj8fxp4v","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].intentId","typeLabel":"string"},"createdAt":{"type":"string","description":"Datetime in UTC timezone at which this object was created.\n Follows the [Datetime ISO](https://en.wikipedia.org/wiki/ISO_8601).","example":"2020-10-15T12:09:49.355Z","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Datetime in UTC timezone at which this object was updated for the last time .\n Follows the [Datetime ISO](https://en.wikipedia.org/wiki/ISO_8601).","example":"2020-10-15T12:16:26.128Z","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].updatedAt","typeLabel":"string"},"status":{"type":"string","description":"Current status of this Payment","enum":["created","failed","pending","successful"],"example":"successful","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge €1.00 or 100 to charge FCFA100, a zero-decimal currency).","example":100,"isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].amount","typeLabel":"number"},"currency":{"type":"string","description":"Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html).","example":"XOF","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].currency","typeLabel":"string"},"method":{"type":"string","description":"The method selected by the customer to make this Payment","example":"mobile_money","enum":["mobile_money","credit_card","bank_transfer","instant_payment"],"isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].method","typeLabel":"enum\u003cstring>"},"country":{"type":"string","description":"Two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Represents the country where the provider selected by the customer is localized. ","example":"CI","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].country","typeLabel":"string"},"fees":{"description":"Some fees may be applied on a Payment. This array provides information of the fees that could have been applied on this Payment.","title":"PaymentFee","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the applied Fee object.","example":"fee_lAe5HnFpvOjwdT9vSIgPA","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees.items.[INDEX].id","typeLabel":"string"},"rate":{"type":"number","description":"A rate corresponding to the amount (flat or percentage) applied by the fees.","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees.items.[INDEX].rate","typeLabel":"number"},"rateType":{"type":"string","description":"Fees can either be a flat amount of the transaction amount or percentage of the transaction amount.","enum":["percent","flat"],"isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees.items.[INDEX].rateType","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Amount applied by this Fees. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge €1.00 or 100 to charge FCFA100, a zero-decimal currency).","example":5,"isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees.items.[INDEX].amount","typeLabel":"number"},"currency":{"type":"string","description":"Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html).","example":"XOF","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees.items.[INDEX].currency","typeLabel":"string"},"label":{"type":"string","description":"An optional label giving information on the reason of this fees.","uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees.items.[INDEX].label","typeLabel":"string"},"taxes":{"description":"Taxes applied to this fee.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the applied tax.","example":"tax_lAe5HnFpvOjwdT9vSIgPA","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees.items.[INDEX].taxes.items.[INDEX].id","typeLabel":"string"},"feeId":{"type":"string","description":"Identifier of the Fee this tax applies to.","example":"fee_lAe5HnFpvOjwdT9vSIgPA","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees.items.[INDEX].taxes.items.[INDEX].feeId","typeLabel":"string"},"taxType":{"type":"string","description":"Kind of tax applied.","enum":["tva"],"example":"tva","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees.items.[INDEX].taxes.items.[INDEX].taxType","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"How the tax amount was computed: a flat amount, or a percentage included in the fee amount.","enum":["flat","percent"],"example":"percent","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees.items.[INDEX].taxes.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"number","description":"Tax amount, not rounded. For a `percent` tax it is the tax part of this fee, in the smallest currency unit, computed on a base that may differ from the one `amount` uses, so it may not match the tax contained in `amount`. For a `flat` tax it is the configured tax amount as is.","example":3.813559322033896,"isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees.items.[INDEX].taxes.items.[INDEX].value","typeLabel":"number"}},"required":["id","feeId","taxType","type","value"],"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees.items.[INDEX].taxes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees.items.[INDEX].taxes","typeLabel":"object[]"}},"required":["id","rate","rateType","amount","currency"],"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].fees","typeLabel":"PaymentFee · object[]"},"providerReference":{"type":"string","description":"provider reference that identify this payment","title":"providerReference","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].providerReference","typeLabel":"string"},"number":{"type":"string","description":"The identifier referencing the payment method of the customer.\n - In case of a payment by Mobile Money, it corresponds to the customer phone number corresponding to his Mobile Money account,\n - In case of a payment by Credit Card, it corresponds to the four last digits of the customer's credit card number.","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].number","typeLabel":"string"},"failure":{"type":"object","title":"PaymentFailureCause","description":"In case of a Payment attempt failure, this object will describe the reason of the failure","required":["code","message"],"properties":{"code":{"type":"string","description":"Unique code representing the failure cause for the payment.","enum":["internal_error","service_unavailable","unknown_reason","customer_account_locked","customer_insufficient_funds","authentication_failed","authentication_timeout","issuer_authentication_unavailable","timeout","bad_parameters","forbidden_by_provider","too_many_request","duplicate_request","consent_reference_in_use","canceled_by_customer","canceled","fraud_suspicion","unsupported_currency","payer_quota_exceeded","invalid_payment_processor","invalid_amount","recipient_unavailable","msisdn_invalid","card_expired","card_declined","card_stolen","card_refused","card_invalid","card_cvn_invalid","address_verification_failed","payment_limit_reached","reconciliation_failure"],"isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].failure.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human readable message explaining the failure cause. This message can be displayed to the customer.","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].failure.message","typeLabel":"string"},"params":{"description":"List of parameters causing the payment failure in case of invalid parameters","type":"array","items":{"type":"string","uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].failure.params.items.[INDEX]","typeLabel":"string"},"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].failure.params","typeLabel":"string[]"}},"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].failure","typeLabel":"PaymentFailureCause · object"},"nextAction":{"type":"object","title":"NextAction","description":"Action required to execute to continue the processing of this Payment. The action allows the customer to validate the Payment.\n - A redirection action provides all the information to redirect the customer to an external page,\n - A ussd action provides a message to display to the user for the validation of the Payment. He will receive a USSD message on his phone describing how to make the validation,\n - A otp action requires that you display an input to the customer to collect an OTP. A message is provided to explains to the user how to get this OTP. Then, the client will have to send the authentication request.\n ","required":["type","message"],"properties":{"type":{"type":"string","enum":["ussd","otp","redirection"],"isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].nextAction.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].nextAction.message","typeLabel":"string"},"data":{"type":"object","description":"","required":["url","urls","method"],"properties":{"url":{"type":"string","description":"A fully qualified URL where the customer must be redirected to pursue the payment.","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].nextAction.data.url","typeLabel":"string"},"urls":{"type":"string","description":"An array of fully qualified URLs where the customer must be redirected to pursue the payment.","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].nextAction.data.urls","typeLabel":"string"},"method":{"type":"string","description":"HTTP verb to be used to redirect the customer.","example":"post","isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].nextAction.data.method","typeLabel":"string"},"headers":{"type":"object","description":"","uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].nextAction.data.headers","typeLabel":"object"},"data":{"type":"object","description":"Data that need to be used to make the redirection. It could be parameters for a GET request or a body payload for a POST.","uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].nextAction.data.data","typeLabel":"object"}},"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].nextAction.data","typeLabel":"object"}},"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].nextAction","typeLabel":"NextAction · object"},"paymentInformation":{"type":"object","description":"Optional beneficiary metadata (hashed identifiers) attached to this payment.","properties":{"customer_id_hashmac":{"type":"string","description":"HMAC-SHA256, hex-encoded (64 characters), of your identifier for the end user paying: your customer id, or the end-user phone number when you have no customer id. Lets Hub2 correlate the pay-ins of one person for fraud analysis without receiving personal data. Case-insensitive on input, returned in lower case.","example":"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08","pattern":"^[0-9a-fA-F]{64}$","maxLength":64,"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].paymentInformation.customer_id_hashmac","typeLabel":"string"}},"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].paymentInformation","typeLabel":"object"},"isDelegated":{"type":"boolean","description":"Indicates whether this payment is a delegated payment.","uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX].isDelegated","typeLabel":"boolean"}},"required":["id","intentId","createdAt","updatedAt","status","amount","currency","method","country","fees","providerReference","number"],"uniqueKey":"items.[INDEX].paymentAttempts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"items.[INDEX].paymentAttempts","typeLabel":"object[]"},"openAmount":{"type":"boolean","description":"When true, the payer decides the amount at payment time.","example":false,"uniqueKey":"items.[INDEX].openAmount","typeLabel":"boolean"},"minAmount":{"type":"number","description":"Minimum amount the payer can enter (only when openAmount is true).","example":500,"uniqueKey":"items.[INDEX].minAmount","typeLabel":"number"},"maxAmount":{"type":"number","description":"Maximum amount the payer can enter (only when openAmount is true).","example":100000,"uniqueKey":"items.[INDEX].maxAmount","typeLabel":"number"},"maximumPayments":{"type":"number","description":"Maximum successful payments allowed (omitted when unlimited multi_use)","example":50,"uniqueKey":"items.[INDEX].maximumPayments","typeLabel":"number"},"customerFields":{"description":"Custom form fields defined on this payment link. Absent when the link has no customer fields.","type":"array","items":{"type":"object","properties":{"fieldName":{"type":"string","description":"Field identifier in snake_case","example":"national_id","isRequired":true,"uniqueKey":"items.[INDEX].customerFields.items.[INDEX].fieldName","typeLabel":"string"},"fieldLabel":{"type":"string","description":"Human-readable label shown to the payer","example":"National ID","maxLength":100,"isRequired":true,"uniqueKey":"items.[INDEX].customerFields.items.[INDEX].fieldLabel","typeLabel":"string"},"fieldType":{"type":"string","enum":["text","integer","decimal","email","date"],"description":"Expected value type for validation and input rendering","isRequired":true,"uniqueKey":"items.[INDEX].customerFields.items.[INDEX].fieldType","typeLabel":"enum\u003cstring>"},"isRequired":{"type":"boolean","description":"Whether the payer must fill this field before proceeding","isRequired":true,"uniqueKey":"items.[INDEX].customerFields.items.[INDEX].isRequired","typeLabel":"boolean"},"fieldPlaceholder":{"type":"string","description":"Optional input placeholder text","maxLength":200,"uniqueKey":"items.[INDEX].customerFields.items.[INDEX].fieldPlaceholder","typeLabel":"string"}},"required":["fieldName","fieldLabel","fieldType","isRequired"],"uniqueKey":"items.[INDEX].customerFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"items.[INDEX].customerFields","typeLabel":"object[]"}},"required":["id","url","status","purchaseReference","amount","currency","currentSuccessCount","maximumAttempts","createdAt","updatedAt","expirationDate","customerPhoneNumber","type","paymentAttempts"],"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"id":"pl_z1urYtVFgEebtcj8fxp4v","url":"https://pay.hub2.com/pl_z1urYtVFgEebtcj8fxp4v","status":"active","purchaseReference":"ORDER-12345","amount":1000,"currency":"XOF","currentSuccessCount":0,"maximumAttempts":3,"createdAt":"2024-01-15T12:00:00.000Z","updatedAt":"2024-01-15T12:30:00.000Z","expirationDate":"2024-01-15T14:30:00.000Z","customerPhoneNumber":"123456789","type":"single_use","paymentAttempts":[{"id":"pay_QW2d6JnqiatcH8KhK0mD1","intentId":"pi_z1urYtVFgEebtcj8fxp4v","createdAt":"2020-10-15T12:09:49.355Z","updatedAt":"2020-10-15T12:16:26.128Z","status":"successful","amount":100,"currency":"XOF","method":"mobile_money","country":"CI","fees":[{"id":"fee_lAe5HnFpvOjwdT9vSIgPA","rate":123,"rateType":"percent","amount":5,"currency":"XOF","label":"\u003cstring>","taxes":[{"id":"tax_lAe5HnFpvOjwdT9vSIgPA","feeId":"fee_lAe5HnFpvOjwdT9vSIgPA","taxType":"tva","type":"percent","value":3.813559322033896}]}],"providerReference":"\u003cstring>","number":"\u003cstring>","failure":{"code":"internal_error","message":"\u003cstring>","params":["\u003cstring>"]},"nextAction":{"type":"ussd","message":"\u003cstring>","data":{"url":"\u003cstring>","urls":"\u003cstring>","method":"post","headers":{},"data":{}}},"paymentInformation":{"customer_id_hashmac":"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"},"isDelegated":true}],"openAmount":false,"minAmount":500,"maxAmount":100000,"maximumPayments":50,"customerFields":[{"fieldName":"national_id","fieldLabel":"National ID","fieldType":"text","isRequired":true,"fieldPlaceholder":"\u003cstring>"}]}]}},"exampleType":"generated"}},"exampleType":"generated"},"b7918609-cd16-42c2-bbea-3585077eb4ab":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","description":"HTTP error code.","example":400,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"error":{"type":"object","description":"HTTP error description.","required":["statusCode","message","error"],"properties":{"statusCode":{"type":"number","description":"HTTP error code.","example":400,"isRequired":true,"uniqueKey":"error.statusCode","typeLabel":"number"},"message":{"description":"Detailed error message or array of messages to describe what's wrong.","example":["destination.provider must be a string"],"type":"array","items":{"type":"string","uniqueKey":"error.message.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.message","typeLabel":"string[]"},"error":{"type":"string","description":"The error message","example":"Bad Request","isRequired":true,"uniqueKey":"error.error","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":400,"error":{"statusCode":400,"message":["destination.provider must be a string"],"error":"Bad Request"}}}},"exampleType":"generated"}},"exampleType":"generated"},"530d9bf3-b9f5-4f7a-aea3-494198961da9":{"description":"Wrong credentials","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","description":"HTTP error code.","example":401,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"error":{"type":"object","description":"HTTP error description.","required":["type","code","message"],"properties":{"type":{"type":"string","description":"The type of this error.","example":"authorization_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","description":"The internal error code describing what happened.","enum":["bad_payment_intent_token","wrong_credentials"],"example":"wrong_credentials","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Detailed error message which describe what happened.","example":"L'ID marchand et/ou la clé d'API sont incorrects.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":401,"error":{"type":"authorization_error","code":"wrong_credentials","message":"L'ID marchand et/ou la clé d'API sont incorrects."}}}},"exampleType":"generated"}},"exampleType":"generated"},"b9af65fe-1089-4fbb-a27d-81a87b551d1b":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","description":"status","enum":[403],"example":403,"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cnumber>"},"error":{"type":"object","description":"Error object","required":["statusCode","message","error"],"properties":{"statusCode":{"type":"number","description":"Http status","enum":[403],"example":403,"isRequired":true,"uniqueKey":"error.statusCode","typeLabel":"enum\u003cnumber>"},"message":{"type":"string","description":"Detailed error message","example":"Forbidden","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"error":{"type":"string","description":"Error name","isRequired":true,"uniqueKey":"error.error","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":403,"error":{"statusCode":403,"message":"Forbidden","error":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ef71208a-a4cb-4369-9f81-759f2309a6b6":{"description":"ThrottlerException: Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","description":"status","enum":[429],"example":429,"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cnumber>"},"error":{"type":"string","description":"Error","example":"ThrottlerException: Too Many Requests","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":429,"error":"ThrottlerException: Too Many Requests"}}},"exampleType":"generated"}},"exampleType":"generated"},"607d56fb-4f14-4194-bccd-3a8b865be203":{"description":"Internal error","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The type of this error.","example":"internal_error","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","description":"The error code for this error.","example":["internal_error","wrong_credentials","not_granted","live_mode_not_granted"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"The error message describing what happens to throw this error.","example":"An error occurred on our system. Please try again later.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["type","code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"internal_error","code":["internal_error","wrong_credentials","not_granted","live_mode_not_granted"],"message":"An error occurred on our system. Please try again later."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{}},"originalFileLocation":"https://api.hub2.io/docs-json"},"subdomain":"hub2-83","siteName":"HUB2 Documentation","title":"List Payment Links - HUB2 Documentation","navMaps":{"firstHrefInVersion":{"English":{"href":"/api-reference/payment_links/list_payment_links","matchLevel":0},"Français":{"href":"/api-reference/payment_links/list_payment_links","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-07T05:53:44.042Z","originalFileLocation":"api-reference/payment_links/list_payment_links.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve a list of payment links with optional filtering\">\u003cmeta data-mint-head name=\"application-name\" content=\"HUB2 Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Payment Links - HUB2 Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a list of payment links with optional filtering\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"HUB2 Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hub2.io/api-reference/payment_links/list_payment_links\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hub2-83.mintlify.site/_mintlify/api/og/v2?division=Payment+Links\u0026amp;title=List+Payment+Links\u0026amp;description=Retrieve+a+list+of+payment+links+with+optional+filtering\u0026amp;theme=92cb3d561e9d2318e8ed5cd1\u0026amp;signature=356c8c8a76445838006b68e97871ec5d5e5c103fea5644207cea3ce63ac128c0\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List Payment Links - HUB2 Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a list of payment links with optional filtering\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hub2-83.mintlify.site/_mintlify/api/og/v2?division=Payment+Links\u0026amp;title=List+Payment+Links\u0026amp;description=Retrieve+a+list+of+payment+links+with+optional+filtering\u0026amp;theme=92cb3d561e9d2318e8ed5cd1\u0026amp;signature=356c8c8a76445838006b68e97871ec5d5e5c103fea5644207cea3ce63ac128c0\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hub2-83/2cSAgZof76cJIDy-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"HUB2 Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hub2.io/api-reference/payment_links/list_payment_links\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payment_links/list_payment_links.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hub2.io/#organization\",\"name\":\"HUB2 Documentation\",\"url\":\"https://docs.hub2.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hub2-83/aPkTvmVeXN9HXpuW/assets/logo/hub2.png?fit=max\u0026auto=format\u0026n=aPkTvmVeXN9HXpuW\u0026q=85\u0026s=18f9f70abbe4d6234bad47152927237a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hub2.io#website\",\"name\":\"HUB2 Documentation\",\"url\":\"https://docs.hub2.io\",\"publisher\":{\"@id\":\"https://docs.hub2.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hub2.io/api-reference/payment_links/list_payment_links#webpage\",\"url\":\"https://docs.hub2.io/api-reference/payment_links/list_payment_links\",\"name\":\"List Payment Links\",\"description\":\"Retrieve a list of payment links with optional filtering\",\"dateModified\":\"2026-10-07T05:53:44.042Z\",\"isPartOf\":{\"@id\":\"https://docs.hub2.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hub2.io/api-reference/payment_links/list_payment_links#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hub2.io/api-reference/payment_links/list_payment_links#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payment Links\",\"item\":\"https://docs.hub2.io/api-reference/payment_links/create_payment_links\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Payment Links\",\"item\":\"https://docs.hub2.io/api-reference/payment_links/list_payment_links\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hub2.io/api-reference/payment_links/list_payment_links#apireference\",\"headline\":\"List Payment Links\",\"name\":\"List Payment Links\",\"description\":\"Retrieve a list of payment links with optional filtering\",\"url\":\"https://docs.hub2.io/api-reference/payment_links/list_payment_links\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hub2.io/api-reference/payment_links/list_payment_links#webpage\"},\"dateModified\":\"2026-10-07T05:53:44.042Z\",\"publisher\":{\"@id\":\"https://docs.hub2.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hub2.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"HUB2 Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"HUB2 Documentation","nav":{"global":null,"versions":[{"version":"English","tabs":[{"tab":"HUB2"},{"tab":"Integration","pages":[{"title":"Integration","href":"/integration/en/getting_started/introduction"}]},{"tab":"Documentation","pages":[{"title":"Documentation","href":"/documentation/en/glossary"}]},{"tab":"API Reference","groups":[{"group":"Data","pages":[{"openapi":"get /data/countries","title":"Get countries","href":"/api-reference/data/get-countries"},{"openapi":"get /data/providers","title":"Get providers","href":"/api-reference/data/get-providers"},{"openapi":"get /data/bank-codes","title":"Get bank codes","href":"/api-reference/data/get-bank-codes"}]},{"group":"Balance","pages":[{"openapi":"get /balance","title":"Check Merchant Balance","href":"/api-reference/balance/check-merchant-balance"}]},{"group":"Webhooks","pages":[{"openapi":"get /webhooks","title":"Get all webhooks","href":"/api-reference/webhooks/get-all-webhooks"},{"openapi":"post /webhooks","title":"Create a webhook","href":"/api-reference/webhooks/create-a-webhook"},{"openapi":"get /webhooks/{id}","title":"Get a webhook","href":"/api-reference/webhooks/get-a-webhook"},{"openapi":"delete /webhooks/{id}","title":"Remove a webhook","href":"/api-reference/webhooks/remove-a-webhook"},{"openapi":"patch /webhooks/{id}","title":"Update a webhook","href":"/api-reference/webhooks/update-a-webhook"}]},{"group":"Sms","pages":[{"openapi":"get /sms/count","title":"Retrieve number of sms sent","href":"/api-reference/sms/retrieve-number-of-sms-sent"},{"openapi":"get /sms/list","title":"Get a list of sms sent","href":"/api-reference/sms/get-a-list-of-sms-sent"},{"openapi":"post /sms","title":"Send Sms","href":"/api-reference/sms/send-sms"}]},{"group":"Payments","pages":[{"openapi":"get /payment-intents","title":"Retrieve a PaymentIntent collection","href":"/api-reference/payments/retrieve-a-paymentintent-collection"},{"openapi":"post /payment-intents","title":"Create a PaymentIntent object","href":"/api-reference/payments/create-a-paymentintent-object"},{"openapi":"get /payment-intents/{id}","title":"Retrieve a PaymentIntent object","href":"/api-reference/payments/retrieve-a-paymentintent-object"},{"openapi":"post /payment-intents/{id}/payments","title":"Attempt a payment on a PaymentIntent object","href":"/api-reference/payments/attempt-a-payment-on-a-paymentintent-object"},{"openapi":"post /payment-intents/{id}/payments/sync","title":"Synchronously attempt a payment on a payment intent","href":"/api-reference/payments/synchronously-attempt-a-payment-on-a-payment-intent"},{"openapi":"post /payment-intents/{id}/authentication","title":"Authenticate the current payment","href":"/api-reference/payments/authenticate-the-current-payment"},{"openapi":"get /payment-intents/{id}/payment-fees","title":"Retrieve fees","href":"/api-reference/payments/retrieve-fees"},{"openapi":"get /payment-intents/url/{token}","title":"Retrieve configured URLs","href":"/api-reference/payments/retrieve-configured-urls"},{"openapi":"get /payment-intents/{id}/status","title":"Retrieve a PaymentIntent status","href":"/api-reference/payments/retrieve-a-paymentintent-status"},{"openapi":"get /payments","title":"Retrieve a Payments collection","href":"/api-reference/payments/retrieve-a-payments-collection"},{"openapi":"get /payments/{id}/status","title":"Retrieve the status payment object","href":"/api-reference/payments/retrieve-the-status-payment-object"}]},{"group":"Provisioning","pages":[{"openapi":"get /provisionings","title":"Retrieve a Provisionings collection","href":"/api-reference/provisioning/retrieve-a-provisionings-collection"},{"openapi":"post /provisionings","title":"Create a Provisioning","href":"/api-reference/provisioning/create-a-provisioning"},{"openapi":"get /provisionings/{id}","title":"Retrieve a Provisioning from given id","href":"/api-reference/provisioning/retrieve-a-provisioning-from-given-id"}]},{"group":"Receipt","pages":[{"openapi":"get /receipts/{id}","title":"Retrieve a Receipt","href":"/api-reference/receipt/retrieve-a-receipt"},{"openapi":"get /receipts/html/{id}","title":"Retrieve a Receipt as an HTML representation","href":"/api-reference/receipt/retrieve-a-receipt-as-an-html-representation"}]},{"group":"Payment on Terminal","pages":[{"openapi":"post /terminal/payments","title":"Execute payment","href":"/api-reference/payment-on-terminal/execute-payment"},{"openapi":"get /terminal/payments/{id}","title":"Retrieve a payment","href":"/api-reference/payment-on-terminal/retrieve-a-payment"}]},{"group":"IRT","pages":[{"openapi":"get /irt/transfer","title":"Retrieve a IRT transfers collection","href":"/api-reference/irt/retrieve-a-irt-transfers-collection"},{"openapi":"post /irt/transfer","title":"Create IRT transfer","href":"/api-reference/irt/create-irt-transfer"},{"openapi":"post /irt/transfer/verified-recipient","title":"Create an IRT transfer to a verified recipient","href":"/api-reference/irt/create-irt-transfer-verified-recipient"}]},{"group":"Transfers","pages":[{"openapi":"get /transfers","title":"Retrieve a Transfer collection","href":"/api-reference/transfers/retrieve-a-transfer-collection"},{"openapi":"post /transfers","title":"Create Transfer","href":"/api-reference/transfers/create-transfer"},{"openapi":"get /transfers/{id}","title":"Retrieve a Transfer","href":"/api-reference/transfers/retrieve-a-transfer"},{"openapi":"get /transfers/{id}/balance","title":"Retrieve a transfer's balance","href":"/api-reference/transfers/retrieve-a-transfers-balance"},{"openapi":"get /transfers/{id}/status","title":"Retrieve a transfer's status","href":"/api-reference/transfers/retrieve-a-transfers-status"},{"openapi":"post /transfers/status","title":"Retrieve the status of several transfers","href":"/api-reference/transfers/retrieve-transfers-status"}]},{"group":"Refunds","pages":[{"title":"Retrieve refunds collection","api":"GET https://api.hub2.io/refunds","href":"/api-reference/refunds/retrieve-refunds-collection"},{"openapi":"post /refunds/refund","title":"Create Refund","href":"/api-reference/refunds/create-refund"},{"title":"Retrieve a refund","api":"GET https://api.hub2.io/refunds/{id}","href":"/api-reference/refunds/retrieve-a-refund"}]},{"group":"Payment Refunds","pages":[{"openapi":"post /payments-refund/{id}/refund","title":"Create Refund for a Payment","href":"/api-reference/payments-refunds/create-refund-for-a-payment"},{"openapi":"get /payments-refund/{refundId}/status","title":"Get the status of a Payment Refund","href":"/api-reference/payments-refunds/get-the-status-of-a-payment-refund"}]},{"group":"Deposits","pages":[{"openapi":"get /deposits","title":"List deposits","href":"/api-reference/deposits/list-deposits"},{"openapi":"post /deposits","title":"Create a deposit","href":"/api-reference/deposits/create-a-deposit"},{"openapi":"get /deposits/{id}","title":"Get a deposit","href":"/api-reference/deposits/get-a-deposit"},{"openapi":"get /deposits/proof-upload-uri","title":"Get a proof upload URL","href":"/api-reference/deposits/get-a-proof-upload-url"},{"openapi":"post /deposits/{id}/proof","title":"Submit a proof","href":"/api-reference/deposits/submit-a-proof"},{"openapi":"get /deposits/{id}/proof","title":"Get deposit proof image","href":"/api-reference/deposits/get-deposit-proof-image"}]},{"group":"Compliance","pages":[{"openapi":"get /compliance/kyb/{name}","title":"Retrieve a kyb by name","href":"/api-reference/compliance/retrieve-a-kyb-by-name"},{"openapi":"put /compliance/kyb/{name}","title":"Update a kyb","href":"/api-reference/compliance/update-a-kyb"},{"openapi":"delete /compliance/kyb/{name}","title":"Delete a kyb","href":"/api-reference/compliance/delete-a-kyb"},{"openapi":"get /compliance/kyb","title":"Fetch a kyb list","href":"/api-reference/compliance/fetch-a-kyb-list"},{"openapi":"post /compliance/kyb","title":"Create a kyb","href":"/api-reference/compliance/create-a-kyb"},{"openapi":"get /compliance/transaction","title":"Fetch a kyb transactions list","href":"/api-reference/compliance/fetch-a-kyb-transactions-list"},{"openapi":"post /compliance/transaction","title":"Create a kyb transaction","href":"/api-reference/compliance/create-a-kyb-transaction"},{"openapi":"get /compliance/transaction/{reference}","title":"Retrieve a kyb transaction by reference","href":"/api-reference/compliance/retrieve-a-kyb-transaction-by-reference"},{"openapi":"delete /compliance/transaction/{reference}","title":"Delete a kyb transaction","href":"/api-reference/compliance/delete-a-kyb-transaction"},{"openapi":"get /compliance/kyc","title":"Get kyc information","href":"/api-reference/compliance/get-kyc-information"}]},{"group":"Recipients","pages":[{"openapi":"post /recipient","title":"Create a new recipient","href":"/api-reference/recipients/create-recipient"},{"openapi":"get /recipient/{id}","title":"Get a recipient by id","href":"/api-reference/recipients/find-recipient"},{"openapi":"get /recipient","title":"Retrieve a list of recipients according to filters","href":"/api-reference/recipients/list-recipients"},{"openapi":"delete /recipient/{id}","title":"Delete a recipient by id","href":"/api-reference/recipients/delete-recipient"}]},{"group":"Processing Only","pages":[{"openapi":"post /delegated/payments","title":"Create a delegated payment","href":"/api-reference/processing-only/make-a-delegated-payment"},{"openapi":"post /delegated/payments/sync","title":"Create a delegated synchronous payment","href":"/api-reference/processing-only/make-a-synchronous-delegated-payment"},{"openapi":"post /delegated/transfers","title":"Create a delegated Transfer","href":"/api-reference/processing-only/make-a-delegated-transfer"},{"openapi":"post /delegated/transfers/irt","title":"Create a delegated IRT transfer","href":"/api-reference/processing-only/make-a-delegated-transfer-irt"}]},{"group":"Payment Links","pages":[{"title":"Create a payment link","api":"POST https://api.hub2.io/payment-links","description":"Generate a secure payment link to collect payments from your customers.","href":"/api-reference/payment_links/create_payment_links"},{"openapi":"get /payment-links","title":"List Payment Links","href":"/api-reference/payment_links/list_payment_links"},{"openapi":"get /payment-links/{id}","title":"Get Payment Link with Attempts","description":"Retrieve detailed information about a payment link including payment attempts","href":"/api-reference/payment_links/list_payment_links_with_attempts"},{"openapi":"patch /payment-links/{id}/close","title":"Close Payment Link","href":"/api-reference/payment_links/close_payment_links"}]},{"group":"Submerchants","pages":[{"openapi":"post /submerchants","title":"Create a submerchant","href":"/api-reference/submerchants/create-a-submerchant"},{"openapi":"get /submerchants","title":"List submerchants","href":"/api-reference/submerchants/list_submerchants"},{"openapi":"patch /submerchants/{submerchantId}","title":"Update a submerchant","href":"/api-reference/submerchants/update-a-submerchant"}]},{"group":"Subscriptions","pages":[{"openapi":"post /subscription-links","title":"Create Subscription Link","href":"/api-reference/subscriptions/create-a-subscription-link"},{"openapi":"post /subscription-intents","title":"Enroll a customer in card-on-file recurring debits","href":"/api-reference/subscriptions/enroll-a-customer"},{"openapi":"get /subscription-intents/{id}/status","title":"Retrieve a card-on-file enrollment status","href":"/api-reference/subscriptions/retrieve-an-enrollment-status"},{"openapi":"get /subscriptions","title":"Retrieve a Subscription collection","href":"/api-reference/subscriptions/retrieve-a-subscription-collection"},{"openapi":"post /subscriptions/{id}/charge","title":"Charge a merchant-initiated subscription on demand","href":"/api-reference/subscriptions/charge-a-subscription"},{"openapi":"post /subscriptions/{id}/suspend","title":"Suspend a subscription","href":"/api-reference/subscriptions/suspend-a-subscription"},{"openapi":"post /subscriptions/{id}/cancel","title":"Cancel a subscription","href":"/api-reference/subscriptions/cancel-a-subscription"},{"openapi":"get /subscriptions/{id}/transactions","title":"Retrieve a subscription's charge history","href":"/api-reference/subscriptions/retrieve-a-subscription-charge-history"}]},{"group":"Instant Payment","pages":[{"openapi":"get /instant-payment/accounts/{accountType}/aliases","title":"List the instant payment aliases of an account","href":"/api-reference/instant-payment/list-aliases"},{"openapi":"post /instant-payment/accounts/{accountType}/aliases","title":"Create an instant payment alias","href":"/api-reference/instant-payment/create-an-alias"},{"openapi":"delete /instant-payment/accounts/{accountType}/aliases/{aliasKey}","title":"Delete an instant payment alias","href":"/api-reference/instant-payment/delete-an-alias"}]}]}]},{"version":"Français","tabs":[{"tab":"HUB2"},{"tab":"Intégration","pages":[{"title":"Intégration","href":"/integration/fr/getting_started/introduction"}]},{"tab":"Documentation","pages":[{"title":"Documentation","href":"/documentation/fr/glossary"}]},{"tab":"Référence de l'API","groups":[{"group":"Data","pages":[{"openapi":"get /data/countries","title":"Get countries","href":"/api-reference/data/get-countries"},{"openapi":"get /data/providers","title":"Get providers","href":"/api-reference/data/get-providers"},{"openapi":"get /data/bank-codes","title":"Get bank codes","href":"/api-reference/data/get-bank-codes"}]},{"group":"Balance","pages":[{"openapi":"get /balance","title":"Check Merchant Balance","href":"/api-reference/balance/check-merchant-balance"}]},{"group":"Webhooks","pages":[{"openapi":"get /webhooks","title":"Get all webhooks","href":"/api-reference/webhooks/get-all-webhooks"},{"openapi":"post /webhooks","title":"Create a webhook","href":"/api-reference/webhooks/create-a-webhook"},{"openapi":"get /webhooks/{id}","title":"Get a webhook","href":"/api-reference/webhooks/get-a-webhook"},{"openapi":"delete /webhooks/{id}","title":"Remove a webhook","href":"/api-reference/webhooks/remove-a-webhook"},{"openapi":"patch /webhooks/{id}","title":"Update a webhook","href":"/api-reference/webhooks/update-a-webhook"}]},{"group":"Sms","pages":[{"openapi":"get /sms/count","title":"Retrieve number of sms sent","href":"/api-reference/sms/retrieve-number-of-sms-sent"},{"openapi":"get /sms/list","title":"Get a list of sms sent","href":"/api-reference/sms/get-a-list-of-sms-sent"},{"openapi":"post /sms","title":"Send Sms","href":"/api-reference/sms/send-sms"}]},{"group":"Payments","pages":[{"openapi":"get /payment-intents","title":"Retrieve a PaymentIntent collection","href":"/api-reference/payments/retrieve-a-paymentintent-collection"},{"openapi":"post /payment-intents","title":"Create a PaymentIntent object","href":"/api-reference/payments/create-a-paymentintent-object"},{"openapi":"get /payment-intents/{id}","title":"Retrieve a PaymentIntent object","href":"/api-reference/payments/retrieve-a-paymentintent-object"},{"openapi":"post /payment-intents/{id}/payments","title":"Attempt a payment on a PaymentIntent object","href":"/api-reference/payments/attempt-a-payment-on-a-paymentintent-object"},{"openapi":"post /payment-intents/{id}/payments/sync","title":"Synchronously attempt a payment on a payment intent","href":"/api-reference/payments/synchronously-attempt-a-payment-on-a-payment-intent"},{"openapi":"post /payment-intents/{id}/authentication","title":"Authenticate the current payment","href":"/api-reference/payments/authenticate-the-current-payment"},{"openapi":"get /payment-intents/{id}/payment-fees","title":"Retrieve fees","href":"/api-reference/payments/retrieve-fees"},{"openapi":"get /payment-intents/url/{token}","title":"Retrieve configured URLs","href":"/api-reference/payments/retrieve-configured-urls"},{"openapi":"get /payment-intents/{id}/status","title":"Retrieve a PaymentIntent status","href":"/api-reference/payments/retrieve-a-paymentintent-status"},{"openapi":"get /payments","title":"Retrieve a Payments collection","href":"/api-reference/payments/retrieve-a-payments-collection"},{"openapi":"get /payments/{id}/status","title":"Retrieve the status payment object","href":"/api-reference/payments/retrieve-the-status-payment-object"}]},{"group":"Provisioning","pages":[{"openapi":"get /provisionings","title":"Retrieve a Provisionings collection","href":"/api-reference/provisioning/retrieve-a-provisionings-collection"},{"openapi":"post /provisionings","title":"Create a Provisioning","href":"/api-reference/provisioning/create-a-provisioning"},{"openapi":"get /provisionings/{id}","title":"Retrieve a Provisioning from given id","href":"/api-reference/provisioning/retrieve-a-provisioning-from-given-id"}]},{"group":"Receipt","pages":[{"openapi":"get /receipts/{id}","title":"Retrieve a Receipt","href":"/api-reference/receipt/retrieve-a-receipt"},{"openapi":"get /receipts/html/{id}","title":"Retrieve a Receipt as an HTML representation","href":"/api-reference/receipt/retrieve-a-receipt-as-an-html-representation"}]},{"group":"Payment on Terminal","pages":[{"openapi":"post /terminal/payments","title":"Execute payment","href":"/api-reference/payment-on-terminal/execute-payment"},{"openapi":"get /terminal/payments/{id}","title":"Retrieve a payment","href":"/api-reference/payment-on-terminal/retrieve-a-payment"}]},{"group":"IRT","pages":[{"openapi":"get /irt/transfer","title":"Retrieve a IRT transfers collection","href":"/api-reference/irt/retrieve-a-irt-transfers-collection"},{"openapi":"post /irt/transfer","title":"Create IRT transfer","href":"/api-reference/irt/create-irt-transfer"},{"openapi":"post /irt/transfer/verified-recipient","title":"Create an IRT transfer to a verified recipient","href":"/api-reference/irt/create-irt-transfer-verified-recipient"}]},{"group":"Transfers","pages":[{"openapi":"get /transfers","title":"Retrieve a Transfer collection","href":"/api-reference/transfers/retrieve-a-transfer-collection"},{"openapi":"post /transfers","title":"Create Transfer","href":"/api-reference/transfers/create-transfer"},{"openapi":"get /transfers/{id}","title":"Retrieve a Transfer","href":"/api-reference/transfers/retrieve-a-transfer"},{"openapi":"get /transfers/{id}/balance","title":"Retrieve a transfer's balance","href":"/api-reference/transfers/retrieve-a-transfers-balance"},{"openapi":"get /transfers/{id}/status","title":"Retrieve a transfer's status","href":"/api-reference/transfers/retrieve-a-transfers-status"},{"openapi":"post /transfers/status","title":"Retrieve the status of several transfers","href":"/api-reference/transfers/retrieve-transfers-status"}]},{"group":"Refunds","pages":[{"title":"Retrieve refunds collection","api":"GET https://api.hub2.io/refunds","href":"/api-reference/refunds/retrieve-refunds-collection"},{"openapi":"post /refunds/refund","title":"Create Refund","href":"/api-reference/refunds/create-refund"},{"title":"Retrieve a refund","api":"GET https://api.hub2.io/refunds/{id}","href":"/api-reference/refunds/retrieve-a-refund"}]},{"group":"Payment Refunds","pages":[{"openapi":"post /payments-refund/{id}/refund","title":"Create Refund for a Payment","href":"/api-reference/payments-refunds/create-refund-for-a-payment"},{"openapi":"get /payments-refund/{refundId}/status","title":"Get the status of a Payment Refund","href":"/api-reference/payments-refunds/get-the-status-of-a-payment-refund"}]},{"group":"Deposits","pages":[{"openapi":"get /deposits","title":"List deposits","href":"/api-reference/deposits/list-deposits"},{"openapi":"post /deposits","title":"Create a deposit","href":"/api-reference/deposits/create-a-deposit"},{"openapi":"get /deposits/{id}","title":"Get a deposit","href":"/api-reference/deposits/get-a-deposit"},{"openapi":"get /deposits/proof-upload-uri","title":"Get a proof upload URL","href":"/api-reference/deposits/get-a-proof-upload-url"},{"openapi":"post /deposits/{id}/proof","title":"Submit a proof","href":"/api-reference/deposits/submit-a-proof"},{"openapi":"get /deposits/{id}/proof","title":"Get deposit proof image","href":"/api-reference/deposits/get-deposit-proof-image"}]},{"group":"Compliance","pages":[{"openapi":"get /compliance/kyb/{name}","title":"Retrieve a kyb by name","href":"/api-reference/compliance/retrieve-a-kyb-by-name"},{"openapi":"put /compliance/kyb/{name}","title":"Update a kyb","href":"/api-reference/compliance/update-a-kyb"},{"openapi":"delete /compliance/kyb/{name}","title":"Delete a kyb","href":"/api-reference/compliance/delete-a-kyb"},{"openapi":"get /compliance/kyb","title":"Fetch a kyb list","href":"/api-reference/compliance/fetch-a-kyb-list"},{"openapi":"post /compliance/kyb","title":"Create a kyb","href":"/api-reference/compliance/create-a-kyb"},{"openapi":"get /compliance/transaction","title":"Fetch a kyb transactions list","href":"/api-reference/compliance/fetch-a-kyb-transactions-list"},{"openapi":"post /compliance/transaction","title":"Create a kyb transaction","href":"/api-reference/compliance/create-a-kyb-transaction"},{"openapi":"get /compliance/transaction/{reference}","title":"Retrieve a kyb transaction by reference","href":"/api-reference/compliance/retrieve-a-kyb-transaction-by-reference"},{"openapi":"delete /compliance/transaction/{reference}","title":"Delete a kyb transaction","href":"/api-reference/compliance/delete-a-kyb-transaction"},{"openapi":"get /compliance/kyc","title":"Get kyc information","href":"/api-reference/compliance/get-kyc-information"}]},{"group":"Recipients","pages":[{"openapi":"post /recipient","title":"Create a new recipient","href":"/api-reference/recipients/create-recipient"},{"openapi":"get /recipient/{id}","title":"Get a recipient by id","href":"/api-reference/recipients/find-recipient"},{"openapi":"get /recipient","title":"Retrieve a list of recipients according to filters","href":"/api-reference/recipients/list-recipients"},{"openapi":"delete /recipient/{id}","title":"Delete a recipient by id","href":"/api-reference/recipients/delete-recipient"}]},{"group":"Processing Only","pages":[{"openapi":"post /delegated/payments","title":"Create a delegated payment","href":"/api-reference/processing-only/make-a-delegated-payment"},{"openapi":"post /delegated/payments/sync","title":"Create a delegated synchronous payment","href":"/api-reference/processing-only/make-a-synchronous-delegated-payment"},{"openapi":"post /delegated/transfers","title":"Create a delegated Transfer","href":"/api-reference/processing-only/make-a-delegated-transfer"},{"openapi":"post /delegated/transfers/irt","title":"Create a delegated IRT transfer","href":"/api-reference/processing-only/make-a-delegated-transfer-irt"}]},{"group":"Payment Links","pages":[{"title":"Create a payment link","api":"POST https://api.hub2.io/payment-links","description":"Generate a secure payment link to collect payments from your customers.","href":"/api-reference/payment_links/create_payment_links"},{"openapi":"get /payment-links","title":"List Payment Links","href":"/api-reference/payment_links/list_payment_links"},{"openapi":"get /payment-links/{id}","title":"Get Payment Link with Attempts","description":"Retrieve detailed information about a payment link including payment attempts","href":"/api-reference/payment_links/list_payment_links_with_attempts"},{"openapi":"patch /payment-links/{id}/close","title":"Close Payment Link","href":"/api-reference/payment_links/close_payment_links"}]},{"group":"Submerchants","pages":[{"openapi":"post /submerchants","title":"Create a submerchant","href":"/api-reference/submerchants/create-a-submerchant"},{"openapi":"get /submerchants","title":"List submerchants","href":"/api-reference/submerchants/list_submerchants"},{"openapi":"patch /submerchants/{submerchantId}","title":"Update a submerchant","href":"/api-reference/submerchants/update-a-submerchant"}]},{"group":"Subscriptions","pages":[{"openapi":"post /subscription-links","title":"Create Subscription Link","href":"/api-reference/subscriptions/create-a-subscription-link"},{"openapi":"post /subscription-intents","title":"Enroll a customer in card-on-file recurring debits","href":"/api-reference/subscriptions/enroll-a-customer"},{"openapi":"get /subscription-intents/{id}/status","title":"Retrieve a card-on-file enrollment status","href":"/api-reference/subscriptions/retrieve-an-enrollment-status"},{"openapi":"get /subscriptions","title":"Retrieve a Subscription collection","href":"/api-reference/subscriptions/retrieve-a-subscription-collection"},{"openapi":"post /subscriptions/{id}/charge","title":"Charge a merchant-initiated subscription on demand","href":"/api-reference/subscriptions/charge-a-subscription"},{"openapi":"post /subscriptions/{id}/suspend","title":"Suspend a subscription","href":"/api-reference/subscriptions/suspend-a-subscription"},{"openapi":"post /subscriptions/{id}/cancel","title":"Cancel a subscription","href":"/api-reference/subscriptions/cancel-a-subscription"},{"openapi":"get /subscriptions/{id}/transactions","title":"Retrieve a subscription's charge history","href":"/api-reference/subscriptions/retrieve-a-subscription-charge-history"}]},{"group":"Instant Payment","pages":[{"openapi":"get /instant-payment/accounts/{accountType}/aliases","title":"List the instant payment aliases of an account","href":"/api-reference/instant-payment/list-aliases"},{"openapi":"post /instant-payment/accounts/{accountType}/aliases","title":"Create an instant payment alias","href":"/api-reference/instant-payment/create-an-alias"},{"openapi":"delete /instant-payment/accounts/{accountType}/aliases/{aliasKey}","title":"Delete an instant payment alias","href":"/api-reference/instant-payment/delete-an-alias"}]}]}]}]},"basePath":"","title":"List Payment Links - HUB2 Documentation","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}