{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"One Pay","description":"One API to collect payments and send payouts in Cameroon and Nigeria.","colors":{"primary":"#0F5C46","light":"#2BB673","dark":"#0F5C46"},"logo":{"light":"https://mintcdn.com/one-market/Se0ezmOOY195lLow/logo/light.svg?fit=max\u0026auto=format\u0026n=Se0ezmOOY195lLow\u0026q=85\u0026s=ad6ba3c8d18dd50a939027d611948955","dark":"https://mintcdn.com/one-market/Se0ezmOOY195lLow/logo/dark.svg?fit=max\u0026auto=format\u0026n=Se0ezmOOY195lLow\u0026q=85\u0026s=923a1c16ba70b3fa6110f3fbec1a7abc"},"favicon":"https://mintcdn.com/one-market/Se0ezmOOY195lLow/favicon.svg?fit=max\u0026auto=format\u0026n=Se0ezmOOY195lLow\u0026q=85\u0026s=d71e674bc2509f0ac4660b144b0a018f","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python","php"]}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://onepay-c5or.vercel.app"}},"footer":{"links":[{"header":"One Pay","items":[{"label":"Dashboard","href":"https://onepay-c5or.vercel.app"}]}]},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"one-market","hasAudioNarration":false,"actualSubdomain":"one-market","customDomains":["pay.onemarketc.com"],"gitSource":{"type":"github","owner":"senorhuncho","repo":"onepay","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":"","_id":"6ae4951659fbac183e3b6421"},"chroma":{"latestBuiltDeploymentHistoryId":"6ae49a6a59fbac183e3ba6a3","collectionId":"7fb18fba-a80f-465d-a75b-08fe7ea07397","liveDeploymentHistoryId":"6ae49a6a59fbac183e3ba6a3","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae49a6a59fbac183e3ba6a3","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API reference","count":25},{"language":"default","tag":"Endpoints","count":24},{"language":"default","tag":"Guides","count":17},{"language":"default","tag":"Payouts","count":7},{"language":"default","tag":"Essentials","count":5},{"language":"default","tag":"Test helpers","count":4},{"language":"default","tag":"Events","count":3},{"language":"default","tag":"Payins","count":3},{"language":"default","tag":"Webhooks","count":3},{"language":"default","tag":"Get started","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/payins/collect-money-from-a-customer","slug":"/api-reference/payins/collect-money-from-a-customer","pageMetadata":{"title":"Collect money from a customer","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payins","href":"/api-reference/payins/collect-money-from-a-customer","autogeneratedByOpenApi":true},"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":"Collect money from a customer","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payins","href":"/api-reference/payins/collect-money-from-a-customer","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Payins"],"summary":"Collect money from a customer","operationId":"postV1Payins","parameters":["0efb060c-a5ad-437d-9079-f23239613308"],"requestBody":"538dc92c-e188-4681-a775-6c0bb43fe441","responses":{"201":"6caa1713-5558-446c-9dcd-bb7a39bf9b82","400":"4840a4d5-1137-45b9-9d99-7c38364f531c","401":"020bd34d-b084-452a-aee7-57de6c3dd79f","409":"924fd4f6-91f3-48d0-8288-3696e52d3dde","503":"c4995f30-d79d-4b7c-a4a0-cd5458f45ad1"},"method":"post","type":"path","servers":["2cd1c26d-0ad5-4918-9935-bb1ae10139d5","9dc76011-7683-4311-b883-fdf64eb75cb8"],"security":["c0ec9de6-5123-4a69-8d9a-09a1d2bd6ba1"],"path":"/v1/payins","baseUrlOptions":["https://onepay-api-eiy9.onrender.com","http://localhost:3000"],"title":"Collect money from a customer","description":"","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","php"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0efb060c-a5ad-437d-9079-f23239613308":{"name":"Idempotency-Key","in":"header","required":true,"description":"Your unique key for this request; retries reuse it.","schema":{"type":"string","minLength":1,"maxLength":255,"isRequired":true,"description":"Your unique key for this request; retries reuse it.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["amount","method","currency","customer"],"properties":{"amount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"oneOf.0.amount","typeLabel":"integer"},"method":{"type":"string","const":"mobile_money","isRequired":true,"uniqueKey":"oneOf.0.method","typeLabel":"string"},"currency":{"type":"string","const":"XAF","isRequired":true,"uniqueKey":"oneOf.0.currency","typeLabel":"string"},"customer":{"type":"object","properties":{"phone":{"type":"string","pattern":"^\\+2376\\d{8}$","isRequired":true,"uniqueKey":"oneOf.0.customer.phone","typeLabel":"string"}},"required":["phone"],"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.customer","typeLabel":"object"},"reference":{"type":"string","minLength":1,"maxLength":255,"uniqueKey":"oneOf.0.reference","typeLabel":"string"},"description":{"type":"string","minLength":1,"maxLength":500,"uniqueKey":"oneOf.0.description","typeLabel":"string"},"metadata":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":40},"additionalProperties":{"oneOf":[{"type":"string","maxLength":500,"uniqueKey":"oneOf.0.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.0.metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.0.metadata.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.0.metadata.additionalProperties.oneOf.3","typeLabel":"null"}],"uniqueKey":"oneOf.0.metadata.additionalProperties","typeLabel":"string | number | boolean | null"},"uniqueKey":"oneOf.0.metadata","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["amount","method","currency"],"properties":{"amount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"oneOf.1.amount","typeLabel":"integer"},"method":{"type":"string","const":"bank_transfer","isRequired":true,"uniqueKey":"oneOf.1.method","typeLabel":"string"},"currency":{"type":"string","const":"NGN","isRequired":true,"uniqueKey":"oneOf.1.currency","typeLabel":"string"},"reference":{"type":"string","minLength":1,"maxLength":255,"uniqueKey":"oneOf.1.reference","typeLabel":"string"},"description":{"type":"string","minLength":1,"maxLength":500,"uniqueKey":"oneOf.1.description","typeLabel":"string"},"metadata":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":40},"additionalProperties":{"oneOf":[{"type":"string","maxLength":500,"uniqueKey":"oneOf.1.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.1.metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.1.metadata.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.1.metadata.additionalProperties.oneOf.3","typeLabel":"null"}],"uniqueKey":"oneOf.1.metadata.additionalProperties","typeLabel":"string | number | boolean | null"},"uniqueKey":"oneOf.1.metadata","typeLabel":"object"},"customer":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","uniqueKey":"oneOf.1.customer.email","typeLabel":"string\u003cemail>"},"name":{"type":"string","minLength":1,"maxLength":100,"uniqueKey":"oneOf.1.customer.name","typeLabel":"string"},"phone":{"type":"string","pattern":"^\\+234\\d{10}$","uniqueKey":"oneOf.1.customer.phone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.1.customer","typeLabel":"object"},"return_url":{"type":"string","maxLength":2048,"format":"uri","uniqueKey":"oneOf.1.return_url","typeLabel":"string\u003curi>"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":123,"method":"mobile_money","currency":"XAF","customer":{"phone":"\u003cstring>"},"reference":"\u003cstring>","description":"\u003cstring>","metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6caa1713-5558-446c-9dcd-bb7a39bf9b82":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"status":{"type":"string","enum":["pending","processing","succeeded","failed","reversed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"amount","typeLabel":"integer"},"fee":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"fee","typeLabel":"integer"},"net_amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"net_amount","typeLabel":"integer"},"currency":{"type":"string","enum":["XAF","NGN"],"isRequired":true,"uniqueKey":"currency","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["mobile_money","bank_transfer"],"isRequired":true,"uniqueKey":"method","typeLabel":"enum\u003cstring>"},"customer":{"type":"object","properties":{"phone":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"customer.phone.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"customer.phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"customer.phone","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"customer.email.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"customer.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"customer.email","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"customer.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"customer.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"customer.name","typeLabel":"string | null"}},"required":["phone","email","name"],"additionalProperties":false,"isRequired":true,"uniqueKey":"customer","typeLabel":"object"},"reference":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"reference.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"reference","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"description","typeLabel":"string | null"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"metadata.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"metadata.additionalProperties.oneOf.3","typeLabel":"null"}],"uniqueKey":"metadata.additionalProperties","typeLabel":"string | number | boolean | null"},"isRequired":true,"uniqueKey":"metadata","typeLabel":"object"},"failure":{"oneOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"failure.oneOf.0.code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"failure.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"failure.oneOf.0.message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"failure.oneOf.0.message","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"failure.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"failure.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"failure","typeLabel":"object | null"},"next_action":{"oneOf":[{"type":"object","required":["type","url"],"properties":{"type":{"type":"string","const":"redirect_to_url","isRequired":true,"uniqueKey":"next_action.oneOf.0.type","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.0.url","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"next_action.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"next_action.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_action","typeLabel":"object | null"},"mode":{"type":"string","enum":["test","live"],"isRequired":true,"uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"succeeded_at":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","isRequired":true,"uniqueKey":"succeeded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"succeeded_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"succeeded_at","typeLabel":"string\u003cdate-time> | null"},"failed_at":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","isRequired":true,"uniqueKey":"failed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"failed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"failed_at","typeLabel":"string\u003cdate-time> | null"},"settled_at":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","isRequired":true,"uniqueKey":"settled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"settled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"settled_at","typeLabel":"string\u003cdate-time> | null"}},"required":["id","status","amount","fee","net_amount","currency","method","customer","reference","description","metadata","failure","next_action","mode","created_at","updated_at","succeeded_at","failed_at","settled_at"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","status":"pending","amount":0,"fee":0,"net_amount":0,"currency":"XAF","method":"mobile_money","customer":{"phone":"\u003cstring>","email":"\u003cstring>","name":"\u003cstring>"},"reference":"\u003cstring>","description":"\u003cstring>","metadata":{},"failure":{"code":"\u003cstring>","message":"\u003cstring>"},"next_action":{"type":"redirect_to_url","url":"\u003cstring>"},"mode":"test","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","succeeded_at":"2023-11-07T05:31:56Z","failed_at":"2023-11-07T05:31:56Z","settled_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"4840a4d5-1137-45b9-9d99-7c38364f531c":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message","request_id"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"020bd34d-b084-452a-aee7-57de6c3dd79f":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message","request_id"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"924fd4f6-91f3-48d0-8288-3696e52d3dde":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message","request_id"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c4995f30-d79d-4b7c-a4a0-cd5458f45ad1":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message","request_id"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c0ec9de6-5123-4a69-8d9a-09a1d2bd6ba1":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your secret key: sk_test_... or sk_live_...","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"2cd1c26d-0ad5-4918-9935-bb1ae10139d5":{"url":"https://onepay-api-eiy9.onrender.com","description":"One Pay (your key decides test or live)"},"9dc76011-7683-4311-b883-fdf64eb75cb8":{"url":"http://localhost:3000","description":"Local development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your secret key: sk_test_... or sk_live_...","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your secret key: sk_test_... or sk_live_...","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"one-market","siteName":"One Pay","title":"Collect money from a customer - One Pay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T13:24:18.056Z","originalFileLocation":"api-reference/payins/collect-money-from-a-customer.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=\"application-name\" content=\"One Pay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/one-market/0r-EXjwRfV824NBk/_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=\"/docs/mintlify-assets/_mintlify/favicons/one-market/0r-EXjwRfV824NBk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/one-market/0r-EXjwRfV824NBk/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/one-market/0r-EXjwRfV824NBk/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/one-market/0r-EXjwRfV824NBk/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/one-market/0r-EXjwRfV824NBk/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/one-market/0r-EXjwRfV824NBk/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/one-market/0r-EXjwRfV824NBk/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/one-market/0r-EXjwRfV824NBk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Collect money from a customer - One Pay\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"One Pay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://pay.onemarketc.com/docs/api-reference/payins/collect-money-from-a-customer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://one-market.mintlify.app/_mintlify/api/og/v2?division=Payins\u0026amp;title=Collect+money+from+a+customer\u0026amp;theme=3e45f8aa97103524187231bb\u0026amp;signature=68ae487877fbf6b798bd94515546d1c1fa5d908ce946950c87ed43aa68bae24b\">\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=\"Collect money from a customer - One Pay\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://one-market.mintlify.app/_mintlify/api/og/v2?division=Payins\u0026amp;title=Collect+money+from+a+customer\u0026amp;theme=3e45f8aa97103524187231bb\u0026amp;signature=68ae487877fbf6b798bd94515546d1c1fa5d908ce946950c87ed43aa68bae24b\">\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=\"/docs/mintlify-assets/_mintlify/favicons/one-market/0r-EXjwRfV824NBk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"One Pay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F5C46\">\u003clink data-mint-head rel=\"canonical\" href=\"https://pay.onemarketc.com/docs/api-reference/payins/collect-money-from-a-customer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/payins/collect-money-from-a-customer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://pay.onemarketc.com/#organization\",\"name\":\"One Pay\",\"url\":\"https://pay.onemarketc.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/one-market/Se0ezmOOY195lLow/logo/light.svg?fit=max\u0026auto=format\u0026n=Se0ezmOOY195lLow\u0026q=85\u0026s=ad6ba3c8d18dd50a939027d611948955\"}},{\"@type\":\"WebSite\",\"@id\":\"https://pay.onemarketc.com/docs#website\",\"name\":\"One Pay\",\"url\":\"https://pay.onemarketc.com/docs\",\"publisher\":{\"@id\":\"https://pay.onemarketc.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://pay.onemarketc.com/docs/api-reference/payins/collect-money-from-a-customer#webpage\",\"url\":\"https://pay.onemarketc.com/docs/api-reference/payins/collect-money-from-a-customer\",\"name\":\"Collect money from a customer\",\"dateModified\":\"2026-10-30T13:24:18.056Z\",\"isPartOf\":{\"@id\":\"https://pay.onemarketc.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://pay.onemarketc.com/docs/api-reference/payins/collect-money-from-a-customer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://pay.onemarketc.com/docs/api-reference/payins/collect-money-from-a-customer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://pay.onemarketc.com/docs/api-reference/system/check-the-api-and-database-are-up\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payins\",\"item\":\"https://pay.onemarketc.com/docs/api-reference/payins/list-payins-newest-first\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Collect money from a customer\",\"item\":\"https://pay.onemarketc.com/docs/api-reference/payins/collect-money-from-a-customer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://pay.onemarketc.com/docs/api-reference/payins/collect-money-from-a-customer#apireference\",\"headline\":\"Collect money from a customer\",\"name\":\"Collect money from a customer\",\"url\":\"https://pay.onemarketc.com/docs/api-reference/payins/collect-money-from-a-customer\",\"mainEntityOfPage\":{\"@id\":\"https://pay.onemarketc.com/docs/api-reference/payins/collect-money-from-a-customer#webpage\"},\"dateModified\":\"2026-10-30T13:24:18.056Z\",\"publisher\":{\"@id\":\"https://pay.onemarketc.com/#organization\"},\"isPartOf\":{\"@id\":\"https://pay.onemarketc.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"One Pay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"One Pay","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"System","pages":[{"title":"Check the API and database are up","deprecated":null,"version":null,"openapi":"/openapi.json get /health","href":"/api-reference/system/check-the-api-and-database-are-up"},{"title":"This API description","deprecated":null,"version":null,"openapi":"/openapi.json get /openapi.json","href":"/api-reference/system/this-api-description"}]},{"group":"Merchant","pages":[{"title":"The merchant that owns the API key","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/merchant","href":"/api-reference/merchant/the-merchant-that-owns-the-api-key"},{"title":"Available, pending and reserved balances per currency","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/balances","href":"/api-reference/merchant/available-pending-and-reserved-balances-per-currency"}]},{"group":"Payins","pages":[{"title":"List payins, newest first","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payins","href":"/api-reference/payins/list-payins-newest-first"},{"title":"Collect money from a customer","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payins","href":"/api-reference/payins/collect-money-from-a-customer"},{"title":"Get a payin","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payins/{id}","href":"/api-reference/payins/get-a-payin"}]},{"group":"Payouts","pages":[{"title":"List payouts, newest first","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payouts","href":"/api-reference/payouts/list-payouts-newest-first"},{"title":"Send money from the available balance","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payouts","href":"/api-reference/payouts/send-money-from-the-available-balance"},{"title":"Get a payout","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payouts/{id}","href":"/api-reference/payouts/get-a-payout"},{"title":"Bank codes for bank account payouts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/banks","href":"/api-reference/payouts/bank-codes-for-bank-account-payouts"},{"title":"List payout recipients","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payout_recipients","href":"/api-reference/payouts/list-payout-recipients"},{"title":"Register a bank account to pay out to (reviewed first)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payout_recipients","href":"/api-reference/payouts/register-a-bank-account-to-pay-out-to-reviewed-first"},{"title":"Get a payout recipient and its review status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payout_recipients/{id}","href":"/api-reference/payouts/get-a-payout-recipient-and-its-review-status"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhook_endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Register a URL to receive events (secret shown once)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhook_endpoints","href":"/api-reference/webhooks/register-a-url-to-receive-events-secret-shown-once"},{"title":"Disable a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/webhook_endpoints/{id}","href":"/api-reference/webhooks/disable-a-webhook-endpoint"}]},{"group":"Events","pages":[{"title":"List events, newest first","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/events","href":"/api-reference/events/list-events-newest-first"},{"title":"Get an event","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/events/{id}","href":"/api-reference/events/get-an-event"},{"title":"Send an event again to the enabled endpoints","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/events/{id}/resend","href":"/api-reference/events/send-an-event-again-to-the-enabled-endpoints"}]},{"group":"Test helpers","pages":[{"title":"Test mode: customer approves","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/test_helpers/payins/{id}/succeed","href":"/api-reference/test-helpers/test-mode:-customer-approves"},{"title":"Test mode: customer declines","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/test_helpers/payins/{id}/fail","href":"/api-reference/test-helpers/test-mode:-customer-declines"},{"title":"Test mode: partner completes","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/test_helpers/payouts/{id}/succeed","href":"/api-reference/test-helpers/test-mode:-partner-completes"},{"title":"Test mode: partner fails","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/test_helpers/payouts/{id}/fail","href":"/api-reference/test-helpers/test-mode:-partner-fails"}]}]}]}]},"title":"Collect money from a customer - One Pay","buildId":"dpl_DGmhKsAzJdVqypJzon18vViniWRY","deploymentId":"dpl_DGmhKsAzJdVqypJzon18vViniWRY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-2jF_ccbi.js","utils-NNMVb_sb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DdtBhtt6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D1OxL5O8.js","snippetPresets-DDC-KAXp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BOnTqOyQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-EEWI6FIO.js","shallow-fGZcWzm2.js","getApiPlaygroundDisplay-B3B8qEvw.js","CodeSnippet-BG9nsSU4.js","CodeSnippets-BlRACLKl.js","Page-FtoC8lZ9.js","getPastedJson-COV-Kgnr.js","icon-BXu3lasn.js","MethodPill-DGMUqJKh.js","DuplicateIcon-JEUJDHz_.js","createIcon-BDFucJ34.js","DynamicMarkdown-34OtG_BH.js","SectionHeading-tBbRD59j.js","axios-vUo_bRtp.js","Markdown-SoRz2nk2.js","clsx-BOmkPVIU.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DN0dCbTw.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BcsLYcfW.js"]}