Requires scope:manage:pay-in-sessions — see Required scopes.Reads one settlement record. The payInId comes from a PAY_IN_SETTLED or PAY_IN_FAILEDwebhook. Unknown and foreign ids return the same 404 pay-in-not-found.Reconcile against netCryptoAmount — that is what reached the account wallet.
Which tenant the request is scoped to, among those your token grants. Omit it when the token
grants exactly one tenant; it is required when the token grants more than one. A supplied
value must exactly match a tenant the token grants.
Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets
the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones
you may use. Send the header once: a repeated header is rejected the same way.
Example:
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Path Parameters
payInId
string<uuid>
required
Unique pay-in identifier — the payInId from a PAY_IN_SETTLED or PAY_IN_FAILED event
Response
The pay-in
success
boolean
Indicates whether the request was successful
result
object
A pay-in settlement record — one fiat credit, its conversion, and the crypto credited to the
account wallet. Amounts are exact decimal strings. Nullable fields are omitted when absent,
never substituted with zero. Provider references, raw failure text, internal transaction
identifiers and idempotency keys are not exposed.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Venly Finance","colors":{"primary":"#e07826","light":"#f0a060","dark":"#c56820"},"logo":{"light":"https://mintcdn.com/venly/NZGy1d4c4LA-0jM9/logo/light_venly_logo.png?fit=max\u0026auto=format\u0026n=NZGy1d4c4LA-0jM9\u0026q=85\u0026s=d808fd8f702829ca93bf607f200800bb","dark":"https://mintcdn.com/venly/NZGy1d4c4LA-0jM9/logo/dark_venly_logo.png?fit=max\u0026auto=format\u0026n=NZGy1d4c4LA-0jM9\u0026q=85\u0026s=3bafc93202007edf53e789ed58bc7002","href":"https://venlyfinance.com"},"favicon":"https://mintcdn.com/venly/MUxny2c1OXcZxLbW/logo/favicon_logo.png?fit=max\u0026auto=format\u0026n=MUxny2c1OXcZxLbW\u0026q=85\u0026s=892dd58ed49fe804011fcf42f60f82d4","api":{"playground":{"display":"interactive"}},"navbar":{"primary":{"type":"button","label":"Venly","href":"https://venlyfinance.com"}},"footer":{"socials":{"x":"https://x.com/Venly_io","linkedin":"https://be.linkedin.com/company/venly-io"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://venlyfinance.com/blog"},{"anchor":"Support","icon":"envelope","href":"https://venlyfinance.com/contact"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"venly","hasAudioNarration":false,"actualSubdomain":"venly","customDomains":["docs.venlyfinance.com"],"gitSource":{"type":"github","owner":"venly","repo":"mintlify-api-docs-main","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afaea070c14fe3987666c1e","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Finance API","count":98},{"language":"default","tag":"Fundflow API","count":45},{"language":"default","tag":"Parties","count":13},{"language":"default","tag":"Core Concepts","count":13},{"language":"default","tag":"Ramp Requests","count":12},{"language":"default","tag":"Overview","count":10},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Onboarding \u0026 Verification","count":9},{"language":"default","tag":"Accounts","count":6},{"language":"default","tag":"Getting Started","count":6}]},"assistantConfig":{},"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/Finance-API/pay-ins/get-a-pay-in","slug":"/api-reference/Finance-API/pay-ins/get-a-pay-in","pageMetadata":{"title":"Get a pay-in","description":"Read one pay-in by the id carried on the PAY_IN_SETTLED or PAY_IN_FAILED webhook.","openapi":"api-reference/Finance-API-Specs.yaml GET /pay-ins/{payInId}","href":"/api-reference/Finance-API/pay-ins/get-a-pay-in"},"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: \"Read one pay-in by the id carried on the PAY_IN_SETTLED or PAY_IN_FAILED webhook.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Requires scope:`}),` `,_jsx(_components.code,{children:`manage:pay-in-sessions`}),` — see `,_jsx(_components.a,{href:`/getting-started/authentication#required-scopes-finance-api`,children:`Required scopes`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Reads one settlement record. The `,_jsx(_components.code,{children:`payInId`}),` comes from a `,_jsx(_components.code,{children:`PAY_IN_SETTLED`}),` or `,_jsx(_components.code,{children:`PAY_IN_FAILED`}),` `,_jsx(_components.a,{href:`/guides/finance/webhooks#event-catalogue`,children:`webhook`}),`. Unknown and foreign ids return the same `,_jsx(_components.code,{children:`404 pay-in-not-found`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Reconcile against `,_jsx(_components.code,{children:`netCryptoAmount`}),` — that is what reached the account wallet.`]})]})}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":"Get a pay-in","description":"Read one pay-in by the id carried on the PAY_IN_SETTLED or PAY_IN_FAILED webhook.","openapi":"api-reference/Finance-API-Specs.yaml GET /pay-ins/{payInId}","href":"/api-reference/Finance-API/pay-ins/get-a-pay-in"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Pay-Ins"],"summary":"Get a pay-in","operationId":"getPayIn","description":"Read one pay-in by the id carried on the PAY_IN_SETTLED or PAY_IN_FAILED webhook.","parameters":["91e7389d-1a92-44b2-b9f5-73e4d36d0a1b"],"responses":{"200":"2ab5b23d-3979-4693-9418-6cedf98edbd4","400":"eb48ec79-2066-49d9-93ca-22418bb2ef65","401":"8ed34a11-4400-49e2-98a4-454533741a00","403":"d1aaa2e8-4673-4f91-a1f4-545c8272fd84","404":"ea8fef4d-f4c8-4328-b3ac-4336c83b08ed","500":"ab177a0f-9de7-40bb-9031-c3989b287215"},"method":"get","type":"path","servers":["7ccd99be-e28d-4721-9a67-da99d4352b21","9f7a6158-6efa-486c-991d-4d69199ecde2"],"security":["0e3ba47e-a570-40d0-b3e6-688cb37506b4"],"path":"/pay-ins/{payInId}","baseUrlOptions":["https://api.venlyfinance.com/v1","https://api-staging.venlyfinance.com/v1"],"title":"Get a pay-in","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"91e7389d-1a92-44b2-b9f5-73e4d36d0a1b":{"name":"payInId","in":"path","required":true,"description":"Unique pay-in identifier — the `payInId` from a `PAY_IN_SETTLED` or `PAY_IN_FAILED` event","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Unique pay-in identifier — the `payInId` from a `PAY_IN_SETTLED` or `PAY_IN_FAILED` event","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"0c1d2e3f-4a5b-4c6d-8e7f-90a1b2c3d4e5"},"092f48f0-d7eb-41f5-8e0f-d6246c5ef621":{"name":"x-tenant-id","in":"header","required":false,"description":"Which tenant the request is scoped to, among those your token grants. Omit it when the token\ngrants exactly one tenant; it is **required** when the token grants more than one. A supplied\nvalue must exactly match a tenant the token grants.\n\nAbsent when required, blank, malformed, or naming a tenant the token does not grant — each gets\nthe same generic `403 forbidden`, which reveals neither whether a tenant exists nor which ones\nyou may use. Send the header once: a repeated header is rejected the same way.\n","schema":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","isRequired":false,"description":"Which tenant the request is scoped to, among those your token grants. Omit it when the token\ngrants exactly one tenant; it is **required** when the token grants more than one. A supplied\nvalue must exactly match a tenant the token grants.\n\nAbsent when required, blank, malformed, or naming a tenant the token does not grant — each gets\nthe same generic `403 forbidden`, which reveals neither whether a tenant exists nor which ones\nyou may use. Send the header once: a repeated header is rejected the same way.\n","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"2ab5b23d-3979-4693-9418-6cedf98edbd4":{"description":"The pay-in","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful","uniqueKey":"success","typeLabel":"boolean"},"result":{"type":"object","description":"A pay-in settlement record — one fiat credit, its conversion, and the crypto credited to the\naccount wallet. Amounts are exact decimal strings. Nullable fields are omitted when absent,\nnever substituted with zero. Provider references, raw failure text, internal transaction\nidentifiers and idempotency keys are not exposed.\n","required":["id","virtualBankAccountId","accountWalletId","status","chain","cryptoAsset","fiatCurrency","grossCryptoAmount","netCryptoAmount","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Canonical pay-in id; matches `payInId` on the `PAY_IN_SETTLED` / `PAY_IN_FAILED` webhooks","isRequired":true,"uniqueKey":"result.id","typeLabel":"string\u003cuuid>"},"virtualBankAccountId":{"type":"string","format":"uuid","description":"The virtual bank account the fiat arrived on","isRequired":true,"uniqueKey":"result.virtualBankAccountId","typeLabel":"string\u003cuuid>"},"accountWalletId":{"type":"string","format":"uuid","description":"The account wallet the crypto was credited to","isRequired":true,"uniqueKey":"result.accountWalletId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Settlement lifecycle of a pay-in, independent of the initiating session's status.\n- `RECEIVED` — the fiat credit was observed\n- `SETTLING` — conversion and the on-chain credit are in progress\n- `SETTLED` — the crypto is in the account wallet. `PAY_IN_SETTLED` fires\n- `FAILED` — the deposit ended without crediting the account. `PAY_IN_FAILED` fires\n- `RETURNED` — the fiat was sent back to the payer\n","enum":["RECEIVED","SETTLING","SETTLED","FAILED","RETURNED"],"isRequired":true,"uniqueKey":"result.status","typeLabel":"enum\u003cstring>"},"chain":{"type":"string","description":"Supported blockchain network. Availability per chain depends on your company's configured\n`supportedChains` — see [Supported chains and assets](/guides/finance/supported-chains-and-assets).\n","enum":["AVALANCHE","BASE","ETHEREUM","POLYGON","SOLANA"],"isRequired":true,"uniqueKey":"result.chain","typeLabel":"enum\u003cstring>"},"cryptoAsset":{"type":"string","example":"USDC","isRequired":true,"uniqueKey":"result.cryptoAsset","typeLabel":"string"},"fiatCurrency":{"type":"string","example":"EUR","isRequired":true,"uniqueKey":"result.fiatCurrency","typeLabel":"string"},"grossCryptoAmount":{"type":"string","description":"The deposit as received, denominated in `cryptoAsset`. Today always equal to `netCryptoAmount`.","example":"108.42","isRequired":true,"uniqueKey":"result.grossCryptoAmount","typeLabel":"string"},"netCryptoAmount":{"type":"string","description":"What reached the account wallet, denominated in `cryptoAsset`. Reconcile against this.","example":"108.42","isRequired":true,"uniqueKey":"result.netCryptoAmount","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"result.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"result.updatedAt","typeLabel":"string\u003cdate-time>"},"accountId":{"oneOf":[{"type":"string","format":"uuid","description":"The account the deposit was attributed to. Absent when attribution is still pending.","uniqueKey":"result.accountId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The account the deposit was attributed to. Absent when attribution is still pending.","uniqueKey":"result.accountId.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.accountId","typeLabel":"string\u003cuuid> | null"},"grossFiatAmount":{"oneOf":[{"type":"string","description":"The fiat amount received. Informational; absent for some deposit types.","example":"100.00","uniqueKey":"result.grossFiatAmount.oneOf.0","typeLabel":"string"},{"type":"null","description":"The fiat amount received. Informational; absent for some deposit types.","example":"100.00","uniqueKey":"result.grossFiatAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.grossFiatAmount","typeLabel":"string | null"},"transactionHash":{"oneOf":[{"type":"string","description":"On-chain settlement transaction, once available","uniqueKey":"result.transactionHash.oneOf.0","typeLabel":"string"},{"type":"null","description":"On-chain settlement transaction, once available","uniqueKey":"result.transactionHash.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.transactionHash","typeLabel":"string | null"},"settledAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"result.settledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"result.settledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.settledAt","typeLabel":"string\u003cdate-time> | null"},"failedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"result.failedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"result.failedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.failedAt","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"result","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"result":{"id":"0c1d2e3f-4a5b-4c6d-8e7f-90a1b2c3d4e5","accountId":"b2a1f0e9-8c7d-4e3a-9f21-0a1b2c3d4e5f","virtualBankAccountId":"4d5e6f70-8192-4a3b-9c4d-5e6f7081920a","accountWalletId":"9f8e7d6c-5b4a-4938-8271-6a5b4c3d2e1f","status":"SETTLED","chain":"BASE","cryptoAsset":"USDC","fiatCurrency":"EUR","grossFiatAmount":"100.00","grossCryptoAmount":"108.42","netCryptoAmount":"108.42","transactionHash":"0x4f7a2c9e18b3d05a6c7e94f120d8b3a5e6f1c07d92b4a8e35f6c1d0b7a92e438","settledAt":"2026-08-19T09:14:52Z","failedAt":null,"createdAt":"2026-08-19T09:02:10Z","updatedAt":"2026-08-19T09:14:52Z"}},"examples":{"Example":{"title":"Example","value":{"success":true,"result":{"id":"0c1d2e3f-4a5b-4c6d-8e7f-90a1b2c3d4e5","accountId":"b2a1f0e9-8c7d-4e3a-9f21-0a1b2c3d4e5f","virtualBankAccountId":"4d5e6f70-8192-4a3b-9c4d-5e6f7081920a","accountWalletId":"9f8e7d6c-5b4a-4938-8271-6a5b4c3d2e1f","status":"SETTLED","chain":"BASE","cryptoAsset":"USDC","fiatCurrency":"EUR","grossFiatAmount":"100.00","grossCryptoAmount":"108.42","netCryptoAmount":"108.42","transactionHash":"0x4f7a2c9e18b3d05a6c7e94f120d8b3a5e6f1c07d92b4a8e35f6c1d0b7a92e438","settledAt":"2026-08-19T09:14:52Z","failedAt":null,"createdAt":"2026-08-19T09:02:10Z","updatedAt":"2026-08-19T09:14:52Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"eb48ec79-2066-49d9-93ca-22418bb2ef65":{"description":"Malformed `payInId` (must be a UUID)","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"invalid-request","message":"The request contains invalid parameters."}],"result":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"8ed34a11-4400-49e2-98a4-454533741a00":{"description":"Authentication required or failed (401)","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"unauthenticated","message":"Please authenticate to perform this action."}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"unauthenticated","message":"Please authenticate to perform this action."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"d1aaa2e8-4673-4f91-a1f4-545c8272fd84":{"description":"Caller lacks the required authority/role (403)","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"forbidden","message":"You do not have permission to access this resource."}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"forbidden","message":"You do not have permission to access this resource."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"ea8fef4d-f4c8-4328-b3ac-4336c83b08ed":{"description":"`pay-in-not-found` — unknown or foreign pay-in id","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"invalid-request","message":"The request contains invalid parameters."}],"result":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"ab177a0f-9de7-40bb-9031-c3989b287215":{"description":"Unexpected server error (500)","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","description":"Always false for error responses","example":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","description":"List of errors that occurred","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid-request","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"The request contains invalid parameters.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null or omitted when success is false","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"internal-error","message":"An unexpected error occurred. Please try again later."}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"internal-error","message":"An unexpected error occurred. Please try again later."}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"0e3ba47e-a570-40d0-b3e6-688cb37506b4":{"OAuth2":{"type":"oauth2","description":"OAuth2 client credentials flow. Token endpoints:\n- Staging: https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n- Production: https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n","flows":{"clientCredentials":{"tokenUrl":"https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token","scopes":{}}},"scopes":[],"schemeName":"OAuth2"}}},"servers":{"7ccd99be-e28d-4721-9a67-da99d4352b21":{"url":"https://api.venlyfinance.com/v1","description":"Production"},"9f7a6158-6efa-486c-991d-4d69199ecde2":{"url":"https://api-staging.venlyfinance.com/v1","description":"Staging"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"OAuth2 client credentials flow. Token endpoints:\n- Staging: https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n- Production: https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n","flows":{"clientCredentials":{"tokenUrl":"https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token","scopes":{}}},"scopes":[],"schemeName":"OAuth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth2 client credentials flow. Token endpoints:\n- Staging: https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n- Production: https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2","name":"Authorization"}],"title":"OAuth2"}]},"originalFileLocation":"api-reference/Finance-API-Specs.yaml"},"subdomain":"venly","siteName":"Venly Finance","title":"Get a pay-in - Venly Finance","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T13:22:19.101Z","originalFileLocation":"api-reference/Finance-API/pay-ins/get-a-pay-in.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=\"Read one pay-in by the id carried on the PAY_IN_SETTLED or PAY_IN_FAILED webhook.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Venly Finance\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a pay-in - Venly Finance\">\u003cmeta data-mint-head property=\"og:description\" content=\"Read one pay-in by the id carried on the PAY_IN_SETTLED or PAY_IN_FAILED webhook.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Venly Finance\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.venlyfinance.com/api-reference/Finance-API/pay-ins/get-a-pay-in\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://venly.mintlify.site/_mintlify/api/og/v2?division=Pay-Ins\u0026amp;title=Get+a+pay-in\u0026amp;description=Read+one+pay-in+by+the+id+carried+on+the+PAY_IN_SETTLED+or+PAY_IN_FAILED+webhook.\u0026amp;theme=66844d886c63c9d7741f1e37\u0026amp;signature=f2e5c6e74616fb24bc9d423bdb6e5046f460a40a5cedf45f299b03a9dc61b827\">\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=\"Get a pay-in - Venly Finance\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Read one pay-in by the id carried on the PAY_IN_SETTLED or PAY_IN_FAILED webhook.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://venly.mintlify.site/_mintlify/api/og/v2?division=Pay-Ins\u0026amp;title=Get+a+pay-in\u0026amp;description=Read+one+pay-in+by+the+id+carried+on+the+PAY_IN_SETTLED+or+PAY_IN_FAILED+webhook.\u0026amp;theme=66844d886c63c9d7741f1e37\u0026amp;signature=f2e5c6e74616fb24bc9d423bdb6e5046f460a40a5cedf45f299b03a9dc61b827\">\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/venly/NJHVXnPMqQUaB4Tk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Venly Finance\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#e07826\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.venlyfinance.com/api-reference/Finance-API/pay-ins/get-a-pay-in\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/Finance-API/pay-ins/get-a-pay-in.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.venlyfinance.com/#organization\",\"name\":\"Venly Finance\",\"url\":\"https://docs.venlyfinance.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/venly/NZGy1d4c4LA-0jM9/logo/light_venly_logo.png?fit=max\u0026auto=format\u0026n=NZGy1d4c4LA-0jM9\u0026q=85\u0026s=d808fd8f702829ca93bf607f200800bb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.venlyfinance.com#website\",\"name\":\"Venly Finance\",\"url\":\"https://docs.venlyfinance.com\",\"publisher\":{\"@id\":\"https://docs.venlyfinance.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/pay-ins/get-a-pay-in#webpage\",\"url\":\"https://docs.venlyfinance.com/api-reference/Finance-API/pay-ins/get-a-pay-in\",\"name\":\"Get a pay-in\",\"description\":\"Read one pay-in by the id carried on the PAY_IN_SETTLED or PAY_IN_FAILED webhook.\",\"dateModified\":\"2026-10-05T13:22:19.101Z\",\"isPartOf\":{\"@id\":\"https://docs.venlyfinance.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/pay-ins/get-a-pay-in#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/pay-ins/get-a-pay-in#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Pay-Ins\",\"item\":\"https://docs.venlyfinance.com/api-reference/Finance-API/pay-ins/list-pay-ins\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a pay-in\",\"item\":\"https://docs.venlyfinance.com/api-reference/Finance-API/pay-ins/get-a-pay-in\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/pay-ins/get-a-pay-in#apireference\",\"headline\":\"Get a pay-in\",\"name\":\"Get a pay-in\",\"description\":\"Read one pay-in by the id carried on the PAY_IN_SETTLED or PAY_IN_FAILED webhook.\",\"url\":\"https://docs.venlyfinance.com/api-reference/Finance-API/pay-ins/get-a-pay-in\",\"mainEntityOfPage\":{\"@id\":\"https://docs.venlyfinance.com/api-reference/Finance-API/pay-ins/get-a-pay-in#webpage\"},\"dateModified\":\"2026-10-05T13:22:19.101Z\",\"publisher\":{\"@id\":\"https://docs.venlyfinance.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.venlyfinance.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Venly Finance\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Venly Finance\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/Finance-API/pay-ins/get-a-pay-in.md","siteName":"Venly Finance","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://venlyfinance.com/blog"},{"anchor":"Support","icon":"envelope","href":"https://venlyfinance.com/contact"}]},"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":""}]},{"tab":"Fundflow API","pages":[{"title":"Fundflow API","href":"/guides/payments/getting-started"}]},{"tab":"Finance API","groups":[{"group":"Overview","pages":[{"title":"Finance API","sidebarTitle":"Overview","icon":"building-columns","href":"/api-reference/introduction"},{"title":"Data model","icon":"sitemap","href":"/guides/finance/data-model"},{"title":"Getting started","icon":"rocket","href":"/guides/finance/getting-started"},{"title":"Integration Walkthrough","sidebarTitle":"Integration Walkthrough","icon":"route","href":"/guides/finance/integration-walkthrough"},{"title":"Glossary","sidebarTitle":"Glossary","icon":"book-open","href":"/guides/finance/glossary"},{"title":"Countries","icon":"globe-europe","href":"/guides/finance/countries"}]},{"group":"Recipes","pages":[{"title":"Recipe: issue wallets, receive fiat, pay out fiat","sidebarTitle":"Wallet API end-to-end","icon":"book-open","href":"/guides/finance/recipes/wallet-api-end-to-end"}]},{"group":"Onboarding \u0026 Verification","pages":[{"title":"Onboarding lifecycle","sidebarTitle":"Onboarding lifecycle","icon":"route","href":"/guides/finance/onboarding/lifecycle"},{"title":"Roles \u0026 entities","sidebarTitle":"Roles \u0026 entities","icon":"sitemap","href":"/guides/finance/onboarding/roles-and-entities"},{"title":"Individual KYC","sidebarTitle":"Individual KYC","icon":"user","href":"/guides/finance/onboarding/individual-kyc"},{"title":"Business KYB","sidebarTitle":"Business KYB","icon":"building","href":"/guides/finance/onboarding/business-kyb"},{"title":"Hosted verification links","sidebarTitle":"Hosted verification","icon":"link","href":"/guides/finance/onboarding/hosted-verification"},{"title":"Sumsub token sharing","sidebarTitle":"Sumsub token sharing","icon":"forward","href":"/guides/finance/onboarding/sumsub-token-sharing"},{"title":"Partner-terms consent","sidebarTitle":"Partner-terms consent","icon":"file-signature","href":"/guides/finance/onboarding/partner-terms-consent"},{"title":"Partner onboarding","sidebarTitle":"Partner onboarding","icon":"handshake","href":"/guides/finance/onboarding/partner-onboarding"},{"title":"Troubleshooting verification","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/guides/finance/onboarding/troubleshooting"}]},{"group":"Core Concepts","pages":[{"title":"Venly-managed vs self-custody","icon":"key","href":"/guides/finance/managed-vs-self-custody"},{"title":"Account verification","icon":"id-card","href":"/guides/finance/kyc-verification"},{"title":"Wallets \u0026 balances","icon":"wallet","href":"/guides/finance/wallets"},{"title":"Approving transfers without gas","icon":"file-signature","href":"/guides/finance/permits-and-allowances"},{"title":"Transfers","icon":"money-bill-transfer","href":"/guides/finance/transfers"},{"title":"Virtual bank accounts","sidebarTitle":"Virtual bank accounts","icon":"building-columns","href":"/guides/finance/virtual-bank-accounts"},{"title":"Pay-ins","sidebarTitle":"Pay-ins","icon":"arrow-down-to-bracket","href":"/guides/finance/pay-ins"},{"title":"Pay-outs","icon":"money-bill-transfer","href":"/guides/finance/payouts"},{"title":"Webhooks","icon":"bell","href":"/guides/finance/webhooks"},{"title":"API credentials","sidebarTitle":"API credentials","icon":"key","href":"/guides/finance/api-credentials"},{"title":"Billing","sidebarTitle":"Billing","icon":"receipt","href":"/guides/finance/billing"},{"title":"Safe retries with idempotency keys","icon":"arrows-rotate","href":"/guides/finance/idempotency"},{"title":"Versioning \u0026 safe updates","icon":"code-branch","href":"/guides/finance/versioning"}]},{"group":"Parties","pages":[{"title":"List parties","openapi":"api-reference/Finance-API-Specs.yaml GET /parties","href":"/api-reference/Finance-API/parties/list-all-parties"},{"title":"Create a party","openapi":"api-reference/Finance-API-Specs.yaml POST /parties","href":"/api-reference/Finance-API/parties/create-a-new-party"},{"title":"Get a party","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}","href":"/api-reference/Finance-API/parties/get-party-details"},{"title":"Update a party","openapi":"api-reference/Finance-API-Specs.yaml PATCH /parties/{partyId}","href":"/api-reference/Finance-API/parties/update-party-details"},{"title":"Delete a party","openapi":"api-reference/Finance-API-Specs.yaml DELETE /parties/{partyId}","href":"/api-reference/Finance-API/parties/delete-party"},{"title":"Create a verification link","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/verification","href":"/api-reference/Finance-API/parties/create-a-verification-link"},{"title":"Get verification linkage","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/iv-verification","href":"/api-reference/Finance-API/parties/get-verification-linkage"},{"title":"Get a party's KYC status","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/kyc-status","href":"/api-reference/Finance-API/parties/get-a-partys-kyc-status"},{"title":"Issue a KYC completion link","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/kyc-status/completion-link","href":"/api-reference/Finance-API/parties/issue-a-kyc-completion-link"},{"title":"Get partner-terms consent state","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/partner-terms","href":"/api-reference/Finance-API/parties/get-a-partys-partner-terms-consent-state"},{"title":"Issue a partner-terms consent link","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/partner-terms/link","href":"/api-reference/Finance-API/parties/issue-a-partner-terms-consent-link"},{"title":"Get a party's partner-onboarding status","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/partner-onboarding","href":"/api-reference/Finance-API/parties/get-a-partys-partner-onboarding-status"},{"title":"Request partner onboarding","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/partner-onboarding","href":"/api-reference/Finance-API/parties/request-partner-onboarding-for-a-party"}]},{"group":"Accounts","pages":[{"title":"List accounts","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts","href":"/api-reference/Finance-API/accounts/list-all-accounts"},{"title":"Create an account","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts","href":"/api-reference/Finance-API/accounts/create-a-new-account"},{"title":"Get an account","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}","href":"/api-reference/Finance-API/accounts/get-account-details"},{"title":"List party roles","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/party-roles","href":"/api-reference/Finance-API/accounts/list-party-roles-for-an-account"},{"title":"Add a party role","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/party-roles","href":"/api-reference/Finance-API/accounts/add-a-party-to-an-account"},{"title":"Remove a party role","openapi":"api-reference/Finance-API-Specs.yaml DELETE /accounts/{accountId}/party-roles/{partyId}","href":"/api-reference/Finance-API/accounts/remove-a-party-from-an-account"}]},{"group":"Virtual Bank Accounts","pages":[{"title":"List virtual bank accounts","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/virtual-bank-accounts","href":"/api-reference/Finance-API/virtual-bank-accounts/list-virtual-bank-accounts"},{"title":"Create a virtual bank account","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/virtual-bank-accounts","href":"/api-reference/Finance-API/virtual-bank-accounts/create-a-virtual-bank-account"},{"title":"Get a virtual bank account","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/virtual-bank-accounts/{virtualBankAccountId}","href":"/api-reference/Finance-API/virtual-bank-accounts/get-virtual-bank-account-details"},{"title":"Prepare a wallet-ownership proof","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/virtual-bank-accounts/prepare","href":"/api-reference/Finance-API/virtual-bank-accounts/prepare-a-wallet-ownership-proof"},{"title":"Close a virtual bank account","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/virtual-bank-accounts/{virtualBankAccountId}/close","href":"/api-reference/Finance-API/virtual-bank-accounts/close-a-virtual-bank-account"}]},{"group":"Supported Assets","pages":[{"title":"List supported assets","openapi":"api-reference/Finance-API-Specs.yaml GET /supported-assets","href":"/api-reference/Finance-API/supported-assets/list-supported-assets"},{"title":"List account supported assets","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/supported-assets","href":"/api-reference/Finance-API/supported-assets/list-account-supported-assets"}]},{"group":"Wallets","pages":[{"title":"List wallets","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/wallets","href":"/api-reference/Finance-API/wallets/list-wallets-for-an-account"}]},{"group":"Transfers","pages":[{"title":"Create a fiat transfer","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{senderAccountId}/transfers/fiat","href":"/api-reference/Finance-API/transfers/create-fiat-transfer"},{"title":"Create a crypto transfer","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{senderAccountId}/transfers/crypto","href":"/api-reference/Finance-API/transfers/create-crypto-transfer"},{"title":"List transfers","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/transfers","href":"/api-reference/Finance-API/transfers/list-transfers-for-account"},{"title":"Get a transfer","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/transfers/{transferId}","href":"/api-reference/Finance-API/transfers/get-transfer-details"}]},{"group":"Fiat to Crypto Payment Sessions","pages":[{"title":"Create a pay-in session","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/fiat-to-crypto/payment-sessions","tag":"Coming soon","href":"/api-reference/Finance-API/fiat-to-crypto-payment-sessions/create-a-fiat-to-crypto-payment-session"},{"title":"List pay-in sessions","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/fiat-to-crypto/payment-sessions","tag":"Coming soon","href":"/api-reference/Finance-API/fiat-to-crypto-payment-sessions/list-pay-in-sessions"},{"title":"Get a pay-in session","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/fiat-to-crypto/payment-sessions/{sessionId}","tag":"Coming soon","href":"/api-reference/Finance-API/fiat-to-crypto-payment-sessions/get-a-pay-in-session"}]},{"group":"Pay-Ins","pages":[{"title":"List pay-ins","description":"List every pay-in settlement record across your company.","openapi":"api-reference/Finance-API-Specs.yaml GET /pay-ins","href":"/api-reference/Finance-API/pay-ins/list-pay-ins"},{"title":"Get a pay-in","openapi":"api-reference/Finance-API-Specs.yaml GET /pay-ins/{payInId}","href":"/api-reference/Finance-API/pay-ins/get-a-pay-in"}]},{"group":"Payout Bank Accounts","pages":[{"title":"Register a payout bank account","description":"Allow-list a beneficiary bank account as a pay-out destination for a party.","openapi":"api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/payout-bank-accounts","href":"/api-reference/Finance-API/payout-bank-accounts/register-a-payout-bank-account"},{"title":"List payout bank accounts","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/payout-bank-accounts","href":"/api-reference/Finance-API/payout-bank-accounts/list-payout-bank-accounts"},{"title":"Get a payout bank account","openapi":"api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/payout-bank-accounts/{payoutBankAccountId}","href":"/api-reference/Finance-API/payout-bank-accounts/get-a-payout-bank-account"}]},{"group":"Payout Routes","pages":[{"title":"Create a payout route","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/payout-routes","href":"/api-reference/Finance-API/payout-routes/create-a-payout-route"},{"title":"List payout routes","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/payout-routes","href":"/api-reference/Finance-API/payout-routes/list-payout-routes"},{"title":"Prepare a route ownership proof","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/payout-routes/{routeId}/ownership-proof/prepare","href":"/api-reference/Finance-API/payout-routes/prepare-a-route-ownership-proof"},{"title":"Submit a route ownership proof","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/payout-routes/{routeId}/ownership-proof/complete","href":"/api-reference/Finance-API/payout-routes/submit-a-route-ownership-proof"}]},{"group":"Payouts","pages":[{"title":"Request a payout","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/payouts","href":"/api-reference/Finance-API/payouts/request-a-payout"},{"title":"List payouts","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/payouts","href":"/api-reference/Finance-API/payouts/list-payouts"},{"title":"Get a payout","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/payouts/{payoutId}","href":"/api-reference/Finance-API/payouts/get-a-payout"}]},{"group":"Permits","pages":[{"title":"Get permit messages","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/wallets/{walletId}/permits","href":"/api-reference/Finance-API/permits/get-permit-messages"},{"title":"Submit a signed permit","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/wallets/{walletId}/permits","href":"/api-reference/Finance-API/permits/submit-signed-permit"}]},{"group":"Allowances","pages":[{"title":"Get wallet allowances","openapi":"api-reference/Finance-API-Specs.yaml GET /accounts/{accountId}/wallets/{walletId}/allowances","href":"/api-reference/Finance-API/allowances/get-wallet-token-allowances"},{"title":"Verify wallet allowances","openapi":"api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/wallets/{walletId}/allowance-verification","tag":"Coming soon","href":"/api-reference/Finance-API/allowances/verify-wallet-allowances"}]},{"group":"Webhooks","pages":[{"title":"Register a webhook","openapi":"api-reference/Finance-API-Specs.yaml POST /webhooks","href":"/api-reference/Finance-API/webhooks/register-a-webhook"},{"title":"List webhooks","openapi":"api-reference/Finance-API-Specs.yaml GET /webhooks","href":"/api-reference/Finance-API/webhooks/list-webhooks"},{"title":"Get webhook details","openapi":"api-reference/Finance-API-Specs.yaml GET /webhooks/{webhookId}","href":"/api-reference/Finance-API/webhooks/get-webhook-details"},{"title":"Update a webhook","openapi":"api-reference/Finance-API-Specs.yaml PUT /webhooks/{webhookId}","href":"/api-reference/Finance-API/webhooks/update-a-webhook"},{"title":"Delete a webhook","openapi":"api-reference/Finance-API-Specs.yaml DELETE /webhooks/{webhookId}","href":"/api-reference/Finance-API/webhooks/delete-a-webhook"},{"title":"Ping a webhook","openapi":"api-reference/Finance-API-Specs.yaml POST /webhooks/{webhookId}/ping","href":"/api-reference/Finance-API/webhooks/ping-a-webhook"},{"title":"List webhook deliveries","openapi":"api-reference/Finance-API-Specs.yaml GET /webhooks/{webhookId}/deliveries","href":"/api-reference/Finance-API/webhooks/list-webhook-deliveries"},{"title":"Get a webhook delivery","openapi":"api-reference/Finance-API-Specs.yaml GET /webhooks/{webhookId}/deliveries/{deliveryId}","href":"/api-reference/Finance-API/webhooks/get-a-webhook-delivery"},{"title":"Resend a webhook delivery","openapi":"api-reference/Finance-API-Specs.yaml POST /webhooks/{webhookId}/deliveries/{deliveryId}/resend","href":"/api-reference/Finance-API/webhooks/resend-a-webhook-delivery"}]},{"group":"API Credentials","pages":[{"title":"List API credentials","openapi":"api-reference/Finance-API-Specs.yaml GET /api-credentials","href":"/api-reference/Finance-API/api-credentials/list-api-credentials"},{"title":"Create API credentials","openapi":"api-reference/Finance-API-Specs.yaml POST /api-credentials","href":"/api-reference/Finance-API/api-credentials/create-api-credentials"},{"title":"Rotate a credential's secret","openapi":"api-reference/Finance-API-Specs.yaml POST /api-credentials/{clientId}/secret","href":"/api-reference/Finance-API/api-credentials/rotate-a-credentials-secret"},{"title":"Enable or disable a credential","openapi":"api-reference/Finance-API-Specs.yaml PUT /api-credentials/{clientId}/status","href":"/api-reference/Finance-API/api-credentials/enable-or-disable-a-credential"}]},{"group":"Billing","pages":[{"title":"List invoices","openapi":"api-reference/Finance-API-Specs.yaml GET /billing/invoices","href":"/api-reference/Finance-API/billing/list-invoices"},{"title":"Get an invoice","openapi":"api-reference/Finance-API-Specs.yaml GET /billing/invoices/{invoiceId}","href":"/api-reference/Finance-API/billing/get-an-invoice"},{"title":"Download an invoice PDF","openapi":"api-reference/Finance-API-Specs.yaml GET /billing/invoices/{invoiceId}/download","href":"/api-reference/Finance-API/billing/download-an-invoice-pdf"}]},{"group":"Company","pages":[{"title":"Get your company profile","openapi":"api-reference/Finance-API-Specs.yaml GET /company","href":"/api-reference/Finance-API/company/get-your-company-profile"}]},{"group":"Reference","pages":[{"title":"Errors \u0026 error codes","sidebarTitle":"Errors","icon":"triangle-exclamation","href":"/guides/finance/errors"},{"title":"Supported chains \u0026 assets","sidebarTitle":"Chains \u0026 assets","icon":"coins","href":"/guides/finance/supported-chains-and-assets"}]}]},{"tab":"Upcoming","pages":[{"title":"Upcoming","href":"/guides/card-issuance/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/guides/finance/changelog"}]}]},"basePath":"","title":"Get a pay-in - Venly Finance","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}