API key issued by Meridian, sent so you can authenticate the webhook. Sent only when your webhook endpoint is configured for Meridian HMAC signing.
X-Meridian-Timestamp
string
Time the webhook was generated, in milliseconds since the Unix epoch. Sent only when your webhook endpoint is configured for Meridian HMAC signing.
X-Meridian-Signature
string
HMAC SHA-256 signature of the webhook request, for verifying that Meridian sent it. Sent only when your webhook endpoint is configured for Meridian HMAC signing.
Body
application/json
The payment link and the transaction the event relates to.
Webhook payload sent when a payment link transaction is created or changes status. The body has no envelope. The event name is in the X-Meridian-Event-Type header.
paymentLink
PaymentLink · object
required
The payment link the transaction belongs to, as it was when Meridian sent the webhook. The link and the transaction are updated separately, so the link's status can lag the transaction. Use transaction.status as the source of truth for the payment outcome.
Show child attributes
transaction
PaymentLinkTransactionNotification · object
required
The transaction and the status change that triggered the event.
Show child attributes
Response
200
Return any 2xx status to acknowledge the webhook. Any other status causes Meridian to retry.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Meridian","colors":{"primary":"#0A0A0A","light":"#fff","dark":"#0A0A0A"},"logo":{"light":"https://mintcdn.com/meridian-18e67158/VgZYEMrM1D9FVN_L/logo/meridian-light.svg?fit=max\u0026auto=format\u0026n=VgZYEMrM1D9FVN_L\u0026q=85\u0026s=165e274c2a61a48b1bbeb002a86899a0","dark":"https://mintcdn.com/meridian-18e67158/VgZYEMrM1D9FVN_L/logo/meridian-dark.svg?fit=max\u0026auto=format\u0026n=VgZYEMrM1D9FVN_L\u0026q=85\u0026s=52efdc7868532b4b80bcc6d6accd2f7a"},"favicon":"https://mintcdn.com/meridian-18e67158/hVhmegI9RGtyj60_/favicon.svg?fit=max\u0026auto=format\u0026n=hVhmegI9RGtyj60_\u0026q=85\u0026s=e0c3605c4133c3121025a59016bad7f8","api":{"playground":{"display":"simple"}},"appearance":{"default":"light"},"background":{"color":{"dark":"#0A0A0A"}},"navbar":{"links":[{"href":"https://www.mnai.com/","label":"Company"},{"href":"https://www.mnai.com/privacy","label":"Privacy"}],"primary":{"type":"button","label":"Contact Support","href":"https://meridian.support.site"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/meridiantechnologies","website":"https://www.mnai.com/"}},"seo":{"metatags":{"robots":"noindex"}},"fonts":{"family":"Manrope"},"contextual":{"options":["copy","view","download-spec","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"list","href":"/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"meridian-18e67158","hasAudioNarration":false,"actualSubdomain":"meridian-18e67158","customDomains":["docs.mnai.com"],"gitSource":{"type":"github","owner":"meridian-software","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":false,"contextualFeedback":{"allowEmail":true}},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED","enabled":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED","enabled":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afa494d5a8e334304fa6eee","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Meridian Accounts for Business","count":41},{"language":"default","tag":"API Reference","count":39},{"language":"default","tag":"Retail U.S. Accounts","count":16},{"language":"default","tag":"Realtime Collections","count":14},{"language":"default","tag":"Payout Origination","count":13},{"language":"default","tag":"Getting Started","count":12},{"language":"default","tag":"Bank Transfers","count":11},{"language":"default","tag":"Webhooks","count":10},{"language":"default","tag":"Credit API Example","count":8},{"language":"default","tag":"Integration Guide","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@meridianpay.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"69cb173d27b882b01903afac","deploymentId":"69af73ecd3d5be6fd07ee56e","questionText":"How do I set up the Virtual Accounts WebView in my app?","status":"active","generatedBy":"manual","createdAt":"2026-03-31T00:37:17.640Z","updatedAt":"2026-03-31T00:37:17.640Z","__v":0},{"_id":"69cb172e27b882b01903af7d","deploymentId":"69af73ecd3d5be6fd07ee56e","questionText":"How do withdrawals and the Credit API work?","status":"active","generatedBy":"manual","createdAt":"2026-03-31T00:37:02.071Z","updatedAt":"2026-03-31T00:37:02.071Z","__v":0},{"_id":"69cb171227b882b01903af39","deploymentId":"69af73ecd3d5be6fd07ee56e","questionText":"How do I authenticate my API requests?","status":"active","generatedBy":"manual","createdAt":"2026-03-31T00:36:34.719Z","updatedAt":"2026-03-31T00:36:34.719Z","__v":0}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction","slug":"/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction","pageMetadata":{"title":"Payment Link Transaction","description":"Learn when the payment link transaction webhooks are sent and what data they include.","openapi":"products/realtime-collections/api-reference/payment-links.json webhook payment_link_transaction","href":"/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction"},"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: \"Learn when the payment link transaction webhooks are sent and what data they include.\"\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":{"title":"Payment Link Transaction","description":"Learn when the payment link transaction webhooks are sent and what data they include.","openapi":"products/realtime-collections/api-reference/payment-links.json webhook payment_link_transaction","href":"/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/meridian-18e67158/625a1f69d47615a4/postman/build.js","/_mintlify/custom/meridian-18e67158/a6d3c14b21f9dc8f/postman/scripts/meridian-accounts.pre-request.js","/_mintlify/custom/meridian-18e67158/92d5577deff5b613/postman/scripts/payout-origination.pre-request.js","/_mintlify/custom/meridian-18e67158/d2d8072a808f0876/postman/scripts/shared.tests.js"],"openApiReferenceData":{"operation":{"x-hidden":true,"operationId":"paymentLinkTransaction","security":[],"summary":"Payment Link Transaction","description":"Learn when the payment link transaction webhooks are sent and what data they include.","parameters":["e1a7ae45-60a6-45b6-a4b0-f5f5d5a6f4af","44c12b5c-22f3-4f03-8e6b-c074c8cbaa70","ef5ba0a1-7a54-4267-a82d-10b4bd5f92e3","27c66df3-7442-4587-a52f-8b0b9eb57f4b","5d3db7c2-ba8f-4acb-9ec3-2aadec5d301f"],"requestBody":"e4f1d1f6-b849-4105-88e8-ed9e205aab39","responses":{"200":"9398e254-a593-4984-9847-104a88f707ef"},"method":"post","type":"webhook","servers":["cb097a76-bf59-444e-b5d5-f3c9e344bce6","ae2d55d2-8382-465f-95d2-1f36ce9d6374"],"path":"payment_link_transaction","baseUrlOptions":["https://us-merchant.sandbox.api-us.meridianapps.dev","https://us-merchant.api-us.payments.meridianpay.com"],"title":"Payment Link Transaction","codeSamples":[],"requiredOnlyExamples":false,"requestExamples":[{"language":"json","filename":"PaymentLinkTransactionCreated","code":"{\n \"paymentLink\": {\n \"id\": \"usmer-n1hpx2d89pdpnmpdjlorb995\",\n \"createdAt\": \"2026-10-08T12:49:09.223Z\",\n \"updatedAt\": \"2026-10-08T12:49:09.223Z\",\n \"linkToken\": \"fb78cf90-cf34-44d3-b3d3-074168b8c81a\",\n \"userId\": null,\n \"status\": \"ACTIVE\",\n \"statusReason\": null,\n \"initialAccessBy\": \"2026-10-09T12:49:09.194Z\",\n \"merchantId\": \"usmer-rtn86be1xb9jzb5qwib6z0i9\",\n \"recurrenceType\": \"SINGLE\",\n \"referenceId\": \"INV-7755-1791463748\",\n \"referenceLabel\": \"Invoice\",\n \"description\": \"ENG-7755 webhook test\",\n \"creditAmount\": \"150.00\",\n \"creditCurrency\": \"USD\",\n \"debitCurrency\": \"USD\",\n \"nextPaymentDate\": null,\n \"lastPaymentDate\": null,\n \"paymentAttempts\": 0,\n \"startDate\": null,\n \"endDate\": null,\n \"collectionCount\": null,\n \"customFields\": {\n \"orderId\": \"ORD-99812\"\n },\n \"autopays\": []\n },\n \"transaction\": {\n \"id\": \"uspay-echo1fuz76usacpgicexz5vb\",\n \"createdAt\": \"2026-10-08T12:51:39.147Z\",\n \"updatedAt\": \"2026-10-08T12:51:39.147Z\",\n \"completedAt\": null,\n \"status\": \"PENDING\",\n \"previousStatus\": null,\n \"statusReason\": null,\n \"debitAmount\": \"150.00\",\n \"debitCurrency\": \"USD\",\n \"creditAmount\": \"150.00\",\n \"creditCurrency\": \"USD\",\n \"fee\": \"0.00\"\n }\n}"},{"language":"json","filename":"PaymentLinkTransactionStatusUpdated","code":"{\n \"paymentLink\": {\n \"id\": \"usmer-n1hpx2d89pdpnmpdjlorb995\",\n \"createdAt\": \"2026-10-08T12:49:09.223Z\",\n \"updatedAt\": \"2026-10-08T12:49:09.223Z\",\n \"linkToken\": \"fb78cf90-cf34-44d3-b3d3-074168b8c81a\",\n \"userId\": null,\n \"status\": \"ACTIVE\",\n \"statusReason\": null,\n \"initialAccessBy\": \"2026-10-09T12:49:09.194Z\",\n \"merchantId\": \"usmer-rtn86be1xb9jzb5qwib6z0i9\",\n \"recurrenceType\": \"SINGLE\",\n \"referenceId\": \"INV-7755-1791463748\",\n \"referenceLabel\": \"Invoice\",\n \"description\": \"ENG-7755 webhook test\",\n \"creditAmount\": \"150.00\",\n \"creditCurrency\": \"USD\",\n \"debitCurrency\": \"USD\",\n \"nextPaymentDate\": null,\n \"lastPaymentDate\": null,\n \"paymentAttempts\": 0,\n \"startDate\": null,\n \"endDate\": null,\n \"collectionCount\": null,\n \"customFields\": {\n \"orderId\": \"ORD-99812\"\n },\n \"autopays\": []\n },\n \"transaction\": {\n \"id\": \"uspay-echo1fuz76usacpgicexz5vb\",\n \"createdAt\": \"2026-10-08T12:51:39.147Z\",\n \"updatedAt\": \"2026-10-08T12:51:46.302Z\",\n \"completedAt\": null,\n \"status\": \"USER_DEDUCTED\",\n \"previousStatus\": \"PROCESSING\",\n \"statusReason\": null,\n \"debitAmount\": \"150.00\",\n \"debitCurrency\": \"USD\",\n \"creditAmount\": \"150.00\",\n \"creditCurrency\": \"USD\",\n \"fee\": \"0.00\"\n }\n}"},{"language":"json","filename":"PaymentLinkTransactionSucceeded","code":"{\n \"paymentLink\": {\n \"id\": \"usmer-n1hpx2d89pdpnmpdjlorb995\",\n \"createdAt\": \"2026-10-08T12:49:09.223Z\",\n \"updatedAt\": \"2026-10-08T12:49:09.223Z\",\n \"linkToken\": \"fb78cf90-cf34-44d3-b3d3-074168b8c81a\",\n \"userId\": null,\n \"status\": \"ACTIVE\",\n \"statusReason\": null,\n \"initialAccessBy\": \"2026-10-09T12:49:09.194Z\",\n \"merchantId\": \"usmer-rtn86be1xb9jzb5qwib6z0i9\",\n \"recurrenceType\": \"SINGLE\",\n \"referenceId\": \"INV-7755-1791463748\",\n \"referenceLabel\": \"Invoice\",\n \"description\": \"ENG-7755 webhook test\",\n \"creditAmount\": \"150.00\",\n \"creditCurrency\": \"USD\",\n \"debitCurrency\": \"USD\",\n \"nextPaymentDate\": null,\n \"lastPaymentDate\": null,\n \"paymentAttempts\": 0,\n \"startDate\": null,\n \"endDate\": null,\n \"collectionCount\": null,\n \"customFields\": {\n \"orderId\": \"ORD-99812\"\n },\n \"autopays\": []\n },\n \"transaction\": {\n \"id\": \"uspay-echo1fuz76usacpgicexz5vb\",\n \"createdAt\": \"2026-10-08T12:51:39.147Z\",\n \"updatedAt\": \"2026-10-08T12:51:49.571Z\",\n \"completedAt\": \"2026-10-08T12:51:49.570Z\",\n \"status\": \"COMPLETED\",\n \"previousStatus\": \"USER_DEDUCTED\",\n \"statusReason\": null,\n \"debitAmount\": \"150.00\",\n \"debitCurrency\": \"USD\",\n \"creditAmount\": \"150.00\",\n \"creditCurrency\": \"USD\",\n \"fee\": \"0.00\"\n }\n}"},{"language":"json","filename":"PaymentLinkTransactionFailed","code":"{\n \"paymentLink\": {\n \"id\": \"usmer-n1hpx2d89pdpnmpdjlorb995\",\n \"createdAt\": \"2026-10-08T12:49:09.223Z\",\n \"updatedAt\": \"2026-10-08T12:49:09.223Z\",\n \"linkToken\": \"fb78cf90-cf34-44d3-b3d3-074168b8c81a\",\n \"userId\": null,\n \"status\": \"ACTIVE\",\n \"statusReason\": null,\n \"initialAccessBy\": \"2026-10-09T12:49:09.194Z\",\n \"merchantId\": \"usmer-rtn86be1xb9jzb5qwib6z0i9\",\n \"recurrenceType\": \"SINGLE\",\n \"referenceId\": \"INV-7755-1791463748\",\n \"referenceLabel\": \"Invoice\",\n \"description\": \"ENG-7755 webhook test\",\n \"creditAmount\": \"150.00\",\n \"creditCurrency\": \"USD\",\n \"debitCurrency\": \"USD\",\n \"nextPaymentDate\": null,\n \"lastPaymentDate\": null,\n \"paymentAttempts\": 0,\n \"startDate\": null,\n \"endDate\": null,\n \"collectionCount\": null,\n \"customFields\": {\n \"orderId\": \"ORD-99812\"\n },\n \"autopays\": []\n },\n \"transaction\": {\n \"id\": \"uspay-echo1fuz76usacpgicexz5vb\",\n \"createdAt\": \"2026-10-08T12:51:39.147Z\",\n \"updatedAt\": \"2026-10-08T12:51:44.218Z\",\n \"completedAt\": null,\n \"status\": \"FAILED\",\n \"previousStatus\": \"PROCESSING\",\n \"statusReason\": \"INSUFFICIENT_FUNDS\",\n \"debitAmount\": \"150.00\",\n \"debitCurrency\": \"USD\",\n \"creditAmount\": \"150.00\",\n \"creditCurrency\": \"USD\",\n \"fee\": \"0.00\"\n }\n}"}],"requestExampleType":"webhook","responseExampleType":"generated"},"dependencies":{"parameters":{"e1a7ae45-60a6-45b6-a4b0-f5f5d5a6f4af":{"name":"X-Meridian-Resource-Type","in":"header","required":true,"description":"Resource type carried by the webhook.","schema":{"type":"string","const":"payment_link_transaction","isRequired":true,"description":"Resource type carried by the webhook.","uniqueKey":"","typeLabel":"string"}},"44c12b5c-22f3-4f03-8e6b-c074c8cbaa70":{"name":"X-Meridian-Event-Type","in":"header","required":true,"description":"The payment link transaction event that occurred.","schema":{"type":"string","enum":["payment_link_transaction_created","payment_link_transaction_status_updated","payment_link_transaction_succeeded","payment_link_transaction_failed"],"isRequired":true,"description":"The payment link transaction event that occurred.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"ef5ba0a1-7a54-4267-a82d-10b4bd5f92e3":{"name":"X-Meridian-Api-Key","in":"header","required":false,"description":"API key issued by Meridian, sent so you can authenticate the webhook. Sent only when your webhook endpoint is configured for Meridian HMAC signing.","schema":{"type":"string","isRequired":false,"description":"API key issued by Meridian, sent so you can authenticate the webhook. Sent only when your webhook endpoint is configured for Meridian HMAC signing.","uniqueKey":"","typeLabel":"string"}},"27c66df3-7442-4587-a52f-8b0b9eb57f4b":{"name":"X-Meridian-Timestamp","in":"header","required":false,"description":"Time the webhook was generated, in milliseconds since the Unix epoch. Sent only when your webhook endpoint is configured for Meridian HMAC signing.","schema":{"type":"string","isRequired":false,"description":"Time the webhook was generated, in milliseconds since the Unix epoch. Sent only when your webhook endpoint is configured for Meridian HMAC signing.","uniqueKey":"","typeLabel":"string"}},"5d3db7c2-ba8f-4acb-9ec3-2aadec5d301f":{"name":"X-Meridian-Signature","in":"header","required":false,"description":"HMAC SHA-256 signature of the webhook request, for verifying that Meridian sent it. Sent only when your webhook endpoint is configured for Meridian HMAC signing.","schema":{"type":"string","isRequired":false,"description":"HMAC SHA-256 signature of the webhook request, for verifying that Meridian sent it. Sent only when your webhook endpoint is configured for Meridian HMAC signing.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"description":"The payment link and the transaction the event relates to.","content":{"application/json":{"schema":{"type":"object","description":"Webhook payload sent when a payment link transaction is created or changes status. The body has no envelope. The event name is in the `X-Meridian-Event-Type` header.","properties":{"paymentLink":{"type":"object","description":"The payment link the transaction belongs to, as it was when Meridian sent the webhook. The link and the transaction are updated separately, so the link's `status` can lag the transaction. Use `transaction.status` as the source of truth for the payment outcome.","properties":{"id":{"type":"string","description":"Unique id of the payment link.","title":"String","isRequired":true,"uniqueKey":"paymentLink.id","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","description":"ISO-8601 timestamp (UTC) when the payment link was created.","title":"Instant","isRequired":true,"uniqueKey":"paymentLink.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"ISO-8601 timestamp (UTC) when the payment link was last updated.","title":"Instant","isRequired":true,"uniqueKey":"paymentLink.updatedAt","typeLabel":"string\u003cdate-time>"},"linkToken":{"type":"string","description":"Non-guessable, URL-safe token that uniquely identifies the payment link and is exposed in payment URLs.","title":"String","isRequired":true,"uniqueKey":"paymentLink.linkToken","typeLabel":"string"},"status":{"type":"string","description":"Current status of the payment link.","enum":["ACTIVE","PROCESSING","FAILED","INACTIVE","EXPIRED","LOCKED","ARCHIVED","COMPLETED"],"title":"PaymentLinkStatus","isRequired":true,"uniqueKey":"paymentLink.status","typeLabel":"enum\u003cstring>"},"initialAccessBy":{"type":"string","format":"date-time","description":"ISO-8601 timestamp (UTC) by which the payment link must first be accessed. If it is not accessed by this time it expires and becomes invalid. The expiry window is set in the merchant configuration.","title":"Instant","isRequired":true,"uniqueKey":"paymentLink.initialAccessBy","typeLabel":"string\u003cdate-time>"},"merchantId":{"type":"string","description":"Unique identifier of the merchant that owns the payment link.","title":"String","isRequired":true,"uniqueKey":"paymentLink.merchantId","typeLabel":"string"},"recurrenceType":{"type":"string","description":"How the payment link handles recurrence.","enum":["SINGLE","RECURRING","VARIABLE"],"title":"PaymentLinkRecurrenceType","isRequired":true,"uniqueKey":"paymentLink.recurrenceType","typeLabel":"enum\u003cstring>"},"referenceLabel":{"type":"string","description":"Human-readable label for the payment link.","title":"String","isRequired":true,"uniqueKey":"paymentLink.referenceLabel","typeLabel":"string"},"creditCurrency":{"type":"string","description":"ISO-4217 currency code the merchant is paid out in.","enum":["EUR","USD","GBP","PHP","MXN","ZAR","USDC_ETH","USDC_SOL","USDT_ETH","USDT_SOL"],"title":"MeridianCurrency","isRequired":true,"uniqueKey":"paymentLink.creditCurrency","typeLabel":"enum\u003cstring>"},"debitCurrency":{"type":"string","description":"ISO-4217 currency code debited from the payer.","enum":["EUR","USD","GBP","PHP","MXN","ZAR","USDC_ETH","USDC_SOL","USDT_ETH","USDT_SOL"],"title":"MeridianCurrency","isRequired":true,"uniqueKey":"paymentLink.debitCurrency","typeLabel":"enum\u003cstring>"},"paymentAttempts":{"type":"integer","description":"Number of payment attempts initiated for the payment link.","title":"Int","isRequired":true,"uniqueKey":"paymentLink.paymentAttempts","typeLabel":"integer"},"userId":{"oneOf":[{"type":"string","description":"Meridian user id of the payer who attempted payment on this link, when one has.","title":"String","uniqueKey":"paymentLink.userId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Meridian user id of the payer who attempted payment on this link, when one has.","title":"String","uniqueKey":"paymentLink.userId.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentLink.userId","typeLabel":"string | null"},"statusReason":{"oneOf":[{"type":"string","description":"Optional detail about the current status of the payment link.","title":"String","uniqueKey":"paymentLink.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional detail about the current status of the payment link.","title":"String","uniqueKey":"paymentLink.statusReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentLink.statusReason","typeLabel":"string | null"},"referenceId":{"oneOf":[{"type":"string","description":"Unique reference defined by the merchant to identify the payment link. Not shown to customers on single payment links.","title":"String","uniqueKey":"paymentLink.referenceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique reference defined by the merchant to identify the payment link. Not shown to customers on single payment links.","title":"String","uniqueKey":"paymentLink.referenceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentLink.referenceId","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Optional human-readable description for the payment link.","title":"String","uniqueKey":"paymentLink.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional human-readable description for the payment link.","title":"String","uniqueKey":"paymentLink.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentLink.description","typeLabel":"string | null"},"creditAmount":{"oneOf":[{"type":"string","description":"Amount collected per charge, returned as a decimal string such as `\"100.50\"`. Null for `VARIABLE` links whose amount has not been set yet.","title":"BigDecimal","uniqueKey":"paymentLink.creditAmount.oneOf.0","typeLabel":"string"},{"type":"null","description":"Amount collected per charge, returned as a decimal string such as `\"100.50\"`. Null for `VARIABLE` links whose amount has not been set yet.","title":"BigDecimal","uniqueKey":"paymentLink.creditAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentLink.creditAmount","typeLabel":"string | null"},"nextPaymentDate":{"oneOf":[{"type":"string","format":"date","description":"Pre-calculated date of the next scheduled payment.","title":"LocalDate","uniqueKey":"paymentLink.nextPaymentDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Pre-calculated date of the next scheduled payment.","title":"LocalDate","uniqueKey":"paymentLink.nextPaymentDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentLink.nextPaymentDate","typeLabel":"string\u003cdate> | null"},"lastPaymentDate":{"oneOf":[{"type":"string","format":"date","description":"Date the most recent payment attempt was initiated for the payment link.","title":"LocalDate","uniqueKey":"paymentLink.lastPaymentDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Date the most recent payment attempt was initiated for the payment link.","title":"LocalDate","uniqueKey":"paymentLink.lastPaymentDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentLink.lastPaymentDate","typeLabel":"string\u003cdate> | null"},"startDate":{"oneOf":[{"type":"string","format":"date","description":"Start date from which the payment link can be paid. Payments are not allowed before this date.","title":"LocalDate","uniqueKey":"paymentLink.startDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Start date from which the payment link can be paid. Payments are not allowed before this date.","title":"LocalDate","uniqueKey":"paymentLink.startDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentLink.startDate","typeLabel":"string\u003cdate> | null"},"endDate":{"oneOf":[{"type":"string","format":"date","description":"End date after which the payment link can no longer be paid.","title":"LocalDate","uniqueKey":"paymentLink.endDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"End date after which the payment link can no longer be paid.","title":"LocalDate","uniqueKey":"paymentLink.endDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentLink.endDate","typeLabel":"string\u003cdate> | null"},"collectionCount":{"oneOf":[{"type":"integer","description":"Number of installments the payer will be charged.","title":"Int","uniqueKey":"paymentLink.collectionCount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of installments the payer will be charged.","title":"Int","uniqueKey":"paymentLink.collectionCount.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentLink.collectionCount","typeLabel":"integer | null"},"customFields":{"oneOf":[{"type":"object","description":"Key-value map of custom fields defined by the merchant.","additionalProperties":{"type":"string","description":"Value of the custom field, as a string.","uniqueKey":"paymentLink.customFields.oneOf.0.additionalProperties","typeLabel":"string"},"title":"Map_String_String","uniqueKey":"paymentLink.customFields.oneOf.0","typeLabel":"Map_String_String · object"},{"type":"null","description":"Key-value map of custom fields defined by the merchant.","additionalProperties":{"type":"string","description":"Value of the custom field, as a string.","uniqueKey":"paymentLink.customFields.oneOf.1.additionalProperties","typeLabel":"string"},"title":"Map_String_String","uniqueKey":"paymentLink.customFields.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentLink.customFields","typeLabel":"Map_String_String · object | null"},"autopays":{"type":"array","description":"Auto pays set up by the payer to automatically collect payments on recurring links. Empty when none are configured.","items":{"type":"object","description":"An auto pay configured to automatically collect payments for a recurring payment link.","properties":{"id":{"type":"string","description":"Unique id of the auto pay.","title":"String","isRequired":true,"uniqueKey":"paymentLink.autopays.items.[INDEX].id","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","description":"ISO-8601 timestamp (UTC) when the auto pay was created.","title":"Instant","isRequired":true,"uniqueKey":"paymentLink.autopays.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"ISO-8601 timestamp (UTC) when the auto pay was last updated.","title":"Instant","isRequired":true,"uniqueKey":"paymentLink.autopays.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","description":"Current status of the auto pay.","enum":["ACTIVE","INACTIVE","EXPIRED"],"title":"AutopayStatus","isRequired":true,"uniqueKey":"paymentLink.autopays.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"type":"string","description":"Optional detail about the current status of the auto pay.","title":"String","uniqueKey":"paymentLink.autopays.items.[INDEX].statusReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional detail about the current status of the auto pay.","title":"String","uniqueKey":"paymentLink.autopays.items.[INDEX].statusReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentLink.autopays.items.[INDEX].statusReason","typeLabel":"string | null"},"scheduleDay":{"oneOf":[{"type":"integer","description":"Day of the month on which the payment is scheduled to occur, as configured by the payer. Set for recurring payment links.","title":"Int","uniqueKey":"paymentLink.autopays.items.[INDEX].scheduleDay.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Day of the month on which the payment is scheduled to occur, as configured by the payer. Set for recurring payment links.","title":"Int","uniqueKey":"paymentLink.autopays.items.[INDEX].scheduleDay.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentLink.autopays.items.[INDEX].scheduleDay","typeLabel":"integer | null"}},"required":["id","createdAt","updatedAt","status"],"title":"Autopay","uniqueKey":"paymentLink.autopays.items.[INDEX]","typeLabel":"Autopay · object"},"title":"Array_Autopay","uniqueKey":"paymentLink.autopays","typeLabel":"Autopay · object[]"}},"required":["id","createdAt","updatedAt","linkToken","status","initialAccessBy","merchantId","recurrenceType","referenceLabel","creditCurrency","debitCurrency","paymentAttempts"],"title":"PaymentLink","isRequired":true,"uniqueKey":"paymentLink","typeLabel":"PaymentLink · object"},"transaction":{"type":"object","description":"The transaction and the status change that triggered the event.","properties":{"id":{"type":"string","description":"Unique id of the transaction.","isRequired":true,"uniqueKey":"transaction.id","typeLabel":"string"},"createdAt":{"type":"string","description":"Timestamp (UTC) when the transaction was created, formatted as `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.","format":"date-time","isRequired":true,"uniqueKey":"transaction.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","description":"Timestamp (UTC) when the transaction was last updated, formatted as `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`. Use it to order events for the same transaction.","format":"date-time","isRequired":true,"uniqueKey":"transaction.updatedAt","typeLabel":"string\u003cdate-time>"},"completedAt":{"oneOf":[{"type":"string","description":"Timestamp (UTC) when the transaction completed, formatted as `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`. Null until the transaction is completed.","format":"date-time","isRequired":true,"uniqueKey":"transaction.completedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Timestamp (UTC) when the transaction completed, formatted as `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`. Null until the transaction is completed.","format":"date-time","isRequired":true,"uniqueKey":"transaction.completedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"transaction.completedAt","typeLabel":"string\u003cdate-time> | null"},"status":{"type":"string","description":"Name of the transaction status after this change, such as `PENDING`, `PROCESSING`, `USER_DEDUCTED`, `COMPLETED`, or `FAILED`. Treat this field as the source of truth. See [Tracking a payment link payment with webhooks](/products/realtime-collections/tracking-payments-with-webhooks) for the statuses each event covers.","isRequired":true,"uniqueKey":"transaction.status","typeLabel":"string"},"previousStatus":{"oneOf":[{"type":"string","description":"Name of the status before this change. Null on `payment_link_transaction_created`.","isRequired":true,"uniqueKey":"transaction.previousStatus.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the status before this change. Null on `payment_link_transaction_created`.","isRequired":true,"uniqueKey":"transaction.previousStatus.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"transaction.previousStatus","typeLabel":"string | null"},"statusReason":{"oneOf":[{"type":"string","description":"The failure reason, when there is one. Otherwise null.","isRequired":true,"uniqueKey":"transaction.statusReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The failure reason, when there is one. Otherwise null.","isRequired":true,"uniqueKey":"transaction.statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"transaction.statusReason","typeLabel":"string | null"},"debitAmount":{"type":"string","description":"Amount the payer paid, as a decimal string such as `\"150.00\"`.","isRequired":true,"uniqueKey":"transaction.debitAmount","typeLabel":"string"},"debitCurrency":{"type":"string","description":"ISO-4217 currency code of the amount the payer paid.","enum":["EUR","USD","GBP","PHP","MXN","ZAR","USDC_ETH","USDC_SOL","USDT_ETH","USDT_SOL"],"title":"MeridianCurrency","isRequired":true,"uniqueKey":"transaction.debitCurrency","typeLabel":"enum\u003cstring>"},"creditAmount":{"type":"string","description":"Amount the merchant receives, as a decimal string such as `\"150.00\"`.","isRequired":true,"uniqueKey":"transaction.creditAmount","typeLabel":"string"},"creditCurrency":{"type":"string","description":"ISO-4217 currency code of the amount the merchant receives.","enum":["EUR","USD","GBP","PHP","MXN","ZAR","USDC_ETH","USDC_SOL","USDT_ETH","USDT_SOL"],"title":"MeridianCurrency","isRequired":true,"uniqueKey":"transaction.creditCurrency","typeLabel":"enum\u003cstring>"},"fee":{"oneOf":[{"type":"string","description":"Fee charged on the transaction, as a decimal string. Null when there is no fee value.","isRequired":true,"uniqueKey":"transaction.fee.oneOf.0","typeLabel":"string"},{"type":"null","description":"Fee charged on the transaction, as a decimal string. Null when there is no fee value.","isRequired":true,"uniqueKey":"transaction.fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"transaction.fee","typeLabel":"string | null"}},"required":["id","createdAt","updatedAt","completedAt","status","previousStatus","statusReason","debitAmount","debitCurrency","creditAmount","creditCurrency","fee"],"title":"PaymentLinkTransactionNotification","isRequired":true,"uniqueKey":"transaction","typeLabel":"PaymentLinkTransactionNotification · object"}},"required":["paymentLink","transaction"],"title":"PaymentLinkTransactionWebhook","uniqueKey":"","typeLabel":"PaymentLinkTransactionWebhook · object"},"examples":{"PaymentLinkTransactionCreated":{"title":"PaymentLinkTransactionCreated","summary":"payment_link_transaction_created event payload","value":{"paymentLink":{"id":"usmer-n1hpx2d89pdpnmpdjlorb995","createdAt":"2026-10-08T12:49:09.223Z","updatedAt":"2026-10-08T12:49:09.223Z","linkToken":"fb78cf90-cf34-44d3-b3d3-074168b8c81a","userId":null,"status":"ACTIVE","statusReason":null,"initialAccessBy":"2026-10-09T12:49:09.194Z","merchantId":"usmer-rtn86be1xb9jzb5qwib6z0i9","recurrenceType":"SINGLE","referenceId":"INV-7755-1791463748","referenceLabel":"Invoice","description":"ENG-7755 webhook test","creditAmount":"150.00","creditCurrency":"USD","debitCurrency":"USD","nextPaymentDate":null,"lastPaymentDate":null,"paymentAttempts":0,"startDate":null,"endDate":null,"collectionCount":null,"customFields":{"orderId":"ORD-99812"},"autopays":[]},"transaction":{"id":"uspay-echo1fuz76usacpgicexz5vb","createdAt":"2026-10-08T12:51:39.147Z","updatedAt":"2026-10-08T12:51:39.147Z","completedAt":null,"status":"PENDING","previousStatus":null,"statusReason":null,"debitAmount":"150.00","debitCurrency":"USD","creditAmount":"150.00","creditCurrency":"USD","fee":"0.00"}}},"PaymentLinkTransactionStatusUpdated":{"title":"PaymentLinkTransactionStatusUpdated","summary":"payment_link_transaction_status_updated event payload","value":{"paymentLink":{"id":"usmer-n1hpx2d89pdpnmpdjlorb995","createdAt":"2026-10-08T12:49:09.223Z","updatedAt":"2026-10-08T12:49:09.223Z","linkToken":"fb78cf90-cf34-44d3-b3d3-074168b8c81a","userId":null,"status":"ACTIVE","statusReason":null,"initialAccessBy":"2026-10-09T12:49:09.194Z","merchantId":"usmer-rtn86be1xb9jzb5qwib6z0i9","recurrenceType":"SINGLE","referenceId":"INV-7755-1791463748","referenceLabel":"Invoice","description":"ENG-7755 webhook test","creditAmount":"150.00","creditCurrency":"USD","debitCurrency":"USD","nextPaymentDate":null,"lastPaymentDate":null,"paymentAttempts":0,"startDate":null,"endDate":null,"collectionCount":null,"customFields":{"orderId":"ORD-99812"},"autopays":[]},"transaction":{"id":"uspay-echo1fuz76usacpgicexz5vb","createdAt":"2026-10-08T12:51:39.147Z","updatedAt":"2026-10-08T12:51:46.302Z","completedAt":null,"status":"USER_DEDUCTED","previousStatus":"PROCESSING","statusReason":null,"debitAmount":"150.00","debitCurrency":"USD","creditAmount":"150.00","creditCurrency":"USD","fee":"0.00"}}},"PaymentLinkTransactionSucceeded":{"title":"PaymentLinkTransactionSucceeded","summary":"payment_link_transaction_succeeded event payload","value":{"paymentLink":{"id":"usmer-n1hpx2d89pdpnmpdjlorb995","createdAt":"2026-10-08T12:49:09.223Z","updatedAt":"2026-10-08T12:49:09.223Z","linkToken":"fb78cf90-cf34-44d3-b3d3-074168b8c81a","userId":null,"status":"ACTIVE","statusReason":null,"initialAccessBy":"2026-10-09T12:49:09.194Z","merchantId":"usmer-rtn86be1xb9jzb5qwib6z0i9","recurrenceType":"SINGLE","referenceId":"INV-7755-1791463748","referenceLabel":"Invoice","description":"ENG-7755 webhook test","creditAmount":"150.00","creditCurrency":"USD","debitCurrency":"USD","nextPaymentDate":null,"lastPaymentDate":null,"paymentAttempts":0,"startDate":null,"endDate":null,"collectionCount":null,"customFields":{"orderId":"ORD-99812"},"autopays":[]},"transaction":{"id":"uspay-echo1fuz76usacpgicexz5vb","createdAt":"2026-10-08T12:51:39.147Z","updatedAt":"2026-10-08T12:51:49.571Z","completedAt":"2026-10-08T12:51:49.570Z","status":"COMPLETED","previousStatus":"USER_DEDUCTED","statusReason":null,"debitAmount":"150.00","debitCurrency":"USD","creditAmount":"150.00","creditCurrency":"USD","fee":"0.00"}}},"PaymentLinkTransactionFailed":{"title":"PaymentLinkTransactionFailed","summary":"payment_link_transaction_failed event payload","value":{"paymentLink":{"id":"usmer-n1hpx2d89pdpnmpdjlorb995","createdAt":"2026-10-08T12:49:09.223Z","updatedAt":"2026-10-08T12:49:09.223Z","linkToken":"fb78cf90-cf34-44d3-b3d3-074168b8c81a","userId":null,"status":"ACTIVE","statusReason":null,"initialAccessBy":"2026-10-09T12:49:09.194Z","merchantId":"usmer-rtn86be1xb9jzb5qwib6z0i9","recurrenceType":"SINGLE","referenceId":"INV-7755-1791463748","referenceLabel":"Invoice","description":"ENG-7755 webhook test","creditAmount":"150.00","creditCurrency":"USD","debitCurrency":"USD","nextPaymentDate":null,"lastPaymentDate":null,"paymentAttempts":0,"startDate":null,"endDate":null,"collectionCount":null,"customFields":{"orderId":"ORD-99812"},"autopays":[]},"transaction":{"id":"uspay-echo1fuz76usacpgicexz5vb","createdAt":"2026-10-08T12:51:39.147Z","updatedAt":"2026-10-08T12:51:44.218Z","completedAt":null,"status":"FAILED","previousStatus":"PROCESSING","statusReason":"INSUFFICIENT_FUNDS","debitAmount":"150.00","debitCurrency":"USD","creditAmount":"150.00","creditCurrency":"USD","fee":"0.00"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"9398e254-a593-4984-9847-104a88f707ef":{"description":"Return any 2xx status to acknowledge the webhook. Any other status causes Meridian to retry.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{},"servers":{"cb097a76-bf59-444e-b5d5-f3c9e344bce6":{"url":"https://us-merchant.sandbox.api-us.meridianapps.dev","description":"Sandbox"},"ae2d55d2-8382-465f-95d2-1f36ce9d6374":{"url":"https://us-merchant.api-us.payments.meridianpay.com","description":"Production"}}},"originalFileLocation":"products/realtime-collections/api-reference/payment-links.json"},"subdomain":"meridian-18e67158","siteName":"Meridian","title":"Payment Link Transaction - Meridian","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-13T13:24:39.773Z","originalFileLocation":"products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction.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=\"light\"}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=\"Learn when the payment link transaction webhooks are sent and what data they include.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Meridian\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/meridian-18e67158/WzlFd2UpES2XpXP8/_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/meridian-18e67158/WzlFd2UpES2XpXP8/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/meridian-18e67158/WzlFd2UpES2XpXP8/_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/meridian-18e67158/WzlFd2UpES2XpXP8/_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/meridian-18e67158/WzlFd2UpES2XpXP8/_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/meridian-18e67158/WzlFd2UpES2XpXP8/_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/meridian-18e67158/WzlFd2UpES2XpXP8/_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/meridian-18e67158/WzlFd2UpES2XpXP8/_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/meridian-18e67158/WzlFd2UpES2XpXP8/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Payment Link Transaction - Meridian\">\u003cmeta data-mint-head property=\"og:description\" content=\"Learn when the payment link transaction webhooks are sent and what data they include.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Meridian\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.mnai.com/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://meridian-18e67158.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Payment+Link+Transaction\u0026amp;description=Learn+when+the+payment+link+transaction+webhooks+are+sent+and+what+data+they+include.\u0026amp;theme=6576e5154a5879feed8f84c7\u0026amp;signature=5025565a2a6f61a92c9db5bd9ddad33172bbad6fa6421b942d21836b065b5336\">\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=\"Payment Link Transaction - Meridian\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Learn when the payment link transaction webhooks are sent and what data they include.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://meridian-18e67158.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Payment+Link+Transaction\u0026amp;description=Learn+when+the+payment+link+transaction+webhooks+are+sent+and+what+data+they+include.\u0026amp;theme=6576e5154a5879feed8f84c7\u0026amp;signature=5025565a2a6f61a92c9db5bd9ddad33172bbad6fa6421b942d21836b065b5336\">\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/meridian-18e67158/WzlFd2UpES2XpXP8/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Meridian\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A0A0A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.mnai.com/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.mnai.com/#organization\",\"name\":\"Meridian\",\"url\":\"https://docs.mnai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/meridian-18e67158/VgZYEMrM1D9FVN_L/logo/meridian-light.svg?fit=max\u0026auto=format\u0026n=VgZYEMrM1D9FVN_L\u0026q=85\u0026s=165e274c2a61a48b1bbeb002a86899a0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.mnai.com#website\",\"name\":\"Meridian\",\"url\":\"https://docs.mnai.com\",\"publisher\":{\"@id\":\"https://docs.mnai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.mnai.com/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction#webpage\",\"url\":\"https://docs.mnai.com/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction\",\"name\":\"Payment Link Transaction\",\"description\":\"Learn when the payment link transaction webhooks are sent and what data they include.\",\"dateModified\":\"2026-10-13T13:24:39.773Z\",\"isPartOf\":{\"@id\":\"https://docs.mnai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.mnai.com/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.mnai.com/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.mnai.com/products/realtime-collections/api-reference\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Webhooks\",\"item\":\"https://docs.mnai.com/products/realtime-collections/api-reference/webhooks/webhooks-payment-link\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Payment Link Transaction\",\"item\":\"https://docs.mnai.com/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.mnai.com/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction#apireference\",\"headline\":\"Payment Link Transaction\",\"name\":\"Payment Link Transaction\",\"description\":\"Learn when the payment link transaction webhooks are sent and what data they include.\",\"url\":\"https://docs.mnai.com/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.mnai.com/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction#webpage\"},\"dateModified\":\"2026-10-13T13:24:39.773Z\",\"publisher\":{\"@id\":\"https://docs.mnai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.mnai.com#website\"}}]}\u003c/script>","agentPointerHref":"/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction.md","siteName":"Meridian","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"list","href":"/changelog"}]},"products":[{"product":"Retail U.S. Accounts","pages":[{"title":"Retail U.S. Accounts","href":"/products/retail-va"}]},{"product":"Meridian Accounts for Business","hidden":false,"pages":[{"title":"Meridian Accounts for Business","href":"/products/meridian-accounts/guides/getting-started"}]},{"product":"Payout Origination","pages":[{"title":"Payout Origination","href":"/products/payout-origination/overview"}]},{"product":"Bank Transfers","pages":[{"title":"Bank Transfers","href":"/products/bank-transfers/overview"}]},{"product":"Realtime Collections","pages":[{"title":"Realtime Collections","sidebarTitle":"Overview","href":"/products/realtime-collections"},{"group":"Getting Started","pages":[{"title":"Request a Sandbox","href":"/products/realtime-collections/sandbox"},{"title":"Authentication","href":"/products/realtime-collections/authentication"},{"title":"Webhooks","href":"/products/realtime-collections/webhooks-overview"}]},{"group":"Integration Guide","pages":[{"title":"Creating a payment link and sending a buyer to pay","sidebarTitle":"Collect a payment","href":"/products/realtime-collections/sending-a-buyer-to-pay"},{"title":"Tracking a payment link payment with webhooks","sidebarTitle":"Track payments","href":"/products/realtime-collections/tracking-payments-with-webhooks"},{"title":"Simulating failed payments","sidebarTitle":"Test failed payments","href":"/products/realtime-collections/simulating-failed-payments"}]},{"group":"API Reference","pages":[{"title":"Introduction","href":"/products/realtime-collections/api-reference/index"},{"group":"Sessions","pages":[{"title":"Create a Session","openapi":"products/realtime-collections/api-reference/payment-links.json POST /v1/payment-links/sessions","href":"/products/realtime-collections/api-reference/sessions/create-session"}]},{"group":"Payment Links","pages":[{"title":"Create a Payment Link","openapi":"products/realtime-collections/api-reference/payment-links.json POST /v1/payment-links","href":"/products/realtime-collections/api-reference/payment-links/create-payment-link"},{"title":"Update a Payment Link","openapi":"products/realtime-collections/api-reference/payment-links.json PATCH /v1/payment-links/{id}","href":"/products/realtime-collections/api-reference/payment-links/update-payment-link"},{"title":"Retrieve a Payment Link","openapi":"products/realtime-collections/api-reference/payment-links.json GET /v1/payment-links/{id}","href":"/products/realtime-collections/api-reference/payment-links/get-payment-link"}]},{"group":"Webhooks","pages":[{"title":"Payment Link","description":"Learn when the payment link webhook is sent and what data it includes.","openapi":"products/realtime-collections/api-reference/payment-links.json webhook payment_link","href":"/products/realtime-collections/api-reference/webhooks/webhooks-payment-link"},{"title":"Payment Link Transaction","openapi":"products/realtime-collections/api-reference/payment-links.json webhook payment_link_transaction","href":"/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction"}]}]}]}]},"basePath":"","title":"Payment Link Transaction - Meridian","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}