{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Busha Developer Documentation","colors":{"primary":"#12A232","light":"#12A232","dark":"#12A232"},"logo":{"light":"https://mintcdn.com/busha-36f167ef/bqGQAc9YwZBzW1ju/logo/light.svg?fit=max\u0026auto=format\u0026n=bqGQAc9YwZBzW1ju\u0026q=85\u0026s=08cf983a0716b1e5e0ccf2eabf9408a5","dark":"https://mintcdn.com/busha-36f167ef/bqGQAc9YwZBzW1ju/logo/dark.svg?fit=max\u0026auto=format\u0026n=bqGQAc9YwZBzW1ju\u0026q=85\u0026s=209a532c93e641a4ad79e0d7ef0ebbe3"},"favicon":"https://mintcdn.com/busha-36f167ef/bqGQAc9YwZBzW1ju/images/svg/favicon.svg?fit=max\u0026auto=format\u0026n=bqGQAc9YwZBzW1ju\u0026q=85\u0026s=3d0baa4107dcc1b7208265c241435f89","navbar":{"links":[{"href":"mailto:developers@busha.co","label":"Support"}],"primary":{"type":"button","label":"Visit Busha","href":"https://busha.io"}},"footer":{"socials":{"x":"https://twitter.com/getbusha","github":"https://github.com/bushaHQ","linkedin":"https://linkedin.com/company/getbusha"}},"seo":{"metatags":{"og:description":"Busha API documentation for developers. Integrate crypto trading, wallets, and payments into your app with our comprehensive guides and API references.","description":"Busha API documentation for developers. Integrate crypto trading, wallets, and payments into your app with our comprehensive guides and API references.","og:title":"Busha Developer Documentation","og:site_name":"Busha Developer Documentation","og:image":"/images/meta-image.png"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Guides","icon":"book-open-cover","href":"https://docs.busha.io/guides"},{"anchor":"Blog","icon":"newspaper","href":"https://busha.io/blog"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"https://docs.busha.io/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"busha-36f167ef","hasAudioNarration":false,"actualSubdomain":"busha-36f167ef","customDomains":["docs.busha.io"],"gitSource":{"type":"github","owner":"bushahq","repo":"developers","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf63bed9cce1ec7365aa4c","collectionId":"d9702e48-9fe5-4a2a-bdbc-490fe3092d07","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf63bed9cce1ec7365aa4c"},"entitlements":{},"buildId":"6adf63bed9cce1ec7365aa4c","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":68},{"language":"default","tag":"API reference","count":68},{"language":"default","tag":"Guides","count":51},{"language":"default","tag":"Examples","count":20},{"language":"default","tag":"Pledges","count":11},{"language":"default","tag":"Reference","count":10},{"language":"default","tag":"Overview","count":10},{"language":"default","tag":"Customers","count":10},{"language":"default","tag":"Miscellaneous","count":9},{"language":"default","tag":"OAuth2","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/paymentrequests/create-a-payment-request","slug":"/api-reference/paymentrequests/create-a-payment-request","pageMetadata":{"title":"Create a payment request","description":"Create a payment request","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/payments/requests","href":"/api-reference/paymentrequests/create-a-payment-request","autogeneratedByOpenApi":true},"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: \"Create a payment request\"\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":"Create a payment request","description":"Create a payment request","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/payments/requests","href":"/api-reference/paymentrequests/create-a-payment-request","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["PaymentRequests"],"security":["e20c6cc1-ab53-442a-b067-3e4ad2ecb842"],"summary":"Create a payment request","description":"Create a payment request","operationId":"createPaymentRequest","parameters":["f2ad18ed-2422-49e5-b453-eb3eab9e213b","a0b5e360-2c1e-4380-ae31-c9f4425393d0"],"requestBody":"395a5dfb-bc8e-4c79-8a5f-3967ef0e45d1","responses":{"201":"feae8f2f-c33f-4f99-b8d5-642c3b643616","4XX":"37b0ef5b-0d26-44f4-be05-9e4cbcdcbe57","5XX":"6eff4026-0f90-41d3-9003-292ce14af842"},"method":"post","type":"path","servers":["da7e1349-896d-4d44-bf50-5095dca769ae","0117cc31-430c-47bd-9d4e-ad2e7f6fba80"],"path":"/v1/payments/requests","baseUrlOptions":["https://api.sandbox.busha.so","https://api.busha.io"],"title":"Create a payment request","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f2ad18ed-2422-49e5-b453-eb3eab9e213b":{"in":"header","name":"X-BU-PROFILE-ID","required":false,"description":"User profile header","schema":{"type":"string","example":"BUS_YOK8tp5Zga01qOKEsqp07","isRequired":false,"description":"User profile header","uniqueKey":"","typeLabel":"string"}},"a0b5e360-2c1e-4380-ae31-c9f4425393d0":{"in":"header","name":"X-BU-PUBLIC-KEY","required":false,"schema":{"type":"string","example":"pub_uibaidu930ani","isRequired":false,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["additional_info","source_currency","target_currency"],"properties":{"additional_info":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","description":"email address for the payment request","isRequired":true,"uniqueKey":"additional_info.email","typeLabel":"string\u003cemail>"},"phone_number":{"type":"string","example":"+2348012345678","format":"phone","description":"A valid phone number. format `{{calling_code}}{{number}}`","x-oapi-codegen-extra-tags":{"validate":"phone","filter":"phone","mapstructure":"phone_number,omitempty"},"uniqueKey":"additional_info.phone_number","typeLabel":"string\u003cphone>"},"name":{"type":"string","example":"John","description":"A valid name","uniqueKey":"additional_info.name","typeLabel":"string"},"source":{"type":"string","description":"The source of the payment request","example":"web","uniqueKey":"additional_info.source","typeLabel":"string"}},"isRequired":true,"uniqueKey":"additional_info","typeLabel":"object"},"source_currency":{"type":"string","x-order":20,"example":"BTC","format":"string","maxLength":10,"minLength":1,"description":"A valid currency","x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"isRequired":true,"uniqueKey":"source_currency","typeLabel":"string\u003cstring>"},"target_currency":{"type":"string","x-order":20,"example":"BTC","format":"string","maxLength":10,"minLength":1,"description":"A valid currency","x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"isRequired":true,"uniqueKey":"target_currency","typeLabel":"string\u003cstring>"},"quote_amount":{"type":"string","description":"decimal value","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"x-oapi-codegen-extra-tags":{"validate":"num_gte:0"},"example":"100","uniqueKey":"quote_amount","typeLabel":"string"},"quote_currency":{"type":"string","description":"This optional field specifies the currency to price the payment request in, which is converted from the source amount","format":"string","maxLength":10,"minLength":1,"x-order":20,"x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"example":"NGN","uniqueKey":"quote_currency","typeLabel":"string\u003cstring>"},"source_amount":{"type":"string","description":"decimal value","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"x-oapi-codegen-extra-tags":{"validate":"num_gte:0"},"example":"100","uniqueKey":"source_amount","typeLabel":"string"},"target_amount":{"type":"string","description":"decimal value","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"x-oapi-codegen-extra-tags":{"validate":"num_gte:0"},"example":"100","uniqueKey":"target_amount","typeLabel":"string"},"pay_in":{"type":"object","required":["type"],"properties":{"type":{"type":"string","example":"address","enum":["address","mobile_money","temporary_bank_account","direct_debit","balance"],"isRequired":true,"uniqueKey":"pay_in.type","typeLabel":"enum\u003cstring>"},"network":{"type":"string","example":"BTC","description":"This specifies the blockchain network associated with the address receiving the payment, typically used with address type payouts.\n","uniqueKey":"pay_in.network","typeLabel":"string"},"phone":{"type":"string","example":"+2348012345678","format":"phone","description":"A valid phone number. format `{{calling_code}}{{number}}`","x-oapi-codegen-extra-tags":{"validate":"phone","filter":"phone","mapstructure":"phone_number,omitempty"},"uniqueKey":"pay_in.phone","typeLabel":"string\u003cphone>"},"recipient_id":{"type":"string","example":"64ae8c26ea1033204c805a8a","description":"This represents the recipient ID. Used for `direct_debit` types (mandate ID).\n","uniqueKey":"pay_in.recipient_id","typeLabel":"string"}},"uniqueKey":"pay_in","typeLabel":"object"},"reference":{"type":"string","description":"reference for the payment request","example":"busha-123","uniqueKey":"reference","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"additional_info":{"email":"jsmith@example.com","phone_number":"+2348012345678","name":"John","source":"web"},"source_currency":"BTC","target_currency":"BTC","quote_amount":"100","quote_currency":"NGN","source_amount":"100","target_amount":"100","reference":"busha-123"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"feae8f2f-c33f-4f99-b8d5-642c3b643616":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","description":"General response Values","required":["data","status","message"],"properties":{"status":{"type":"string","x-order":1,"x-go-type":"string","enum":["success","error"],"example":"success","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","x-order":2,"example":"message for success","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","required":["id","source_amount","source_currency","target_amount","target_currency","requested_amount","currency","rate","fees","reference","additional_info","merchant_info","status","type","created_at","updated_at","expires_at"],"properties":{"id":{"type":"string","description":"A valid id","format":"nanoid","x-order":1,"x-oapi-codegen-extra-tags":{"validate":"required|nanoid"},"example":"bus_123456789","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cnanoid>"},"type":{"type":"string","enum":["donation","checkout","invoice"],"x-order":2,"isRequired":true,"uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["pending","expired","cancelled","completed","failed","multiple_deposits","under_payment","over_payment"],"x-order":3,"isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"source_amount":{"type":"string","description":"decimal value","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"x-order":4,"example":"100","isRequired":true,"uniqueKey":"data.source_amount","typeLabel":"string"},"source_currency":{"type":"string","description":"A valid currency","format":"string","maxLength":10,"minLength":1,"x-order":5,"x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"example":"BTC","isRequired":true,"uniqueKey":"data.source_currency","typeLabel":"string\u003cstring>"},"target_amount":{"type":"string","description":"decimal value","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"x-order":6,"example":"100","isRequired":true,"uniqueKey":"data.target_amount","typeLabel":"string"},"target_currency":{"type":"string","description":"A valid currency","format":"string","maxLength":10,"minLength":1,"x-order":7,"x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"example":"BTC","isRequired":true,"uniqueKey":"data.target_currency","typeLabel":"string\u003cstring>"},"requested_amount":{"type":"string","description":"The amount requested by the merchant","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"x-order":8,"example":"100","isRequired":true,"uniqueKey":"data.requested_amount","typeLabel":"string"},"currency":{"type":"string","description":"The currency it was requested in","format":"string","maxLength":10,"minLength":1,"x-order":9,"x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"example":"BTC","isRequired":true,"uniqueKey":"data.currency","typeLabel":"string\u003cstring>"},"rate":{"type":"object","x-order":10,"properties":{"product":{"type":"string","example":"BTCUSDT","uniqueKey":"data.rate.product","typeLabel":"string"},"rate_explained":{"type":"string","example":"1 BTC = 1000 USDT","uniqueKey":"data.rate.rate_explained","typeLabel":"string"},"source_currency":{"type":"string","x-order":20,"example":"BTC","format":"string","maxLength":10,"minLength":1,"description":"A valid currency","x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"uniqueKey":"data.rate.source_currency","typeLabel":"string\u003cstring>"},"target_currency":{"type":"string","x-order":20,"example":"BTC","format":"string","maxLength":10,"minLength":1,"description":"A valid currency","x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"uniqueKey":"data.rate.target_currency","typeLabel":"string\u003cstring>"},"rate":{"type":"string","description":"decimal value","example":"100","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"uniqueKey":"data.rate.rate","typeLabel":"string"},"side":{"type":"string","enum":["buy","sell"],"example":"sell","uniqueKey":"data.rate.side","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["FIXED"],"example":"FIXED","uniqueKey":"data.rate.type","typeLabel":"enum\u003cstring>"},"base_rate":{"type":"string","description":"decimal value","example":"100","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"uniqueKey":"data.rate.base_rate","typeLabel":"string"},"discount":{"type":"object","description":"A volume discount the trade size earned. `rate` already includes it. Absent when no discount applied.\n","required":["percentage","saved","tier"],"properties":{"percentage":{"type":"string","description":"Percent off the base rate. \"0.10\" is 0.10%.","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"example":"0.10","isRequired":true,"uniqueKey":"data.rate.discount.percentage","typeLabel":"string"},"saved":{"type":"object","description":"What the discount is worth before fees: extra of the currency received, or less of the currency paid.\n","required":["amount","currency"],"properties":{"amount":{"type":"string","description":"decimal value","example":"100","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"isRequired":true,"uniqueKey":"data.rate.discount.saved.amount","typeLabel":"string"},"currency":{"type":"string","x-order":20,"example":"BTC","format":"string","maxLength":10,"minLength":1,"description":"A valid currency","x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"isRequired":true,"uniqueKey":"data.rate.discount.saved.currency","typeLabel":"string\u003cstring>"}},"isRequired":true,"uniqueKey":"data.rate.discount.saved","typeLabel":"object"},"tier":{"type":"object","description":"The rung the trade reached.","required":["from","currency"],"properties":{"from":{"type":"string","description":"The rung starts at trades of this size.","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"example":"10000","isRequired":true,"uniqueKey":"data.rate.discount.tier.from","typeLabel":"string"},"currency":{"type":"string","x-order":20,"example":"BTC","format":"string","maxLength":10,"minLength":1,"description":"A valid currency","x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"isRequired":true,"uniqueKey":"data.rate.discount.tier.currency","typeLabel":"string\u003cstring>"}},"isRequired":true,"uniqueKey":"data.rate.discount.tier","typeLabel":"object"}},"uniqueKey":"data.rate.discount","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.rate","typeLabel":"object"},"fees":{"type":"array","items":{"type":"object","x-order":40,"required":["name","amount","type"],"properties":{"name":{"type":"string","example":"processing_fee","isRequired":true,"uniqueKey":"data.fees.items.[INDEX].name","typeLabel":"string"},"amount":{"type":"object","description":"Amount with currency","required":["amount","currency"],"properties":{"amount":{"type":"string","description":"decimal value","example":"100","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"isRequired":true,"uniqueKey":"data.fees.items.[INDEX].amount.amount","typeLabel":"string"},"currency":{"type":"string","x-order":20,"example":"BTC","format":"string","maxLength":10,"minLength":1,"description":"A valid currency","x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"isRequired":true,"uniqueKey":"data.fees.items.[INDEX].amount.currency","typeLabel":"string\u003cstring>"}},"isRequired":true,"uniqueKey":"data.fees.items.[INDEX].amount","typeLabel":"object"},"type":{"type":"string","enum":["FIXED","PERCENTAGE","TIERED"],"example":"FIXED","isRequired":true,"uniqueKey":"data.fees.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"converted_amount":{"type":"object","description":"Amount with currency","required":["amount","currency"],"properties":{"amount":{"type":"string","description":"decimal value","example":"100","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"isRequired":true,"uniqueKey":"data.fees.items.[INDEX].converted_amount.amount","typeLabel":"string"},"currency":{"type":"string","x-order":20,"example":"BTC","format":"string","maxLength":10,"minLength":1,"description":"A valid currency","x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"isRequired":true,"uniqueKey":"data.fees.items.[INDEX].converted_amount.currency","typeLabel":"string\u003cstring>"}},"uniqueKey":"data.fees.items.[INDEX].converted_amount","typeLabel":"object"}},"uniqueKey":"data.fees.items.[INDEX]","typeLabel":"object"},"x-order":11,"isRequired":true,"uniqueKey":"data.fees","typeLabel":"object[]"},"reference":{"type":"string","x-order":14,"isRequired":true,"uniqueKey":"data.reference","typeLabel":"string"},"additional_info":{"type":"object","required":["email"],"x-order":16,"properties":{"email":{"type":"string","format":"email","description":"email address for the payment request","isRequired":true,"uniqueKey":"data.additional_info.email","typeLabel":"string\u003cemail>"},"phone_number":{"type":"string","example":"+2348012345678","format":"phone","description":"A valid phone number. format `{{calling_code}}{{number}}`","x-oapi-codegen-extra-tags":{"validate":"phone","filter":"phone","mapstructure":"phone_number,omitempty"},"uniqueKey":"data.additional_info.phone_number","typeLabel":"string\u003cphone>"},"name":{"type":"string","example":"John","description":"A valid name","uniqueKey":"data.additional_info.name","typeLabel":"string"},"source":{"type":"string","description":"The source of the payment request","example":"web","uniqueKey":"data.additional_info.source","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.additional_info","typeLabel":"object"},"merchant_info":{"type":"object","required":["name"],"x-order":17,"properties":{"name":{"type":"string","description":"name of the business","example":"busha","isRequired":true,"uniqueKey":"data.merchant_info.name","typeLabel":"string"},"email":{"type":"string","format":"email","description":"email of the business","example":"busha@me.com","uniqueKey":"data.merchant_info.email","typeLabel":"string\u003cemail>"}},"isRequired":true,"uniqueKey":"data.merchant_info","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","example":"2023-10-15T12:15:30Z","x-order":21,"isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","example":"2023-10-15T12:15:30Z","x-order":22,"isRequired":true,"uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"},"expires_at":{"type":"string","format":"date-time","example":"2023-10-15T12:15:30Z","x-order":23,"isRequired":true,"uniqueKey":"data.expires_at","typeLabel":"string\u003cdate-time>"},"pay_in":{"type":"object","required":["type"],"x-order":12,"properties":{"type":{"type":"string","example":"address","description":"The payout type. NOTE: `sweep` is reserved for Busha Business\ndashboard sessions (master \u003c-> sub-account internal transfers)\nand is rejected on public API-key requests.\n","enum":["address","bank_transfer","mobile_money","paybill","till","payout_batch","balance","savings","direct_debit","sweep","internal"],"isRequired":true,"uniqueKey":"data.pay_in.type","typeLabel":"enum\u003cstring>"},"recipient_id":{"type":"string","example":"64ae8c26ea1033204c805a8a","description":"This represents the recipient ID, used for `mobile_money` and `bank_transfer` types.\nFor `payout_batch`, this should contain the payout batch ID.\n","uniqueKey":"data.pay_in.recipient_id","typeLabel":"string"},"address":{"type":"string","example":"tb1qj4263506wyu8khrz2dwce0agk8lhyjgy269rxr","description":"This could be the address, user email or username for type `address`. For type `sweep`, this is the email of the destination account. Required when the sender is the master (master -> sub); optional when the sender is a sub-account (the destination master is resolved automatically from the sub's parent business).\nFor type `internal`, this is the destination Busha profile ID, destination email, or a public key that resolves to the owning business profile.\n","uniqueKey":"data.pay_in.address","typeLabel":"string"},"network":{"type":"string","example":"BTC","description":"This specifies the blockchain network associated with the address receiving the payment, typically used with address type payouts.\n","uniqueKey":"data.pay_in.network","typeLabel":"string"},"memo":{"type":"string","description":"This refers to the memo required for blockchain networks that mandate a memo for cryptocurrency transactions.\n","example":"address memo","uniqueKey":"data.pay_in.memo","typeLabel":"string"},"narration":{"type":"string","example":"Payment for services","description":"A narration or description for the withdrawal. Required for USD bank transfer withdrawals.\n","uniqueKey":"data.pay_in.narration","typeLabel":"string"},"payment_invoice_url":{"type":"string","example":"https://example.com/invoice.pdf","description":"URL of the payment invoice or supporting document. Required for business account USD withdrawals\nand personal account USD withdrawals exceeding $10,000.\n","uniqueKey":"data.pay_in.payment_invoice_url","typeLabel":"string"},"profile_id":{"type":"string","example":"profile-id-1234","uniqueKey":"data.pay_in.profile_id","typeLabel":"string"},"recipient_details":{"type":"object","properties":{"account_name":{"type":"string","uniqueKey":"data.pay_in.recipient_details.account_name","typeLabel":"string"},"bank_name":{"type":"string","uniqueKey":"data.pay_in.recipient_details.bank_name","typeLabel":"string"},"account_number":{"type":"string","uniqueKey":"data.pay_in.recipient_details.account_number","typeLabel":"string"},"country_code":{"type":"string","example":"NG","uniqueKey":"data.pay_in.recipient_details.country_code","typeLabel":"string"},"provider":{"type":"string","uniqueKey":"data.pay_in.recipient_details.provider","typeLabel":"string"},"iban":{"type":"string","example":"NG12345678901234567890","uniqueKey":"data.pay_in.recipient_details.iban","typeLabel":"string"},"currency":{"type":"string","uniqueKey":"data.pay_in.recipient_details.currency","typeLabel":"string"},"phone_number":{"type":"string","uniqueKey":"data.pay_in.recipient_details.phone_number","typeLabel":"string"},"name":{"type":"string","uniqueKey":"data.pay_in.recipient_details.name","typeLabel":"string"},"email":{"type":"string","example":"sbsbs@busha.co","uniqueKey":"data.pay_in.recipient_details.email","typeLabel":"string"},"bank_code":{"type":"string","example":"100020","uniqueKey":"data.pay_in.recipient_details.bank_code","typeLabel":"string"}},"uniqueKey":"data.pay_in.recipient_details","typeLabel":"object"},"blockchain_hash":{"type":"string","x-order":16,"example":"31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171","uniqueKey":"data.pay_in.blockchain_hash","typeLabel":"string"},"blockchain_url":{"type":"string","x-order":16,"example":"https://explorer.com/tx/31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171","uniqueKey":"data.pay_in.blockchain_url","typeLabel":"string"},"session_id":{"type":"string","x-order":16,"example":"31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171","uniqueKey":"data.pay_in.session_id","typeLabel":"string"},"from_address":{"type":"string","x-order":16,"example":"31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171","uniqueKey":"data.pay_in.from_address","typeLabel":"string"},"expires_at":{"type":"string","format":"date-time","example":"2023-10-15T12:15:30Z","uniqueKey":"data.pay_in.expires_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.pay_in","typeLabel":"object"},"two_step":{"type":"object","required":["type","message","resend_allowed"],"x-order":13,"properties":{"type":{"type":"string","enum":["authenticator","approval"],"example":"authenticator","description":"the type of two step verification required; approval hands the transfer to the business owner","isRequired":true,"uniqueKey":"data.two_step.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"Enter your 2FA code to continue","isRequired":true,"uniqueKey":"data.two_step.message","typeLabel":"string"},"resend_allowed":{"type":"boolean","example":false,"description":"If the code can be resent","isRequired":true,"uniqueKey":"data.two_step.resend_allowed","typeLabel":"boolean"}},"uniqueKey":"data.two_step","typeLabel":"object"},"merchant_reference":{"type":"string","x-order":15,"uniqueKey":"data.merchant_reference","typeLabel":"string"},"source":{"type":"string","description":"The source of the payment request","x-order":18,"uniqueKey":"data.source","typeLabel":"string"},"source_id":{"type":"string","description":"The source id of the payment request","x-order":19,"uniqueKey":"data.source_id","typeLabel":"string"},"timeline":{"type":"object","required":["total_steps","current_step","transfer_status","events"],"x-order":20,"properties":{"total_steps":{"type":"integer","x-order":1,"isRequired":true,"uniqueKey":"data.timeline.total_steps","typeLabel":"integer"},"current_step":{"type":"integer","x-order":2,"isRequired":true,"uniqueKey":"data.timeline.current_step","typeLabel":"integer"},"transfer_status":{"type":"string","x-order":3,"isRequired":true,"uniqueKey":"data.timeline.transfer_status","typeLabel":"string"},"events":{"type":"array","items":{"type":"object","required":["step","done","status","title","description"],"properties":{"step":{"type":"integer","x-order":1,"example":1,"isRequired":true,"uniqueKey":"data.timeline.events.items.[INDEX].step","typeLabel":"integer"},"done":{"type":"boolean","x-order":2,"example":true,"isRequired":true,"uniqueKey":"data.timeline.events.items.[INDEX].done","typeLabel":"boolean"},"status":{"type":"string","x-order":3,"enum":["pending","processing","funds_converted","funds_received","outgoing_payment_sent","funds_delivered","reverse_fund_conversion","failed","completed"],"isRequired":true,"uniqueKey":"data.timeline.events.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"title":{"type":"string","x-order":4,"example":"Transfer started","isRequired":true,"uniqueKey":"data.timeline.events.items.[INDEX].title","typeLabel":"string"},"description":{"type":"string","x-order":5,"example":"Transfer started","description":"Waiting for payment","isRequired":true,"uniqueKey":"data.timeline.events.items.[INDEX].description","typeLabel":"string"},"timestamp":{"type":"string","x-order":6,"format":"date-time","example":"2023-10-15T12:15:30Z","uniqueKey":"data.timeline.events.items.[INDEX].timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.timeline.events.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.timeline.events","typeLabel":"object[]"}},"uniqueKey":"data.timeline","typeLabel":"object"},"quote_rate":{"type":"object","description":"This shows the rate used to derive the amount when quote_currency is provided.","x-order":24,"properties":{"product":{"type":"string","example":"BTCUSDT","uniqueKey":"data.quote_rate.product","typeLabel":"string"},"rate_explained":{"type":"string","example":"1 BTC = 1000 USDT","uniqueKey":"data.quote_rate.rate_explained","typeLabel":"string"},"source_currency":{"type":"string","x-order":20,"example":"BTC","format":"string","maxLength":10,"minLength":1,"description":"A valid currency","x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"uniqueKey":"data.quote_rate.source_currency","typeLabel":"string\u003cstring>"},"target_currency":{"type":"string","x-order":20,"example":"BTC","format":"string","maxLength":10,"minLength":1,"description":"A valid currency","x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"uniqueKey":"data.quote_rate.target_currency","typeLabel":"string\u003cstring>"},"rate":{"type":"string","description":"decimal value","example":"100","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"uniqueKey":"data.quote_rate.rate","typeLabel":"string"},"side":{"type":"string","enum":["buy","sell"],"example":"sell","uniqueKey":"data.quote_rate.side","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["FIXED"],"example":"FIXED","uniqueKey":"data.quote_rate.type","typeLabel":"enum\u003cstring>"},"base_rate":{"type":"string","description":"decimal value","example":"100","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"uniqueKey":"data.quote_rate.base_rate","typeLabel":"string"},"discount":{"type":"object","description":"A volume discount the trade size earned. `rate` already includes it. Absent when no discount applied.\n","required":["percentage","saved","tier"],"properties":{"percentage":{"type":"string","description":"Percent off the base rate. \"0.10\" is 0.10%.","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"example":"0.10","isRequired":true,"uniqueKey":"data.quote_rate.discount.percentage","typeLabel":"string"},"saved":{"type":"object","description":"What the discount is worth before fees: extra of the currency received, or less of the currency paid.\n","required":["amount","currency"],"properties":{"amount":{"type":"string","description":"decimal value","example":"100","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"isRequired":true,"uniqueKey":"data.quote_rate.discount.saved.amount","typeLabel":"string"},"currency":{"type":"string","x-order":20,"example":"BTC","format":"string","maxLength":10,"minLength":1,"description":"A valid currency","x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"isRequired":true,"uniqueKey":"data.quote_rate.discount.saved.currency","typeLabel":"string\u003cstring>"}},"isRequired":true,"uniqueKey":"data.quote_rate.discount.saved","typeLabel":"object"},"tier":{"type":"object","description":"The rung the trade reached.","required":["from","currency"],"properties":{"from":{"type":"string","description":"The rung starts at trades of this size.","x-go-type":"decimal.Decimal","x-go-type-import":{"path":"github.com/shopspring/decimal","name":"decimal"},"example":"10000","isRequired":true,"uniqueKey":"data.quote_rate.discount.tier.from","typeLabel":"string"},"currency":{"type":"string","x-order":20,"example":"BTC","format":"string","maxLength":10,"minLength":1,"description":"A valid currency","x-oapi-codegen-extra-tags":{"validate":"required|min_len:1|max_len:10","filter":"trim|upper"},"isRequired":true,"uniqueKey":"data.quote_rate.discount.tier.currency","typeLabel":"string\u003cstring>"}},"isRequired":true,"uniqueKey":"data.quote_rate.discount.tier","typeLabel":"object"}},"uniqueKey":"data.quote_rate.discount","typeLabel":"object"}},"uniqueKey":"data.quote_rate","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"success","message":"message for success","data":{"id":"bus_123456789","type":"donation","status":"pending","source_amount":"100","source_currency":"BTC","target_amount":"100","target_currency":"BTC","requested_amount":"100","currency":"BTC","rate":{"product":"BTCUSDT","rate_explained":"1 BTC = 1000 USDT","source_currency":"BTC","target_currency":"BTC","rate":"100","side":"sell","type":"FIXED","base_rate":"100","discount":{"percentage":"0.10","saved":{"amount":"100","currency":"BTC"},"tier":{"from":"10000","currency":"BTC"}}},"fees":[{"name":"processing_fee","amount":{"amount":"100","currency":"BTC"},"type":"FIXED","converted_amount":{"amount":"100","currency":"BTC"}}],"reference":"\u003cstring>","additional_info":{"email":"jsmith@example.com","phone_number":"+2348012345678","name":"John","source":"web"},"merchant_info":{"name":"busha","email":"busha@me.com"},"created_at":"2023-10-15T12:15:30Z","updated_at":"2023-10-15T12:15:30Z","expires_at":"2023-10-15T12:15:30Z","pay_in":{"type":"address","recipient_id":"64ae8c26ea1033204c805a8a","address":"tb1qj4263506wyu8khrz2dwce0agk8lhyjgy269rxr","network":"BTC","memo":"address memo","narration":"Payment for services","payment_invoice_url":"https://example.com/invoice.pdf","profile_id":"profile-id-1234","recipient_details":{"account_name":"\u003cstring>","bank_name":"\u003cstring>","account_number":"\u003cstring>","country_code":"NG","provider":"\u003cstring>","iban":"NG12345678901234567890","currency":"\u003cstring>","phone_number":"\u003cstring>","name":"\u003cstring>","email":"sbsbs@busha.co","bank_code":"100020"},"blockchain_hash":"31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171","blockchain_url":"https://explorer.com/tx/31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171","session_id":"31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171","from_address":"31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171","expires_at":"2023-10-15T12:15:30Z"},"two_step":{"type":"authenticator","message":"Enter your 2FA code to continue","resend_allowed":false},"merchant_reference":"\u003cstring>","source":"\u003cstring>","source_id":"\u003cstring>","timeline":{"total_steps":123,"current_step":123,"transfer_status":"\u003cstring>","events":[{"step":1,"done":true,"status":"pending","title":"Transfer started","description":"Transfer started","timestamp":"2023-10-15T12:15:30Z"}]},"quote_rate":{"product":"BTCUSDT","rate_explained":"1 BTC = 1000 USDT","source_currency":"BTC","target_currency":"BTC","rate":"100","side":"sell","type":"FIXED","base_rate":"100","discount":{"percentage":"0.10","saved":{"amount":"100","currency":"BTC"},"tier":{"from":"10000","currency":"BTC"}}}}}}},"exampleType":"generated"}},"exampleType":"generated"},"37b0ef5b-0d26-44f4-be05-9e4cbcdcbe57":{"description":"Default","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["name","message"],"properties":{"name":{"type":"string","x-order":40,"example":"bad_request","isRequired":true,"uniqueKey":"error.name","typeLabel":"string"},"message":{"type":"string","example":"Invalid Request","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"fields":{"type":"object","uniqueKey":"fields","typeLabel":"object"},"schema":{"type":"array","items":{"type":"object","description":"One thing wrong with the request body: in prose for a person, and in a code and a pointer for a program. `reason` and `fix` are written by the validation library and their wording changes between releases of it; `code` and `pointer` do not, so branch on those.\n","properties":{"reason":{"type":"string","description":"What is wrong, in prose. For a person reading a log, not for code to match on.","example":"missing property 'additional_info'","uniqueKey":"schema.items.[INDEX].reason","typeLabel":"string"},"fix":{"type":"string","description":"What to do about it, in prose.","example":"Ensure that the object being submitted, matches the schema correctly","uniqueKey":"schema.items.[INDEX].fix","typeLabel":"string"},"code":{"type":"string","description":"What is wrong, as a stable token. `missing-property` for a required property left out, `type-mismatch` for a value of the wrong JSON type, `enum-mismatch` for a value outside the documented set, `pattern-mismatch` for a string that fails its pattern, `unknown-property` for a property the endpoint does not declare, `malformed-json` for a body that is not JSON at all, and `constraint-\u003ckeyword>` for any other JSON Schema keyword the body tripped.\n","example":"missing-property","uniqueKey":"schema.items.[INDEX].code","typeLabel":"string"},"pointer":{"type":"string","description":"Where it is wrong: an RFC 6901 JSON Pointer into the request body. The empty string points at the body itself, which is the answer when no single property is at fault.\n","example":"/additional_info","uniqueKey":"schema.items.[INDEX].pointer","typeLabel":"string"},"schema_validation_error":{"type":"array","description":"The validator's own specifics, where it produced any.","items":{"type":"string","uniqueKey":"schema.items.[INDEX].schema_validation_error.items.[INDEX]","typeLabel":"string"},"example":["minLength: got 3, want 12"],"uniqueKey":"schema.items.[INDEX].schema_validation_error","typeLabel":"string[]"}},"uniqueKey":"schema.items.[INDEX]","typeLabel":"object"},"uniqueKey":"schema","typeLabel":"object[]"}},"example":{"error":{"name":"bad_request","message":"Invalid Request"}},"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","description":"Default error","value":{"error":{"name":"bad_request","message":"Invalid request"}}},"not_found_error":{"title":"not_found_error","description":"Not Found error","value":{"error":{"name":"resource_not_found","message":"Resource Not Found"}}},"unauthorized_error":{"title":"unauthorized_error","description":"Unauthorized Error","value":{"error":{"name":"unauthorized","message":"Unauthorized request"}}},"request_validation_error":{"title":"request_validation_error","description":"Request Validation error example","value":{"error":{"name":"request_validation","message":"Validation error"},"fields":{"field1":[{"reason":"One of target and source amount must be set"}],"field2":[{"reason":"One of target and source amount must be set"}]}}},"schema_validation_error":{"title":"schema_validation_error","description":"Schema validation error example. One entry per violation, each with its own `code` and `pointer` naming what is wrong and where; branch on those rather than on the prose beside them.\n","value":{"error":{"name":"schema_validation","message":"Error Validating Requests"},"schema":[{"reason":"Missing property 'market'","fix":"Ensure that the object being submitted, matches the schema correctly","code":"missing-property","pointer":"/market","schema_validation_error":["missing property 'market'"]},{"reason":"MinLength: got 3, want 12","fix":"Ensure that the object being submitted, matches the schema correctly","code":"constraint-minlength","pointer":"/additional_info/name","schema_validation_error":["minLength: got 3, want 12"]}]}}},"exampleType":"examples"}},"exampleType":"examples"},"6eff4026-0f90-41d3-9003-292ce14af842":{"description":"Default","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["name","message"],"properties":{"name":{"type":"string","x-order":40,"example":"bad_request","isRequired":true,"uniqueKey":"error.name","typeLabel":"string"},"message":{"type":"string","example":"Invalid Request","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"fields":{"type":"object","uniqueKey":"fields","typeLabel":"object"},"schema":{"type":"array","items":{"type":"object","description":"One thing wrong with the request body: in prose for a person, and in a code and a pointer for a program. `reason` and `fix` are written by the validation library and their wording changes between releases of it; `code` and `pointer` do not, so branch on those.\n","properties":{"reason":{"type":"string","description":"What is wrong, in prose. For a person reading a log, not for code to match on.","example":"missing property 'additional_info'","uniqueKey":"schema.items.[INDEX].reason","typeLabel":"string"},"fix":{"type":"string","description":"What to do about it, in prose.","example":"Ensure that the object being submitted, matches the schema correctly","uniqueKey":"schema.items.[INDEX].fix","typeLabel":"string"},"code":{"type":"string","description":"What is wrong, as a stable token. `missing-property` for a required property left out, `type-mismatch` for a value of the wrong JSON type, `enum-mismatch` for a value outside the documented set, `pattern-mismatch` for a string that fails its pattern, `unknown-property` for a property the endpoint does not declare, `malformed-json` for a body that is not JSON at all, and `constraint-\u003ckeyword>` for any other JSON Schema keyword the body tripped.\n","example":"missing-property","uniqueKey":"schema.items.[INDEX].code","typeLabel":"string"},"pointer":{"type":"string","description":"Where it is wrong: an RFC 6901 JSON Pointer into the request body. The empty string points at the body itself, which is the answer when no single property is at fault.\n","example":"/additional_info","uniqueKey":"schema.items.[INDEX].pointer","typeLabel":"string"},"schema_validation_error":{"type":"array","description":"The validator's own specifics, where it produced any.","items":{"type":"string","uniqueKey":"schema.items.[INDEX].schema_validation_error.items.[INDEX]","typeLabel":"string"},"example":["minLength: got 3, want 12"],"uniqueKey":"schema.items.[INDEX].schema_validation_error","typeLabel":"string[]"}},"uniqueKey":"schema.items.[INDEX]","typeLabel":"object"},"uniqueKey":"schema","typeLabel":"object[]"}},"example":{"error":{"name":"bad_request","message":"Invalid Request"}},"uniqueKey":"","typeLabel":"object"},"examples":{"internal_server_error":{"title":"internal_server_error","description":"Internal Server Error","value":{"error":{"name":"internal_server_error","message":"Internal Server Error"}}},"service_unavailable_error":{"title":"service_unavailable_error","description":"Service Unavailable Error","value":{"error":{"name":"service_unavailable","message":"Service Unavailable"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e20c6cc1-ab53-442a-b067-3e4ad2ecb842":{"AuthOptional":{"type":"http","scheme":"bearer","description":"Bearer Authentication","scopes":["transfers:write","api:write"],"schemeName":"AuthOptional"}}},"servers":{"da7e1349-896d-4d44-bf50-5095dca769ae":{"url":"https://api.sandbox.busha.so","description":"Sandbox Environment"},"0117cc31-430c-47bd-9d4e-ad2e7f6fba80":{"url":"https://api.busha.io","description":"Production Environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer Authentication","scopes":["transfers:write","api:write"],"schemeName":"AuthOptional"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer Authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"AuthOptional","name":"Authorization"}],"title":"AuthOptional"}]},"originalFileLocation":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml"},"subdomain":"busha-36f167ef","siteName":"Busha Developer Documentation","title":"Busha Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T14:22:48.467Z","originalFileLocation":"api-reference/paymentrequests/create-a-payment-request.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=\"Create a payment request\">\u003cmeta data-mint-head name=\"application-name\" content=\"Busha Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/busha-36f167ef/S-rXk8aJPIs6tBWz/_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/busha-36f167ef/S-rXk8aJPIs6tBWz/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/busha-36f167ef/S-rXk8aJPIs6tBWz/_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/busha-36f167ef/S-rXk8aJPIs6tBWz/_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/busha-36f167ef/S-rXk8aJPIs6tBWz/_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/busha-36f167ef/S-rXk8aJPIs6tBWz/_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/busha-36f167ef/S-rXk8aJPIs6tBWz/_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/busha-36f167ef/S-rXk8aJPIs6tBWz/_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/busha-36f167ef/S-rXk8aJPIs6tBWz/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Busha Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Busha API documentation for developers. Integrate crypto trading, wallets, and payments into your app with our comprehensive guides and API references.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Busha Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.busha.io/api-reference/paymentrequests/create-a-payment-request\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://busha-36f167ef.mintlify.app/images/meta-image.png\">\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=\"Busha Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Busha API documentation for developers. Integrate crypto trading, wallets, and payments into your app with our comprehensive guides and API references.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://busha-36f167ef.mintlify.app/images/meta-image.png\">\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/busha-36f167ef/S-rXk8aJPIs6tBWz/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Busha Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#12A232\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.busha.io/api-reference/paymentrequests/create-a-payment-request\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/paymentrequests/create-a-payment-request.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.busha.io/#organization\",\"name\":\"Busha Developer Documentation\",\"url\":\"https://docs.busha.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/busha-36f167ef/bqGQAc9YwZBzW1ju/logo/light.svg?fit=max\u0026auto=format\u0026n=bqGQAc9YwZBzW1ju\u0026q=85\u0026s=08cf983a0716b1e5e0ccf2eabf9408a5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.busha.io#website\",\"name\":\"Busha Developer Documentation\",\"url\":\"https://docs.busha.io\",\"publisher\":{\"@id\":\"https://docs.busha.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.busha.io/api-reference/paymentrequests/create-a-payment-request#webpage\",\"url\":\"https://docs.busha.io/api-reference/paymentrequests/create-a-payment-request\",\"name\":\"Create a payment request\",\"description\":\"Create a payment request\",\"dateModified\":\"2026-10-26T14:22:48.467Z\",\"isPartOf\":{\"@id\":\"https://docs.busha.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.busha.io/api-reference/paymentrequests/create-a-payment-request#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.busha.io/api-reference/paymentrequests/create-a-payment-request#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.busha.io/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"PaymentRequests\",\"item\":\"https://docs.busha.io/api-reference/paymentrequests/list-payment-requests\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a payment request\",\"item\":\"https://docs.busha.io/api-reference/paymentrequests/create-a-payment-request\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.busha.io/api-reference/paymentrequests/create-a-payment-request#apireference\",\"headline\":\"Create a payment request\",\"name\":\"Create a payment request\",\"description\":\"Create a payment request\",\"url\":\"https://docs.busha.io/api-reference/paymentrequests/create-a-payment-request\",\"mainEntityOfPage\":{\"@id\":\"https://docs.busha.io/api-reference/paymentrequests/create-a-payment-request#webpage\"},\"image\":\"https://docs.busha.io/images/meta-image.png\",\"dateModified\":\"2026-10-26T14:22:48.467Z\",\"publisher\":{\"@id\":\"https://docs.busha.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.busha.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Busha Developer Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Busha Developer Documentation","nav":{"global":{"anchors":[{"anchor":"Guides","icon":"book-open-cover","href":"https://docs.busha.io/guides"},{"anchor":"Blog","icon":"newspaper","href":"https://busha.io/blog"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"https://docs.busha.io/changelog"}]},"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":"/overview/quotes"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/getting-started/quick-start"}]},{"tab":"Examples","pages":[{"title":"Examples","href":"/examples/introduction"}]},{"tab":"API Reference","groups":[{"group":"API reference","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"group":"Balances","pages":[{"title":"List all balances","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/balances","href":"/api-reference/balances/list-all-balances"},{"title":"Create currency balance","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/balances","href":"/api-reference/balances/create-currency-balance"},{"title":"Get balance details","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/balances/{id_or_code}","href":"/api-reference/balances/get-balance-details"}]},{"group":"Currencies","pages":[{"title":"Retrieve supported currencies","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/currencies","href":"/api-reference/currencies/retrieve-supported-currencies"},{"title":"Retrieve details of a specific currency","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/currencies/{code}","href":"/api-reference/currencies/retrieve-details-of-a-specific-currency"}]},{"group":"Customers","pages":[{"title":"List Customers","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/customers","href":"/api-reference/customers/list-customers"},{"title":"Create a new customer","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/customers","href":"/api-reference/customers/create-a-new-customer"},{"title":"Export Customers","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/customers/export","href":"/api-reference/customers/export-customers"},{"title":"Get a customer by ID","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/customers/{id}","href":"/api-reference/customers/get-a-customer-by-id"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml put /v1/customers/{id}","href":"/api-reference/customers/update-a-customer"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml delete /v1/customers/{id}","href":"/api-reference/customers/delete-a-customer"},{"title":"Verify a customer","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/customers/{id}/verify","href":"/api-reference/customers/verify-a-customer"},{"title":"Share customer token","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/customers/{id}/token-share","href":"/api-reference/customers/share-customer-token"},{"title":"Generate KYC link for a customer","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/customers/{id}/kyc-link","href":"/api-reference/customers/generate-kyc-link-for-a-customer"},{"title":"List Business Industries","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/customers/industries","href":"/api-reference/customers/list-business-industries"}]},{"group":"Files","pages":[{"title":"Generate presigned upload URL","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/files","href":"/api-reference/files/generate-presigned-upload-url"}]},{"group":"Insights","pages":[{"title":"Get transaction trends","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/insights/transactions/trends","href":"/api-reference/insights/get-transaction-trends"},{"title":"Get transaction breakdown","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/insights/transactions/breakdown","href":"/api-reference/insights/get-transaction-breakdown"},{"title":"Get customer growth","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/insights/customers/growth","href":"/api-reference/insights/get-customer-growth"}]},{"group":"Miscellaneous","pages":[{"title":"Validate payment destination","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/validate","href":"/api-reference/miscellaneous/validate-payment-destination"},{"title":"List banks resource","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/banks","href":"/api-reference/miscellaneous/list-banks-resource"},{"title":"Returns a list of countries","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/countries","href":"/api-reference/miscellaneous/returns-a-list-of-countries"},{"title":"Look up users addresses","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/pay/{username}","href":"/api-reference/miscellaneous/look-up-users-addresses"},{"title":"Get a merchant by public key","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/merchants","href":"/api-reference/miscellaneous/get-a-merchant-by-public-key"},{"title":"Get deposit address","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/addresses/{code}","href":"/api-reference/miscellaneous/get-deposit-address"},{"title":"Regenerate deposit address","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/addresses/regenerate","href":"/api-reference/miscellaneous/regenerate-deposit-address"},{"title":"Get virtual bank account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/virtual_bank_accounts/{code}","href":"/api-reference/miscellaneous/get-virtual-bank-account"},{"title":"Get virtual bank account terms","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/virtual_bank_accounts/{code}/terms","href":"/api-reference/miscellaneous/get-virtual-bank-account-terms"}]},{"group":"Pairs","pages":[{"title":"List trading pairs","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/pairs","href":"/api-reference/pairs/list-trading-pairs"}]},{"group":"PaymentLinks","pages":[{"title":"List payment links","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/payments/links","href":"/api-reference/paymentlinks/list-payment-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/payments/links","href":"/api-reference/paymentlinks/create-a-payment-link"},{"title":"Retrieve a payment link","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/payments/links/{id}","href":"/api-reference/paymentlinks/retrieve-a-payment-link"},{"title":"Delete a payment link","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml delete /v1/payments/links/{id}","href":"/api-reference/paymentlinks/delete-a-payment-link"},{"title":"Update a payment link","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml patch /v1/payments/links/{id}","href":"/api-reference/paymentlinks/update-a-payment-link"},{"title":"List payment requests for payment link","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/payments/links/{id}/requests","href":"/api-reference/paymentlinks/list-payment-requests-for-payment-link"},{"title":"Create a payment request for payment link","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/payments/links/{id}/requests","href":"/api-reference/paymentlinks/create-a-payment-request-for-payment-link"},{"title":"Activate a draft invoice","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/payments/links/{id}/activate","href":"/api-reference/paymentlinks/activate-a-draft-invoice"}]},{"group":"PaymentRequests","pages":[{"title":"List payment requests","description":"List payment requests","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/payments/requests","href":"/api-reference/paymentrequests/list-payment-requests"},{"title":"Create a payment request","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/payments/requests","href":"/api-reference/paymentrequests/create-a-payment-request"},{"title":"Retrieve a payment request","description":"Retrieve a payment request","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/payments/requests/{id}","href":"/api-reference/paymentrequests/retrieve-a-payment-request"},{"title":"Finalize a payment request","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/payments/requests/{id}/finalize","href":"/api-reference/paymentrequests/finalize-a-payment-request"}]},{"group":"Pledges","pages":[{"title":"Create pledge quote","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/pledges/quotes","href":"/api-reference/pledges/create-pledge-quote"},{"title":"List pledges","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/pledges","href":"/api-reference/pledges/list-pledges"},{"title":"Create pledge","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/pledges","href":"/api-reference/pledges/create-pledge"},{"title":"Get pledge","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/pledges/{id}","href":"/api-reference/pledges/get-pledge"},{"title":"Activate pledge","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/pledges/{id}/activate","href":"/api-reference/pledges/activate-pledge"},{"title":"Add pledge items","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/pledges/{id}/items","href":"/api-reference/pledges/add-pledge-items"},{"title":"Release pledge items","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/pledges/{id}/release","href":"/api-reference/pledges/release-pledge-items"},{"title":"Request pledge liquidation","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/pledges/{id}/liquidations","href":"/api-reference/pledges/request-pledge-liquidation"},{"title":"Cancel pledge liquidation","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/pledges/{id}/liquidations/{liquidation_id}/cancel","href":"/api-reference/pledges/cancel-pledge-liquidation"}]},{"group":"Quotes","pages":[{"title":"List Quotes","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/quotes","href":"/api-reference/quotes/list-quotes"},{"title":"Create a new Quote","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/quotes","href":"/api-reference/quotes/create-a-new-quote"},{"title":"Get Quote","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/quotes/{id}","href":"/api-reference/quotes/get-quote"},{"title":"Create Unauthenticated Quotes","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/quotes/unauthenticated","href":"/api-reference/quotes/create-unauthenticated-quotes"},{"title":"List Payment Options","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/quote/payment_options","href":"/api-reference/quotes/list-payment-options"},{"title":"List pending transfer approvals","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/quotes/pending-approvals","href":"/api-reference/quotes/list-pending-transfer-approvals"},{"title":"Reject a pending transfer approval","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/quotes/pending-approvals/{id}/reject","href":"/api-reference/quotes/reject-a-pending-transfer-approval"}]},{"group":"Recipients","pages":[{"title":"List recipients","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/recipients","href":"/api-reference/recipients/list-recipients"},{"title":"Create a recipient","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/recipients","href":"/api-reference/recipients/create-a-recipient"},{"title":"Retrieve a recipient","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/recipients/{id}","href":"/api-reference/recipients/retrieve-a-recipient"},{"title":"Delete a recipient","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml delete /v1/recipients/{id}","href":"/api-reference/recipients/delete-a-recipient"},{"title":"Resolves a bank account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/recipients/resolve-bank-account","href":"/api-reference/recipients/resolves-a-bank-account"}]},{"group":"Transactions","pages":[{"title":"List transactions","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/transactions","href":"/api-reference/transactions/list-transactions"},{"title":"Get transaction","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/transactions/{id}","href":"/api-reference/transactions/get-transaction"}]},{"group":"Transfers","pages":[{"title":"List transfers","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/transfers","href":"/api-reference/transfers/list-transfers"},{"title":"Create transfer","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml post /v1/transfers","href":"/api-reference/transfers/create-transfer"},{"title":"Get transfer","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/bushaHQ/openapi/refs/heads/main/openapi-spec.yaml get /v1/transfers/{id}","href":"/api-reference/transfers/get-transfer"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Busha Developer Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}