Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.
Unique identifier for the payout. This ensures idempotency for multiple payouts
that have been done by a single merchant. This field is auto generated and is returned in the API response.
Unique identifier for the payout. This ensures idempotency for multiple payouts
that have been done by a single merchant. This field is auto generated and is returned in the API response.
The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,
Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.
The payout_type of the payout request is a mandatory field for confirming the payouts. It should be specified in the Create request. If not provided, it must be updated in the Payout Update request before it can be confirmed.
You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BirrPay","colors":{"primary":"#4F8EFF","light":"#6BA3FF","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/birrpay/YnpImjYt65LKI-RI/logo/light.svg?fit=max\u0026auto=format\u0026n=YnpImjYt65LKI-RI\u0026q=85\u0026s=410fca5e1e3112fa410bfe0f1bc67731","dark":"https://mintcdn.com/birrpay/541dDB4gOfow0DxB/logo/dark.svg?fit=max\u0026auto=format\u0026n=541dDB4gOfow0DxB\u0026q=85\u0026s=e38313db04f8e480c019afc36f86deed"},"favicon":"/favicon.svg","api":{"openapi":["v1/openapi_spec_v1.json","v2/openapi_spec_v2.json","rust_locker_open_api_spec.yml"]},"background":{"color":{"light":"#FAFBFC","dark":"#1d1d1d"}},"navbar":{"links":[{"href":"https://birrpay.io/contactus","label":"Contact Us"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/birrpay-ethiopia"}},"integrations":{"gtm":{"tagId":"GTM-NQNN2JG5"},"mixpanel":{"projectToken":"b637c4588c180272bf586c5376e524e6"}},"contextual":{"options":["copy","claude","chatgpt","view"]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"birrpay","hasAudioNarration":false,"actualSubdomain":"birrpay","customDomains":["docs.birrpay.io"],"gitSource":{"type":"gitlab","owner":"birrpay","repo":"hyperswitch","projectId":77700133,"deployBranch":"develop","contentDirectory":"api-reference","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21eaf12fb2a99bab92c3fd","collectionId":"e126846c-3fdf-4d9b-8ab0-45d072d25e19","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21eaf12fb2a99bab92c3fd:success","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Documentation","count":183},{"language":"default","tag":"Payments Core APIs","count":53},{"language":"default","tag":"Other APIs","count":35},{"language":"default","tag":"Payments Core APIs [BETA]","count":32},{"language":"default","tag":"Account management APIs","count":28},{"language":"default","tag":"Account management APIs [BETA]","count":27},{"language":"default","tag":"Payments","count":26},{"language":"default","tag":"API Reference","count":24},{"language":"default","tag":"Routing","count":17},{"language":"default","tag":"Payment Methods","count":16}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v1/payouts/payouts--cancel","slug":"/v1/payouts/payouts--cancel","pageMetadata":{"openapi":"post /payouts/{payout_id}/cancel","title":"Payouts - Cancel","description":null,"href":"/v1/payouts/payouts--cancel","hidden":false},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /payouts/{payout_id}/cancel","title":"Payouts - Cancel","description":null,"href":"/v1/payouts/payouts--cancel","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Payouts"],"summary":"Payouts - Cancel","operationId":"Cancel a Payout","parameters":["9db361fd-bc33-4297-845e-7e784f80a45c"],"requestBody":"06ec9aed-cc6d-4760-b988-947951023cee","responses":{"200":"fc4e8f93-d088-4675-b378-df91c32790a5","400":"11143011-34e6-4d59-bc77-ea48e7fc80d2"},"security":["bcbecdd3-650d-40d1-b73e-3eb2487d24e1"],"method":"post","type":"path","servers":["792875b0-3b61-48a0-ab23-731c1218999a"],"path":"/payouts/{payout_id}/cancel","baseUrlOptions":["https://sandbox.birrpay.io"],"title":"Payouts - Cancel","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9db361fd-bc33-4297-845e-7e784f80a45c":{"name":"payout_id","in":"path","description":"The identifier for payout","required":true,"schema":{"type":"string","isRequired":true,"description":"The identifier for payout","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["payout_id"],"properties":{"payout_id":{"type":"string","description":"Unique identifier for the payout. This ensures idempotency for multiple payouts\nthat have been done by a single merchant. This field is auto generated and is returned in the API response.","example":"187282ab-40ef-47a9-9206-5099ba31e432","maxLength":30,"minLength":30,"isRequired":true,"uniqueKey":"payout_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payout_id":"187282ab-40ef-47a9-9206-5099ba31e432"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"fc4e8f93-d088-4675-b378-df91c32790a5":{"description":"Payout cancelled","content":{"application/json":{"schema":{"type":"object","required":["payout_id","merchant_id","amount","currency","auto_fulfill","customer_id","client_secret","return_url","business_country","entity_type","recurring","status","profile_id"],"properties":{"payout_id":{"type":"string","description":"Unique identifier for the payout. This ensures idempotency for multiple payouts\nthat have been done by a single merchant. This field is auto generated and is returned in the API response.","example":"187282ab-40ef-47a9-9206-5099ba31e432","maxLength":30,"minLength":30,"isRequired":true,"uniqueKey":"payout_id","typeLabel":"string"},"merchant_id":{"type":"string","description":"This is an identifier for the merchant account. This is inferred from the API key\nprovided during the request","example":"merchant_1668273825","maxLength":255,"isRequired":true,"uniqueKey":"merchant_id","typeLabel":"string"},"amount":{"type":"integer","format":"int64","description":"The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,","example":1000,"isRequired":true,"uniqueKey":"amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"isRequired":true,"uniqueKey":"currency","typeLabel":"enum\u003cstring>"},"auto_fulfill":{"type":"boolean","description":"Set to true to confirm the payout without review, no further action required","default":false,"example":true,"isRequired":true,"uniqueKey":"auto_fulfill","typeLabel":"boolean"},"customer_id":{"type":"string","description":"The identifier for the customer object. If not provided the customer ID will be autogenerated.","example":"cus_y3oqhf46pyzuxjbcn2giaqnb44","maxLength":255,"isRequired":true,"uniqueKey":"customer_id","typeLabel":"string"},"client_secret":{"type":"string","description":"It's a token used for client side verification.","example":"pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo","isRequired":true,"uniqueKey":"client_secret","typeLabel":"string"},"return_url":{"type":"string","description":"The URL to redirect after the completion of the operation","example":"https://birrpay.io","isRequired":true,"uniqueKey":"return_url","typeLabel":"string"},"business_country":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"isRequired":true,"uniqueKey":"business_country","typeLabel":"enum\u003cstring>"},"entity_type":{"type":"string","description":"Type of entity to whom the payout is being carried out to, select from the given list of options","enum":["Individual","Company","NonProfit","PublicSector","NaturalPerson","lowercase","Personal"],"isRequired":true,"uniqueKey":"entity_type","typeLabel":"enum\u003cstring>"},"recurring":{"type":"boolean","description":"Specifies whether or not the payout request is recurring","default":false,"isRequired":true,"uniqueKey":"recurring","typeLabel":"boolean"},"status":{"type":"string","enum":["success","failed","cancelled","initiated","expired","reversed","pending","ineligible","requires_creation","requires_confirmation","requires_payout_method_data","requires_fulfillment","requires_vendor_account_creation"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"profile_id":{"type":"string","description":"The business profile that is associated with this payout","isRequired":true,"uniqueKey":"profile_id","typeLabel":"string"},"merchant_order_reference_id":{"oneOf":[{"type":"string","description":"Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.","example":"merchant_order_ref_123","maxLength":255,"uniqueKey":"merchant_order_reference_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.","example":"merchant_order_ref_123","maxLength":255,"uniqueKey":"merchant_order_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_order_reference_id","typeLabel":"string | null"},"connector":{"oneOf":[{"type":"string","description":"The connector used for the payout","example":"wise","uniqueKey":"connector.oneOf.0","typeLabel":"string"},{"type":"null","description":"The connector used for the payout","example":"wise","uniqueKey":"connector.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector","typeLabel":"string | null"},"payout_type":{"oneOf":[{"type":"string","description":"The payout_type of the payout request is a mandatory field for confirming the payouts. It should be specified in the Create request. If not provided, it must be updated in the Payout Update request before it can be confirmed.","enum":["card","bank","wallet","bank_redirect"],"uniqueKey":"payout_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payout_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_type","typeLabel":"enum\u003cstring> | null"},"payout_method_data":{"oneOf":[{"type":"object","description":"The payout method information for response","required":["card"],"properties":{"card":{"type":"object","description":"Masked payout method details for card payout method","required":["card_exp_month","card_exp_year","card_holder_name"],"properties":{"card_exp_month":{"type":"string","description":"Card expiry month","example":"01","isRequired":true,"uniqueKey":"payout_method_data.oneOf.0.card.card_exp_month","typeLabel":"string"},"card_exp_year":{"type":"string","description":"Card expiry year","example":"2026","isRequired":true,"uniqueKey":"payout_method_data.oneOf.0.card.card_exp_year","typeLabel":"string"},"card_holder_name":{"type":"string","description":"Card holder name","example":"John Doe","isRequired":true,"uniqueKey":"payout_method_data.oneOf.0.card.card_holder_name","typeLabel":"string"},"card_issuer":{"oneOf":[{"type":"string","description":"Issuer of the card","uniqueKey":"payout_method_data.oneOf.0.card.card_issuer.oneOf.0","typeLabel":"string"},{"type":"null","description":"Issuer of the card","uniqueKey":"payout_method_data.oneOf.0.card.card_issuer.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.0.card.card_issuer","typeLabel":"string | null"},"card_network":{"oneOf":[{"type":"string","description":"Indicates the card network.","enum":["Visa","Mastercard","AmericanExpress","JCB","DinersClub","Discover","CartesBancaires","UnionPay","Interac","RuPay","Maestro","Star","Pulse","Accel","Nyce"],"uniqueKey":"payout_method_data.oneOf.0.card.card_network.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payout_method_data.oneOf.0.card.card_network.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.0.card.card_network","typeLabel":"enum\u003cstring> | null"},"card_type":{"oneOf":[{"type":"string","description":"Card type, can be either `credit` or `debit`","uniqueKey":"payout_method_data.oneOf.0.card.card_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Card type, can be either `credit` or `debit`","uniqueKey":"payout_method_data.oneOf.0.card.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.0.card.card_type","typeLabel":"string | null"},"card_issuing_country":{"oneOf":[{"type":"string","description":"Card issuing country","uniqueKey":"payout_method_data.oneOf.0.card.card_issuing_country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Card issuing country","uniqueKey":"payout_method_data.oneOf.0.card.card_issuing_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.0.card.card_issuing_country","typeLabel":"string | null"},"bank_code":{"oneOf":[{"type":"string","description":"Code for Card issuing bank","uniqueKey":"payout_method_data.oneOf.0.card.bank_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Code for Card issuing bank","uniqueKey":"payout_method_data.oneOf.0.card.bank_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.0.card.bank_code","typeLabel":"string | null"},"last4":{"oneOf":[{"type":"string","description":"Last 4 digits of the card number","uniqueKey":"payout_method_data.oneOf.0.card.last4.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last 4 digits of the card number","uniqueKey":"payout_method_data.oneOf.0.card.last4.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.0.card.last4","typeLabel":"string | null"},"card_isin":{"oneOf":[{"type":"string","description":"The ISIN of the card","uniqueKey":"payout_method_data.oneOf.0.card.card_isin.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ISIN of the card","uniqueKey":"payout_method_data.oneOf.0.card.card_isin.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.0.card.card_isin","typeLabel":"string | null"},"card_extended_bin":{"oneOf":[{"type":"string","description":"Extended bin of card, contains the first 8 digits of card number","uniqueKey":"payout_method_data.oneOf.0.card.card_extended_bin.oneOf.0","typeLabel":"string"},{"type":"null","description":"Extended bin of card, contains the first 8 digits of card number","uniqueKey":"payout_method_data.oneOf.0.card.card_extended_bin.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.0.card.card_extended_bin","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payout_method_data.oneOf.0.card","typeLabel":"object"}},"uniqueKey":"payout_method_data.oneOf.0","typeLabel":"object"},{"type":"object","description":"The payout method information for response","required":["bank"],"properties":{"bank":{"oneOf":[{"type":"object","description":"Masked payout method details for bank payout method","required":["bank_account_number","bank_routing_number"],"properties":{"bank_account_number":{"type":"string","description":"Partially masked account number for ach bank debit payment","example":"0001****3456","isRequired":true,"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.0.bank_account_number","typeLabel":"string"},"bank_routing_number":{"type":"string","description":"Partially masked routing number for ach bank debit payment","example":"110***000","isRequired":true,"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.0.bank_routing_number","typeLabel":"string"},"bank_name":{"oneOf":[{"type":"string","description":"Name of banks supported by BirrPay","enum":["american_express","affin_bank","agro_bank","alliance_bank","am_bank","bank_of_america","bank_of_china","bank_islam","bank_muamalat","bank_rakyat","bank_simpanan_nasional","barclays","blik_p_s_p","capital_one","chase","citi","cimb_bank","discover","navy_federal_credit_union","pentagon_federal_credit_union","synchrony_bank","wells_fargo","abn_amro","asn_bank","bunq","handelsbanken","hong_leong_bank","hsbc_bank","ing","knab","kuwait_finance_house","moneyou","rabobank","regiobank","revolut","sns_bank","triodos_bank","van_lanschot","arzte_und_apotheker_bank","austrian_anadi_bank_ag","bank_austria","bank99_ag","bankhaus_carl_spangler","bankhaus_schelhammer_und_schattera_ag","bank_millennium","bank_p_e_k_a_o_s_a","bawag_psk_ag","bks_bank_ag","brull_kallmus_bank_ag","btv_vier_lander_bank","capital_bank_grawe_gruppe_ag","ceska_sporitelna","dolomitenbank","easybank_ag","e_platby_v_u_b","erste_bank_und_sparkassen","friesland_bank","hypo_alpeadriabank_international_ag","hypo_noe_lb_fur_niederosterreich_u_wien","hypo_oberosterreich_salzburg_steiermark","hypo_tirol_bank_ag","hypo_vorarlberg_bank_ag","hypo_bank_burgenland_aktiengesellschaft","komercni_banka","m_bank","marchfelder_bank","maybank","oberbank_ag","osterreichische_arzte_und_apothekerbank","ocbc_bank","pay_with_i_n_g","place_z_i_p_k_o","platnosc_online_karta_platnicza","posojilnica_bank_e_gen","postova_banka","public_bank","raiffeisen_bankengruppe_osterreich","rhb_bank","schelhammer_capital_bank_ag","standard_chartered_bank","schoellerbank_ag","sparda_bank_wien","sporo_pay","santander_przelew24","tatra_pay","viamo","volksbank_gruppe","volkskreditbank_ag","vr_bank_braunau","uob_bank","pay_with_alior_bank","banki_spoldzielcze","pay_with_inteligo","b_n_p_paribas_poland","bank_nowy_s_a","credit_agricole","pay_with_b_o_s","pay_with_citi_handlowy","pay_with_plus_bank","toyota_bank","velo_bank","e_transfer_pocztowy24","plus_bank","etransfer_pocztowy24","banki_spbdzielcze","bank_nowy_bfg_sa","getin_bank","blik","noble_pay","idea_bank","envelo_bank","nest_przelew","mbank_mtransfer","inteligo","pbac_z_ipko","bnp_paribas","bank_pekao_sa","volkswagen_bank","alior_bank","boz","bangkok_bank","krungsri_bank","krung_thai_bank","the_siam_commercial_bank","kasikorn_bank","open_bank_success","open_bank_failure","open_bank_cancelled","aib","bank_of_scotland","danske_bank","first_direct","first_trust","halifax","lloyds","monzo","nat_west","nationwide_bank","royal_bank_of_scotland","starling","tsb_bank","tesco_bank","ulster_bank","yoursafe","n26","nationale_nederlanden"],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.0.bank_name.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.0.bank_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.0.bank_name","typeLabel":"enum\u003cstring> | null"},"bank_country_code":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.0.bank_country_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.0.bank_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.0.bank_country_code","typeLabel":"enum\u003cstring> | null"},"bank_city":{"oneOf":[{"type":"string","description":"Bank city","example":"California","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.0.bank_city.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank city","example":"California","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.0.bank_city.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.0.bank_city","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.0","typeLabel":"object"},{"type":"object","description":"Masked payout method details for bank payout method","required":["bank_sort_code","bank_account_number"],"properties":{"bank_sort_code":{"type":"string","description":"Partially masked sort code for Bacs payment method","example":"108800","isRequired":true,"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.1.bank_sort_code","typeLabel":"string"},"bank_account_number":{"type":"string","description":"Bank account's owner name","example":"0001****3456","isRequired":true,"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.1.bank_account_number","typeLabel":"string"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name","example":"Deutsche Bank","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.1.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name","example":"Deutsche Bank","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.1.bank_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.1.bank_name","typeLabel":"string | null"},"bank_country_code":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.1.bank_country_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.1.bank_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.1.bank_country_code","typeLabel":"enum\u003cstring> | null"},"bank_city":{"oneOf":[{"type":"string","description":"Bank city","example":"California","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.1.bank_city.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank city","example":"California","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.1.bank_city.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.1.bank_city","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.1","typeLabel":"object"},{"type":"object","description":"Masked payout method details for bank payout method","required":["iban"],"properties":{"iban":{"type":"string","description":"Partially masked international bank account number (iban) for SEPA","example":"DE8937******013000","isRequired":true,"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.2.iban","typeLabel":"string"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name","example":"Deutsche Bank","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.2.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name","example":"Deutsche Bank","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.2.bank_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.2.bank_name","typeLabel":"string | null"},"bank_country_code":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.2.bank_country_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.2.bank_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.2.bank_country_code","typeLabel":"enum\u003cstring> | null"},"bank_city":{"oneOf":[{"type":"string","description":"Bank city","example":"California","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.2.bank_city.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank city","example":"California","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.2.bank_city.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.2.bank_city","typeLabel":"string | null"},"bic":{"oneOf":[{"type":"string","description":"[8 / 11 digits] Bank Identifier Code (bic) / Swift Code - used in many countries for identifying a bank and it's branches","example":"HSBCGB2LXXX","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.2.bic.oneOf.0","typeLabel":"string"},{"type":"null","description":"[8 / 11 digits] Bank Identifier Code (bic) / Swift Code - used in many countries for identifying a bank and it's branches","example":"HSBCGB2LXXX","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.2.bic.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.2.bic","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.2","typeLabel":"object"},{"type":"object","description":"Masked payout method details for bank payout method","properties":{"pix_key":{"oneOf":[{"type":"string","description":"Partially masked unique key for pix transfer","example":"a1f4102e ****** 6fa48899c1d1","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.pix_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"Partially masked unique key for pix transfer","example":"a1f4102e ****** 6fa48899c1d1","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.pix_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.pix_key","typeLabel":"string | null"},"cpf":{"oneOf":[{"type":"string","description":"Partially masked CPF - CPF is a Brazilian tax identification number","example":"**** 124689","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.cpf.oneOf.0","typeLabel":"string"},{"type":"null","description":"Partially masked CPF - CPF is a Brazilian tax identification number","example":"**** 124689","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.cpf.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.cpf","typeLabel":"string | null"},"cnpj":{"oneOf":[{"type":"string","description":"Partially masked CNPJ - CNPJ is a Brazilian company tax identification number","example":"**** 417312","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.cnpj.oneOf.0","typeLabel":"string"},{"type":"null","description":"Partially masked CNPJ - CNPJ is a Brazilian company tax identification number","example":"**** 417312","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.cnpj.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.cnpj","typeLabel":"string | null"},"source_bank_account_id":{"oneOf":[{"type":"string","description":"Partially masked source bank account number","example":"********-****-4073-****-9fa964d08bc5","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.source_bank_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Partially masked source bank account number","example":"********-****-4073-****-9fa964d08bc5","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.source_bank_account_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.source_bank_account_id","typeLabel":"string | null"},"destination_bank_account_id":{"oneOf":[{"type":"string","description":"Partially masked destination bank account number _Deprecated: Will be removed in next stable release._","deprecated":true,"example":"********-****-460b-****-f23b4e71c97b","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.destination_bank_account_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Partially masked destination bank account number _Deprecated: Will be removed in next stable release._","deprecated":true,"example":"********-****-460b-****-f23b4e71c97b","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.destination_bank_account_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.destination_bank_account_id","typeLabel":"string | null"},"expiry_date":{"oneOf":[{"type":"string","description":"The expiration date and time for the Pix QR code in ISO 8601 format","example":"2025-09-10T10:11:12Z","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.expiry_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"The expiration date and time for the Pix QR code in ISO 8601 format","example":"2025-09-10T10:11:12Z","uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.expiry_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3.expiry_date","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payout_method_data.oneOf.1.bank.oneOf.3","typeLabel":"object"}],"isRequired":true,"uniqueKey":"payout_method_data.oneOf.1.bank","typeLabel":"object"}},"uniqueKey":"payout_method_data.oneOf.1","typeLabel":"object"},{"type":"object","description":"The payout method information for response","required":["wallet"],"properties":{"wallet":{"oneOf":[{"type":"object","description":"Masked payout method details for wallet payout method","properties":{"email":{"oneOf":[{"type":"string","description":"Email linked with paypal account","example":"[email protected]","uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email linked with paypal account","example":"[email protected]","uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.0.email","typeLabel":"string | null"},"telephone_number":{"oneOf":[{"type":"string","description":"mobile number linked to paypal account","example":"******* 3349","uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.0.telephone_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"mobile number linked to paypal account","example":"******* 3349","uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.0.telephone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.0.telephone_number","typeLabel":"string | null"},"paypal_id":{"oneOf":[{"type":"string","description":"id of the paypal account","example":"G83K ***** HCQ2","uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.0.paypal_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"id of the paypal account","example":"G83K ***** HCQ2","uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.0.paypal_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.0.paypal_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.0","typeLabel":"object"},{"type":"object","description":"Masked payout method details for wallet payout method","properties":{"telephone_number":{"oneOf":[{"type":"string","description":"mobile number linked to venmo account","example":"******* 3349","uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.1.telephone_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"mobile number linked to venmo account","example":"******* 3349","uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.1.telephone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.1.telephone_number","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.1","typeLabel":"object"},{"type":"object","description":"Masked payout method details for wallet payout method","required":["card_exp_month","card_exp_year","card_holder_name"],"properties":{"card_exp_month":{"type":"string","description":"Card expiry month","example":"01","isRequired":true,"uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.2.card_exp_month","typeLabel":"string"},"card_exp_year":{"type":"string","description":"Card expiry year","example":"2026","isRequired":true,"uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.2.card_exp_year","typeLabel":"string"},"card_holder_name":{"type":"string","description":"Card holder name","example":"John Doe","isRequired":true,"uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.2.card_holder_name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payout_method_data.oneOf.2.wallet.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"payout_method_data.oneOf.2.wallet","typeLabel":"object"}},"uniqueKey":"payout_method_data.oneOf.2","typeLabel":"object"},{"type":"object","description":"The payout method information for response","required":["bank_redirect"],"properties":{"bank_redirect":{"type":"object","description":"Masked payout method details for wallet payout method","properties":{"email":{"oneOf":[{"type":"string","description":"Email linked with interac account","example":"[email protected]","uniqueKey":"payout_method_data.oneOf.3.bank_redirect.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email linked with interac account","example":"[email protected]","uniqueKey":"payout_method_data.oneOf.3.bank_redirect.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_data.oneOf.3.bank_redirect.email","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payout_method_data.oneOf.3.bank_redirect","typeLabel":"object"}},"uniqueKey":"payout_method_data.oneOf.3","typeLabel":"object"},{"type":"object","description":"The payout method information for response","required":["passthrough"],"properties":{"passthrough":{"type":"object","description":"additional payout method details for passthrough payout method","required":["psp_token","token_type"],"properties":{"psp_token":{"type":"string","description":"Psp_token of the passthrough flow","example":"token_12345","isRequired":true,"uniqueKey":"payout_method_data.oneOf.4.passthrough.psp_token","typeLabel":"string"},"token_type":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eps","flexiti","fps","evoucher","giropay","givex","google_pay","go_pay","gcash","ideal","interac","indomaret","klarna","kakao_pay","local_bank_redirect","mandiri_va","knet","mb_way","mobile_pay","momo","momo_atm","multibanco","online_banking_thailand","online_banking_czech_republic","online_banking_finland","online_banking_fpx","online_banking_poland","online_banking_slovakia","oxxo","pago_efectivo","permata_bank_transfer","open_banking_uk","pay_bright","payjustnow","paypal","paze","pix","pay_safe_card","przelewy24","prompt_pay","pse","qris","red_compra","red_pagos","samsung_pay","sepa","sepa_bank_transfer","sepa_guarenteed_debit","skrill","sofort","swish","touch_n_go","trustly","twint","upi_collect","upi_intent","upi_qr","vipps","viet_qr","venmo","walley","we_chat_pay","seven_eleven","lawson","mini_stop","family_mart","seicomart","pay_easy","local_bank_transfer","mifinity","open_banking_pis","direct_carrier_billing","instant_bank_transfer","instant_bank_transfer_finland","instant_bank_transfer_poland","revolut_pay","indonesian_bank_transfer","open_banking","network_token"],"isRequired":true,"uniqueKey":"payout_method_data.oneOf.4.passthrough.token_type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"payout_method_data.oneOf.4.passthrough","typeLabel":"object"}},"uniqueKey":"payout_method_data.oneOf.4","typeLabel":"object"},{"type":"null","uniqueKey":"payout_method_data.oneOf.5","typeLabel":"null"}],"uniqueKey":"payout_method_data","typeLabel":"object · object · object · object · object · null"},"billing":{"oneOf":[{"type":"object","properties":{"address":{"oneOf":[{"type":"object","description":"Address details","properties":{"city":{"oneOf":[{"type":"string","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"billing.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"billing.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.country","typeLabel":"enum\u003cstring> | null"},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.line2","typeLabel":"string | null"},"line3":{"oneOf":[{"type":"string","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line3.oneOf.0","typeLabel":"string"},{"type":"null","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line3.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.line3","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.zip","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"The address state","example":"New York","uniqueKey":"billing.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The address state","example":"New York","uniqueKey":"billing.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.state","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"billing.oneOf.0.address.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"billing.oneOf.0.address.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"billing.oneOf.0.address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"billing.oneOf.0.address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.last_name","typeLabel":"string | null"},"origin_zip":{"oneOf":[{"type":"string","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.origin_zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.origin_zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.origin_zip","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0.address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address","typeLabel":"object | null"},"phone":{"oneOf":[{"type":"object","properties":{"number":{"oneOf":[{"type":"string","description":"The contact number","example":"9123456789","uniqueKey":"billing.oneOf.0.phone.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The contact number","example":"9123456789","uniqueKey":"billing.oneOf.0.phone.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.phone.oneOf.0.number","typeLabel":"string | null"},"country_code":{"oneOf":[{"type":"string","description":"The country code attached to the number","example":"+1","uniqueKey":"billing.oneOf.0.phone.oneOf.0.country_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The country code attached to the number","example":"+1","uniqueKey":"billing.oneOf.0.phone.oneOf.0.country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.phone.oneOf.0.country_code","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0.phone.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.phone","typeLabel":"object | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"billing.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"billing.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing","typeLabel":"object | null"},"customer":{"oneOf":[{"type":"object","description":"Details of customer attached to this payment","properties":{"id":{"oneOf":[{"type":"string","description":"The identifier for the customer.","example":"cus_y3oqhf46pyzuxjbcn2giaqnb44","maxLength":64,"minLength":1,"uniqueKey":"customer.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The identifier for the customer.","example":"cus_y3oqhf46pyzuxjbcn2giaqnb44","maxLength":64,"minLength":1,"uniqueKey":"customer.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"The customer's name","example":"John Doe","maxLength":255,"uniqueKey":"customer.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's name","example":"John Doe","maxLength":255,"uniqueKey":"customer.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"The customer's email address","example":"[email protected]","maxLength":255,"uniqueKey":"customer.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's email address","example":"[email protected]","maxLength":255,"uniqueKey":"customer.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"The customer's phone number","example":"9123456789","maxLength":10,"uniqueKey":"customer.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's phone number","example":"9123456789","maxLength":10,"uniqueKey":"customer.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.phone","typeLabel":"string | null"},"phone_country_code":{"oneOf":[{"type":"string","description":"The country code for the customer's phone number","example":"+1","maxLength":2,"uniqueKey":"customer.oneOf.0.phone_country_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The country code for the customer's phone number","example":"+1","maxLength":2,"uniqueKey":"customer.oneOf.0.phone_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.phone_country_code","typeLabel":"string | null"}},"uniqueKey":"customer.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer","typeLabel":"object | null"},"business_label":{"oneOf":[{"type":"string","description":"Business label of the merchant for this payout","example":"food","uniqueKey":"business_label.oneOf.0","typeLabel":"string"},{"type":"null","description":"Business label of the merchant for this payout","example":"food","uniqueKey":"business_label.oneOf.1","typeLabel":"null"}],"uniqueKey":"business_label","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"A description of the payout","example":"It's my first payout request","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description of the payout","example":"It's my first payout request","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","description":"You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"merchant_connector_id":{"oneOf":[{"type":"string","description":"Unique identifier of the merchant connector account","example":"mca_sAD3OZLATetvjLOYhUSy","uniqueKey":"merchant_connector_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the merchant connector account","example":"mca_sAD3OZLATetvjLOYhUSy","uniqueKey":"merchant_connector_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_connector_id","typeLabel":"string | null"},"error_message":{"oneOf":[{"type":"string","description":"If there was an error while calling the connector the error message is received here","example":"Failed while verifying the card","uniqueKey":"error_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"If there was an error while calling the connector the error message is received here","example":"Failed while verifying the card","uniqueKey":"error_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_message","typeLabel":"string | null"},"error_code":{"oneOf":[{"type":"string","description":"If there was an error while calling the connectors the code is received here","example":"E0001","uniqueKey":"error_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"If there was an error while calling the connectors the code is received here","example":"E0001","uniqueKey":"error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_code","typeLabel":"string | null"},"created":{"oneOf":[{"type":"string","format":"date-time","description":"Time when the payout was created","example":"2022-09-10T10:11:12Z","uniqueKey":"created.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Time when the payout was created","example":"2022-09-10T10:11:12Z","uniqueKey":"created.oneOf.1","typeLabel":"null"}],"uniqueKey":"created","typeLabel":"string\u003cdate-time> | null"},"connector_transaction_id":{"oneOf":[{"type":"string","description":"Underlying processor's payout resource ID","example":"S3FC9G9M2MVFDXT5","uniqueKey":"connector_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Underlying processor's payout resource ID","example":"S3FC9G9M2MVFDXT5","uniqueKey":"connector_transaction_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_transaction_id","typeLabel":"string | null"},"priority":{"oneOf":[{"type":"string","description":"The send method which will be required for processing payouts, check options for better understanding.","enum":["instant","fast","regular","wire","cross_border","internal"],"uniqueKey":"priority.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"priority.oneOf.1","typeLabel":"null"}],"uniqueKey":"priority","typeLabel":"enum\u003cstring> | null"},"attempts":{"oneOf":[{"type":"array","items":{"type":"object","required":["attempt_id","status","amount"],"properties":{"attempt_id":{"type":"string","description":"Unique identifier for the attempt","isRequired":true,"uniqueKey":"attempts.oneOf.0.items.[INDEX].attempt_id","typeLabel":"string"},"status":{"type":"string","enum":["success","failed","cancelled","initiated","expired","reversed","pending","ineligible","requires_creation","requires_confirmation","requires_payout_method_data","requires_fulfillment","requires_vendor_account_creation"],"isRequired":true,"uniqueKey":"attempts.oneOf.0.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","format":"int64","description":"The payout attempt amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,","example":6583,"isRequired":true,"uniqueKey":"attempts.oneOf.0.items.[INDEX].amount","typeLabel":"integer\u003cint64>"},"currency":{"oneOf":[{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"uniqueKey":"attempts.oneOf.0.items.[INDEX].currency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"attempts.oneOf.0.items.[INDEX].currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"attempts.oneOf.0.items.[INDEX].currency","typeLabel":"enum\u003cstring> | null"},"connector":{"oneOf":[{"type":"string","description":"The connector used for the payout","uniqueKey":"attempts.oneOf.0.items.[INDEX].connector.oneOf.0","typeLabel":"string"},{"type":"null","description":"The connector used for the payout","uniqueKey":"attempts.oneOf.0.items.[INDEX].connector.oneOf.1","typeLabel":"null"}],"uniqueKey":"attempts.oneOf.0.items.[INDEX].connector","typeLabel":"string | null"},"error_code":{"oneOf":[{"type":"string","description":"Connector's error code in case of failures","uniqueKey":"attempts.oneOf.0.items.[INDEX].error_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Connector's error code in case of failures","uniqueKey":"attempts.oneOf.0.items.[INDEX].error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"attempts.oneOf.0.items.[INDEX].error_code","typeLabel":"string | null"},"error_message":{"oneOf":[{"type":"string","description":"Connector's error message in case of failures","uniqueKey":"attempts.oneOf.0.items.[INDEX].error_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Connector's error message in case of failures","uniqueKey":"attempts.oneOf.0.items.[INDEX].error_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"attempts.oneOf.0.items.[INDEX].error_message","typeLabel":"string | null"},"payment_method":{"oneOf":[{"type":"string","description":"The payout_type of the payout request is a mandatory field for confirming the payouts. It should be specified in the Create request. If not provided, it must be updated in the Payout Update request before it can be confirmed.","enum":["card","bank","wallet","bank_redirect"],"uniqueKey":"attempts.oneOf.0.items.[INDEX].payment_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"attempts.oneOf.0.items.[INDEX].payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"attempts.oneOf.0.items.[INDEX].payment_method","typeLabel":"enum\u003cstring> | null"},"payout_method_type":{"oneOf":[{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eps","flexiti","fps","evoucher","giropay","givex","google_pay","go_pay","gcash","ideal","interac","indomaret","klarna","kakao_pay","local_bank_redirect","mandiri_va","knet","mb_way","mobile_pay","momo","momo_atm","multibanco","online_banking_thailand","online_banking_czech_republic","online_banking_finland","online_banking_fpx","online_banking_poland","online_banking_slovakia","oxxo","pago_efectivo","permata_bank_transfer","open_banking_uk","pay_bright","payjustnow","paypal","paze","pix","pay_safe_card","przelewy24","prompt_pay","pse","qris","red_compra","red_pagos","samsung_pay","sepa","sepa_bank_transfer","sepa_guarenteed_debit","skrill","sofort","swish","touch_n_go","trustly","twint","upi_collect","upi_intent","upi_qr","vipps","viet_qr","venmo","walley","we_chat_pay","seven_eleven","lawson","mini_stop","family_mart","seicomart","pay_easy","local_bank_transfer","mifinity","open_banking_pis","direct_carrier_billing","instant_bank_transfer","instant_bank_transfer_finland","instant_bank_transfer_poland","revolut_pay","indonesian_bank_transfer","open_banking","network_token"],"uniqueKey":"attempts.oneOf.0.items.[INDEX].payout_method_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"attempts.oneOf.0.items.[INDEX].payout_method_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"attempts.oneOf.0.items.[INDEX].payout_method_type","typeLabel":"enum\u003cstring> | null"},"connector_transaction_id":{"oneOf":[{"type":"string","description":"A unique identifier for a payout provided by the connector","uniqueKey":"attempts.oneOf.0.items.[INDEX].connector_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"A unique identifier for a payout provided by the connector","uniqueKey":"attempts.oneOf.0.items.[INDEX].connector_transaction_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"attempts.oneOf.0.items.[INDEX].connector_transaction_id","typeLabel":"string | null"},"cancellation_reason":{"oneOf":[{"type":"string","description":"If the payout was cancelled the reason provided here","uniqueKey":"attempts.oneOf.0.items.[INDEX].cancellation_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"If the payout was cancelled the reason provided here","uniqueKey":"attempts.oneOf.0.items.[INDEX].cancellation_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"attempts.oneOf.0.items.[INDEX].cancellation_reason","typeLabel":"string | null"},"unified_code":{"oneOf":[{"type":"string","description":"(This field is not live yet)\nError code unified across the connectors is received here in case of errors while calling the underlying connector","example":"UE_000","maxLength":255,"uniqueKey":"attempts.oneOf.0.items.[INDEX].unified_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"(This field is not live yet)\nError code unified across the connectors is received here in case of errors while calling the underlying connector","example":"UE_000","maxLength":255,"uniqueKey":"attempts.oneOf.0.items.[INDEX].unified_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"attempts.oneOf.0.items.[INDEX].unified_code","typeLabel":"string | null"},"unified_message":{"oneOf":[{"type":"string","description":"(This field is not live yet)\nError message unified across the connectors is received here in case of errors while calling the underlying connector","example":"Invalid card details","maxLength":1024,"uniqueKey":"attempts.oneOf.0.items.[INDEX].unified_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"(This field is not live yet)\nError message unified across the connectors is received here in case of errors while calling the underlying connector","example":"Invalid card details","maxLength":1024,"uniqueKey":"attempts.oneOf.0.items.[INDEX].unified_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"attempts.oneOf.0.items.[INDEX].unified_message","typeLabel":"string | null"}},"uniqueKey":"attempts.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"List of attempts","uniqueKey":"attempts.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["attempt_id","status","amount"],"properties":{"attempt_id":{"type":"string","description":"Unique identifier for the attempt"},"status":{"type":"string","enum":["success","failed","cancelled","initiated","expired","reversed","pending","ineligible","requires_creation","requires_confirmation","requires_payout_method_data","requires_fulfillment","requires_vendor_account_creation"]},"amount":{"type":"integer","format":"int64","description":"The payout attempt amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,","example":6583},"currency":{"oneOf":[{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"]},{"type":"null"}]},"connector":{"oneOf":[{"type":"string","description":"The connector used for the payout"},{"type":"null","description":"The connector used for the payout"}]},"error_code":{"oneOf":[{"type":"string","description":"Connector's error code in case of failures"},{"type":"null","description":"Connector's error code in case of failures"}]},"error_message":{"oneOf":[{"type":"string","description":"Connector's error message in case of failures"},{"type":"null","description":"Connector's error message in case of failures"}]},"payment_method":{"oneOf":[{"type":"string","description":"The payout_type of the payout request is a mandatory field for confirming the payouts. It should be specified in the Create request. If not provided, it must be updated in the Payout Update request before it can be confirmed.","enum":["card","bank","wallet","bank_redirect"]},{"type":"null"}]},"payout_method_type":{"oneOf":[{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eps","flexiti","fps","evoucher","giropay","givex","google_pay","go_pay","gcash","ideal","interac","indomaret","klarna","kakao_pay","local_bank_redirect","mandiri_va","knet","mb_way","mobile_pay","momo","momo_atm","multibanco","online_banking_thailand","online_banking_czech_republic","online_banking_finland","online_banking_fpx","online_banking_poland","online_banking_slovakia","oxxo","pago_efectivo","permata_bank_transfer","open_banking_uk","pay_bright","payjustnow","paypal","paze","pix","pay_safe_card","przelewy24","prompt_pay","pse","qris","red_compra","red_pagos","samsung_pay","sepa","sepa_bank_transfer","sepa_guarenteed_debit","skrill","sofort","swish","touch_n_go","trustly","twint","upi_collect","upi_intent","upi_qr","vipps","viet_qr","venmo","walley","we_chat_pay","seven_eleven","lawson","mini_stop","family_mart","seicomart","pay_easy","local_bank_transfer","mifinity","open_banking_pis","direct_carrier_billing","instant_bank_transfer","instant_bank_transfer_finland","instant_bank_transfer_poland","revolut_pay","indonesian_bank_transfer","open_banking","network_token"]},{"type":"null"}]},"connector_transaction_id":{"oneOf":[{"type":"string","description":"A unique identifier for a payout provided by the connector"},{"type":"null","description":"A unique identifier for a payout provided by the connector"}]},"cancellation_reason":{"oneOf":[{"type":"string","description":"If the payout was cancelled the reason provided here"},{"type":"null","description":"If the payout was cancelled the reason provided here"}]},"unified_code":{"oneOf":[{"type":"string","description":"(This field is not live yet)\nError code unified across the connectors is received here in case of errors while calling the underlying connector","example":"UE_000","maxLength":255},{"type":"null","description":"(This field is not live yet)\nError code unified across the connectors is received here in case of errors while calling the underlying connector","example":"UE_000","maxLength":255}]},"unified_message":{"oneOf":[{"type":"string","description":"(This field is not live yet)\nError message unified across the connectors is received here in case of errors while calling the underlying connector","example":"Invalid card details","maxLength":1024},{"type":"null","description":"(This field is not live yet)\nError message unified across the connectors is received here in case of errors while calling the underlying connector","example":"Invalid card details","maxLength":1024}]}}},"description":"List of attempts","uniqueKey":"attempts.oneOf.1","typeLabel":"null"}],"uniqueKey":"attempts","typeLabel":"object[] | null"},"payout_link":{"oneOf":[{"type":"object","required":["payout_link_id","link"],"properties":{"payout_link_id":{"type":"string","isRequired":true,"uniqueKey":"payout_link.oneOf.0.payout_link_id","typeLabel":"string"},"link":{"type":"string","isRequired":true,"uniqueKey":"payout_link.oneOf.0.link","typeLabel":"string"}},"uniqueKey":"payout_link.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payout_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link","typeLabel":"object | null"},"email":{"oneOf":[{"type":"string","description":"Customer's email. _Deprecated: Use customer object instead._","deprecated":true,"example":"[email protected]","maxLength":255,"uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer's email. _Deprecated: Use customer object instead._","deprecated":true,"example":"[email protected]","maxLength":255,"uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Customer's name. _Deprecated: Use customer object instead._","deprecated":true,"example":"John Test","maxLength":255,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer's name. _Deprecated: Use customer object instead._","deprecated":true,"example":"John Test","maxLength":255,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"Customer's phone. _Deprecated: Use customer object instead._","deprecated":true,"example":"9123456789","maxLength":255,"uniqueKey":"phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer's phone. _Deprecated: Use customer object instead._","deprecated":true,"example":"9123456789","maxLength":255,"uniqueKey":"phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone","typeLabel":"string | null"},"phone_country_code":{"oneOf":[{"type":"string","description":"Customer's phone country code. _Deprecated: Use customer object instead._","deprecated":true,"example":"+1","maxLength":255,"uniqueKey":"phone_country_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer's phone country code. _Deprecated: Use customer object instead._","deprecated":true,"example":"+1","maxLength":255,"uniqueKey":"phone_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone_country_code","typeLabel":"string | null"},"unified_code":{"oneOf":[{"type":"string","description":"(This field is not live yet)\nError code unified across the connectors is received here in case of errors while calling the underlying connector","example":"UE_000","maxLength":255,"uniqueKey":"unified_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"(This field is not live yet)\nError code unified across the connectors is received here in case of errors while calling the underlying connector","example":"UE_000","maxLength":255,"uniqueKey":"unified_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"unified_code","typeLabel":"string | null"},"unified_message":{"oneOf":[{"type":"string","description":"(This field is not live yet)\nError message unified across the connectors is received here in case of errors while calling the underlying connector","example":"Invalid card details","maxLength":1024,"uniqueKey":"unified_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"(This field is not live yet)\nError message unified across the connectors is received here in case of errors while calling the underlying connector","example":"Invalid card details","maxLength":1024,"uniqueKey":"unified_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"unified_message","typeLabel":"string | null"},"payout_method_id":{"oneOf":[{"type":"string","description":"Identifier for payout method","uniqueKey":"payout_method_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identifier for payout method","uniqueKey":"payout_method_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_method_id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payout_id":"187282ab-40ef-47a9-9206-5099ba31e432","merchant_id":"merchant_1668273825","amount":1000,"currency":"AED","auto_fulfill":true,"customer_id":"cus_y3oqhf46pyzuxjbcn2giaqnb44","client_secret":"pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo","return_url":"https://birrpay.io","business_country":"AF","entity_type":"Individual","recurring":false,"status":"success","profile_id":"\u003cstring>","merchant_order_reference_id":"merchant_order_ref_123","connector":"wise","payout_type":"card","payout_method_data":{"card":{"card_exp_month":"01","card_exp_year":"2026","card_holder_name":"John Doe","card_issuer":"\u003cstring>","card_network":"Visa","card_type":"\u003cstring>","card_issuing_country":"\u003cstring>","bank_code":"\u003cstring>","last4":"\u003cstring>","card_isin":"\u003cstring>","card_extended_bin":"\u003cstring>"}},"billing":{"address":{"city":"New York","country":"AF","line1":"123, King Street","line2":"Powelson Avenue","line3":"Bridgewater","zip":"08807","state":"New York","first_name":"John","last_name":"Doe","origin_zip":"08807"},"phone":{"number":"9123456789","country_code":"+1"},"email":"\u003cstring>"},"customer":{"id":"cus_y3oqhf46pyzuxjbcn2giaqnb44","name":"John Doe","email":"[email protected]","phone":"9123456789","phone_country_code":"+1"},"business_label":"food","description":"It's my first payout request","metadata":{},"merchant_connector_id":"mca_sAD3OZLATetvjLOYhUSy","error_message":"Failed while verifying the card","error_code":"E0001","created":"2022-09-10T10:11:12Z","connector_transaction_id":"S3FC9G9M2MVFDXT5","priority":"instant","attempts":[{"attempt_id":"\u003cstring>","status":"success","amount":6583,"currency":"AED","connector":"\u003cstring>","error_code":"\u003cstring>","error_message":"\u003cstring>","payment_method":"card","payout_method_type":"ach","connector_transaction_id":"\u003cstring>","cancellation_reason":"\u003cstring>","unified_code":"UE_000","unified_message":"Invalid card details"}],"payout_link":{"payout_link_id":"\u003cstring>","link":"\u003cstring>"},"email":"[email protected]","name":"John Test","phone":"9123456789","phone_country_code":"+1","unified_code":"UE_000","unified_message":"Invalid card details","payout_method_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"11143011-34e6-4d59-bc77-ea48e7fc80d2":{"description":"Missing Mandatory fields","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"bcbecdd3-650d-40d1-b73e-3eb2487d24e1":{"api_key":{"type":"apiKey","in":"header","name":"api-key","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","scopes":[]}}},"servers":{"792875b0-3b61-48a0-ab23-731c1218999a":{"url":"https://sandbox.birrpay.io","description":"Sandbox Environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"api-key","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","scopes":[]},"schema":{"title":"api-key","type":"string","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"api-key"}],"title":"api_key"}]},"originalFileLocation":"v1/openapi_spec_v1.json"},"subdomain":"birrpay","siteName":"BirrPay","title":"Payouts - Cancel - BirrPay","navMaps":{"firstHrefInVersion":{"1.0.0":{"href":"/v1/payouts/payouts--cancel","matchLevel":0},"2.0.0 [BETA]":{"href":"/introduction","matchLevel":3}},"firstHrefInLanguage":{}},"lastModified":"2026-02-05T01:27:24.967Z","originalFileLocation":"v1/payouts/payouts--cancel.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=\"BirrPay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Payouts - Cancel - BirrPay\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BirrPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.birrpay.io/v1/payouts/payouts--cancel\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://birrpay.mintlify.app/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Payouts+-+Cancel\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=dc157398f779a947280d339ac2f689eab2535a3a5f13033d65f8473d8c875115\">\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=\"Payouts - Cancel - BirrPay\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://birrpay.mintlify.app/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Payouts+-+Cancel\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=dc157398f779a947280d339ac2f689eab2535a3a5f13033d65f8473d8c875115\">\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/birrpay/UMKKiD5ajm4x882S/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BirrPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F8EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.birrpay.io/v1/payouts/payouts--cancel\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v1/payouts/payouts--cancel.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.birrpay.io/#organization\",\"name\":\"BirrPay\",\"url\":\"https://docs.birrpay.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/birrpay/YnpImjYt65LKI-RI/logo/light.svg?fit=max\u0026auto=format\u0026n=YnpImjYt65LKI-RI\u0026q=85\u0026s=410fca5e1e3112fa410bfe0f1bc67731\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.birrpay.io#website\",\"name\":\"BirrPay\",\"url\":\"https://docs.birrpay.io\",\"publisher\":{\"@id\":\"https://docs.birrpay.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.birrpay.io/v1/payouts/payouts--cancel#webpage\",\"url\":\"https://docs.birrpay.io/v1/payouts/payouts--cancel\",\"name\":\"Payouts - Cancel\",\"dateModified\":\"2026-02-05T01:27:24.967Z\",\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.birrpay.io/v1/payouts/payouts--cancel#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.birrpay.io/v1/payouts/payouts--cancel#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payments Core APIs\",\"item\":\"https://docs.birrpay.io/v1/payments/setup--instructions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payouts\",\"item\":\"https://docs.birrpay.io/v1/payouts/payouts--create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Payouts - Cancel\",\"item\":\"https://docs.birrpay.io/v1/payouts/payouts--cancel\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.birrpay.io/v1/payouts/payouts--cancel#apireference\",\"headline\":\"Payouts - Cancel\",\"name\":\"Payouts - Cancel\",\"url\":\"https://docs.birrpay.io/v1/payouts/payouts--cancel\",\"mainEntityOfPage\":{\"@id\":\"https://docs.birrpay.io/v1/payouts/payouts--cancel#webpage\"},\"dateModified\":\"2026-02-05T01:27:24.967Z\",\"publisher\":{\"@id\":\"https://docs.birrpay.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BirrPay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"BirrPay","nav":{"global":null,"tabs":[{"tab":"Documentation","versions":[{"version":"1.0.0","groups":[{"group":"Get Started","pages":[{"title":"👋 Welcome to BirrPay API Reference","sidebarTitle":"Introduction","icon":"rectangle-code","iconType":"solid","href":"/introduction","hidden":false}]},{"group":"Essentials","pages":[{"title":"Authentication Types","href":"/essentials/authentication"},{"title":"Error Codes","href":"/essentials/error_codes"},{"title":"Rate Limits","href":"/essentials/rate_limit"},{"title":"Go-live Checklist","href":"/essentials/go-live"}]},{"group":"Payments Core APIs","pages":[{"sidebarTitle":"Setup Instructions","icon":"flag","iconType":"solid","title":null,"href":"/v1/payments/setup--instructions"},{"sidebarTitle":"Payment Flows","icon":"arrows-retweet","iconType":"solid","title":null,"href":"/v1/payments/payment--flows"},{"group":"Payments","pages":[{"openapi":"post /payments","title":"Payments - Create","href":"/v1/payments/payments--create"},{"openapi":"post /payments/{payment_id}","title":"Payments - Update","href":"/v1/payments/payments--update"},{"openapi":"post /payments/{payment_id}/confirm","title":"Payments - Confirm","href":"/v1/payments/payments--confirm"},{"openapi":"get /payments/{payment_id}","title":"Payments - Retrieve","href":"/v1/payments/payments--retrieve"},{"openapi":"post /payments/{payment_id}/cancel","title":"Payments - Cancel","href":"/v1/payments/payments--cancel"},{"openapi":"post /payments/{payment_id}/cancel_post_capture","title":"Payments - Cancel Post Capture","href":"/v1/payments/payments--cancel-post-capture"},{"openapi":"post /payments/{payment_id}/capture","title":"Payments - Capture","href":"/v1/payments/payments--capture"},{"openapi":"post /payments/{payment_id}/incremental_authorization","title":"Payments - Incremental Authorization","href":"/v1/payments/payments--incremental-authorization"},{"openapi":"post /payments/{payment_id}/extend_authorization","title":"Payments - Extended Authorization","href":"/v1/payments/payments--extend-authorization"},{"openapi":"post /payments/session_tokens","title":"Payments - Session token","href":"/v1/payments/payments--session-token"},{"openapi":"get /payment_link/{payment_link_id}","title":"Payments Link - Retrieve","href":"/v1/payments/payments-link--retrieve"},{"openapi":"get /payments/list","title":"Payments - List","href":"/v1/payments/payments--list"},{"openapi":"post /payments/{payment_id}/3ds/authentication","title":"Payments - External 3DS Authentication","href":"/v1/payments/payments--external-3ds-authentication"},{"openapi":"post /{payment_id}/complete_authorize","title":null,"href":"/v1/payments/payments--complete-authorize"},{"openapi":"post /payments/{payment_id}/update_metadata","title":"Payments - Update Metadata","href":"/v1/payments/payments--update-metadata"},{"openapi":"post /payments/{payment_id}/eligibility","title":"Payments - Submit Eligibility Data","href":"/v1/payments/payments--submit-eligibility-data"}]},{"group":"Payment Methods","pages":[{"openapi":"post /payment_methods","title":"PaymentMethods - Create","href":"/v1/payment-methods/paymentmethods--create"},{"openapi":"get /payment_methods/{method_id}","title":"Payment Method - Retrieve","href":"/v1/payment-methods/payment-method--retrieve"},{"openapi":"post /payment_methods/{method_id}/update","title":"Payment Method - Update","href":"/v1/payment-methods/payment-method--update"},{"openapi":"delete /payment_methods/{method_id}","title":"Payment Method - Delete","href":"/v1/payment-methods/payment-method--delete"},{"openapi":"post /{customer_id}/payment_methods/{payment_method_id}/default","title":"Payment Method - Set Default Payment Method for Customer","href":"/v1/payment-methods/payment-method--set-default-payment-method-for-customer"},{"openapi":"get /account/payment_methods","title":"List payment methods for a Merchant","href":"/v1/payment-methods/list-payment-methods-for-a-merchant"},{"openapi":"get /customers/payment_methods","title":"List customer saved payment methods for a Payment","href":"/v1/payment-methods/list-customer-saved-payment-methods-for-a-payment"},{"openapi":"get /customers/{customer_id}/payment_methods","title":"List payment methods for a Customer","href":"/v1/payment-methods/list-payment-methods-for-a-customer"},{"openapi":"post /{customer_id}/payment_methods/{payment_method_id}/default","title":"Payment Method - Set Default Payment Method for Customer","href":"/v1/customer-set-default-payment-method/customers--set-default-payment-method"}]},{"group":"Customers","pages":[{"openapi":"post /customers","title":"Customers - Create","href":"/v1/customers/customers--create"},{"openapi":"get /customers/{customer_id}","title":"Customers - Retrieve","href":"/v1/customers/customers--retrieve"},{"openapi":"post /customers/{customer_id}","title":"Customers - Update","href":"/v1/customers/customers--update"},{"openapi":"delete /customers/{customer_id}","title":"Customers - Delete","href":"/v1/customers/customers--delete"},{"openapi":"get /customers/list","title":"Customers - List","href":"/v1/customers/customers--list"}]},{"group":"Mandates","pages":[{"openapi":"post /mandates/revoke/{mandate_id}","title":"Mandates - Revoke Mandate","href":"/v1/mandates/mandates--revoke-mandate"},{"openapi":"get /mandates/{mandate_id}","title":"Mandates - Retrieve Mandate","href":"/v1/mandates/mandates--retrieve-mandate"},{"openapi":"post /customers/{customer_id}/mandates","title":null,"href":"/v1/mandates/mandates--customer-mandates-list"}]},{"group":"Refunds","pages":[{"openapi":"post /refunds","title":"Refunds - Create","href":"/v1/refunds/refunds--create"},{"openapi":"post /refunds/{refund_id}","title":"Refunds - Update","href":"/v1/refunds/refunds--update"},{"openapi":"get /refunds/{refund_id}","title":"Refunds - Retrieve","href":"/v1/refunds/refunds--retrieve"},{"openapi":"post /refunds/list","title":"Refunds - List","href":"/v1/refunds/refunds--list"}]},{"group":"Disputes","pages":[{"openapi":"get /disputes/{dispute_id}","title":"Disputes - Retrieve Dispute","href":"/v1/disputes/disputes--retrieve"},{"openapi":"get /disputes/list","title":"Disputes - List Disputes","href":"/v1/disputes/disputes--list"}]},{"group":"Authentication","pages":[{"openapi":"post /authentication","title":"Authentication - Create","href":"/v1/authentication/authentication--create"},{"openapi":"post /authentication/{authentication_id}/eligibility-check","title":"Authentication - POST Eligibility Check","href":"/v1/authentication/authentication--post-eligibility-check"},{"openapi":"get /authentication/{authentication_id}/eligibility-check","title":"Authentication - GET Eligibility Check","href":"/v1/authentication/authentication--get-eligibility-check"}]},{"group":"Payouts","pages":[{"openapi":"post /payouts/create","title":"Payouts - Create","href":"/v1/payouts/payouts--create"},{"openapi":"post /payouts/{payout_id}","title":"Payouts - Update","description":null,"href":"/v1/payouts/payouts--update"},{"openapi":"post /payouts/{payout_id}/cancel","title":"Payouts - Cancel","href":"/v1/payouts/payouts--cancel"},{"openapi":"post /payouts/{payout_id}/fulfill","title":"Payouts - Fulfill","description":null,"href":"/v1/payouts/payouts--fulfill"},{"openapi":"post /payouts/{payout_id}/confirm","title":"Payouts - Confirm","href":"/v1/payouts/payouts--confirm"},{"openapi":"get /payouts/{payout_id}","title":"Payouts - Retrieve","href":"/v1/payouts/payouts--retrieve"},{"openapi":"get /payouts/list","title":"Payouts - List","href":"/v1/payouts/payouts--list"},{"openapi":"post /payouts/filter","title":"Payouts - List available filters","href":"/v1/payouts/payouts--list-filters"},{"openapi":"post /payouts/list","title":"Payouts - List using filters","href":"/v1/payouts/payouts--filter"}]}]},{"group":"Account management APIs","pages":[{"group":"Organization","pages":[{"openapi":"post /organization","title":"Organization - Create","href":"/v1/organization/organization--create"},{"openapi":"get /organization/{id}","title":"Organization - Retrieve","href":"/v1/organization/organization--retrieve"},{"openapi":"put /organization/{id}","title":"Organization - Update","href":"/v1/organization/organization--update"}]},{"group":"Merchant Account","pages":[{"openapi":"post /accounts","title":"Merchant Account - Create","href":"/v1/merchant-account/merchant-account--create"},{"openapi":"get /accounts/{account_id}","title":"Merchant Account - Retrieve","href":"/v1/merchant-account/merchant-account--retrieve"},{"openapi":"post /accounts/{account_id}","title":"Merchant Account - Update","href":"/v1/merchant-account/merchant-account--update"},{"openapi":"delete /accounts/{account_id}","title":"Merchant Account - Delete","href":"/v1/merchant-account/merchant-account--delete"},{"openapi":"post /accounts/{account_id}/kv","title":"Merchant Account - KV Status","href":"/v1/merchant-account/merchant-account--kv-status"}]},{"group":"Business Profile","pages":[{"openapi":"post /account/{account_id}/business_profile","title":"Profile - Create","href":"/v1/business-profile/business-profile--create"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}","title":"Profile - Update","href":"/v1/business-profile/business-profile--update"},{"openapi":"get /account/{account_id}/business_profile/{profile_id}","title":"Profile - Retrieve","href":"/v1/business-profile/business-profile--retrieve"},{"openapi":"delete /account/{account_id}/business_profile/{profile_id}","title":"Profile - Delete","href":"/v1/business-profile/business-profile--delete"},{"openapi":"get /account/{account_id}/business_profile","title":"Profile - List","href":"/v1/business-profile/business-profile--list"}]},{"group":"Platform Account","pages":[{"openapi":"post /user/create_platform","title":"Platform - Create","href":"/v1/platform/platform--create"}]},{"group":"API Key","pages":[{"openapi":"post /api_keys/{merchant_id}","title":"API Key - Create","href":"/v1/api-key/api-key--create"},{"openapi":"get /api_keys/{merchant_id}/{key_id}","title":"API Key - Retrieve","href":"/v1/api-key/api-key--retrieve"},{"openapi":"post /api_keys/{merchant_id}/{key_id}","title":"API Key - Update","href":"/v1/api-key/api-key--update"},{"openapi":"delete /api_keys/{merchant_id}/{key_id}","title":"API Key - Revoke","href":"/v1/api-key/api-key--revoke"},{"openapi":"get /api_keys/{merchant_id}/list","title":"API Key - List","href":"/v1/api-key/api-key--list"}]},{"group":"Merchant Connector Account","pages":[{"openapi":"post /account/{account_id}/connectors","title":"Merchant Connector - Create","href":"/v1/merchant-connector-account/merchant-connector--create"},{"openapi":"get /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Retrieve","href":"/v1/merchant-connector-account/merchant-connector--retrieve"},{"openapi":"post /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Update","href":"/v1/merchant-connector-account/merchant-connector--update"},{"openapi":"delete /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Delete","href":"/v1/merchant-connector-account/merchant-connector--delete"},{"openapi":"get /account/{account_id}/connectors","title":"Merchant Connector - List","href":"/v1/merchant-connector-account/merchant-connector--list"}]},{"group":"GSM (Global Status Mapping)","pages":[{"openapi":"post /gsm","title":"Gsm - Create","href":"/v1/gsm/gsm--create"},{"openapi":"post /gsm/get","title":"Gsm - Get","href":"/v1/gsm/gsm--get"},{"openapi":"post /gsm/update","title":"Gsm - Update","href":"/v1/gsm/gsm--update"},{"openapi":"post /gsm/delete","title":"Gsm - Delete","href":"/v1/gsm/gsm--delete"}]}]},{"group":"Other APIs","pages":[{"group":"Event","pages":[{"openapi":"post /events/{merchant_id}","title":"Events - List","href":"/v1/event/events--list"},{"openapi":"get /events/{merchant_id}/{event_id}/attempts","title":"Events - Delivery Attempt List","href":"/v1/event/events--delivery-attempt-list"},{"openapi":"post /events/{merchant_id}/{event_id}/retry","title":"Events - Manual Retry","href":"/v1/event/events--manual-retry"}]},{"group":"Poll","pages":[{"openapi":"get /poll/status/{poll_id}","title":"Poll - Retrieve Poll Status","href":"/v1/poll/poll--retrieve-poll-status"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklist","title":null,"href":"/v1/blocklist/get-blocklist"},{"openapi":"post /blocklist","title":null,"href":"/v1/blocklist/post-blocklist"},{"openapi":"delete /blocklist","title":null,"href":"/v1/blocklist/delete-blocklist"},{"openapi":"post /blocklist/toggle","title":null,"href":"/v1/blocklist/post-blocklisttoggle"}]},{"group":"Routing","pages":[{"openapi":"get /routing","title":"Routing - List","href":"/v1/routing/routing--list"},{"openapi":"post /routing","title":"Routing - Create","href":"/v1/routing/routing--create"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}/dynamic_routing/success_based/create","title":"Routing - Auth Rate Based","href":"/v1/routing/routing--success-based"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}/dynamic_routing/elimination/create","title":"Routing - Elimination","href":"/v1/routing/routing--elimination"},{"openapi":"get /routing/active","title":"Routing - Retrieve Config","href":"/v1/routing/routing--retrieve-config"},{"openapi":"post /routing/deactivate","title":"Routing - Deactivate","href":"/v1/routing/routing--deactivate"},{"openapi":"get /routing/default","title":"Routing - Retrieve Default Config","href":"/v1/routing/routing--retrieve-default-config"},{"openapi":"post /routing/default","title":"Routing - Update Default Config","href":"/v1/routing/routing--update-default-config"},{"openapi":"get /routing/default/profile","title":"Routing - Retrieve Default For Profile","href":"/v1/routing/routing--retrieve-default-for-profile"},{"openapi":"post /routing/default/profile/{profile_id}","title":"Routing - Update Default For Profile","href":"/v1/routing/routing--update-default-for-profile"},{"openapi":"get /routing/{routing_algorithm_id}","title":"Routing - Retrieve","href":"/v1/routing/routing--retrieve"},{"openapi":"post /routing/{routing_algorithm_id}/activate","title":"Routing - Activate config","href":"/v1/routing/routing--activate-config"},{"openapi":"post /routing/evaluate","title":"Routing - Evaluate","href":"/v1/routing/routing--evaluate"},{"openapi":"post /routing/feedback","title":"Routing - Feedback","href":"/v1/routing/routing--feedback"},{"openapi":"post /routing/rule/evaluate","title":"Routing - Rule Evaluate","href":"/v1/routing/routing--rule-evaluate"}]},{"group":"Relay","pages":[{"openapi":"post /relay","title":"Relay - Create","href":"/v1/relay/relay"},{"openapi":"get /relay/{relay_id}","title":"Relay - Retrieve","href":"/v1/relay/relay--retrieve"}]},{"group":"Schemas","pages":[{"title":null,"href":"/v1/schemas/outgoing--webhook"}]},{"group":"Subscriptions","pages":[{"openapi":"post /subscriptions/create","title":"Subscription - Create","href":"/v1/subscriptions/create"},{"openapi":"post /subscriptions/{subscription_id}/confirm","title":"Subscription - Confirm","href":"/v1/subscriptions/confirm"},{"openapi":"post /subscriptions","title":"Subscription - Create and Confirm","href":"/v1/subscriptions/create-and-confirm"},{"openapi":"put /subscriptions/{subscription_id}/update","title":"Subscription - Update","href":"/v1/subscriptions/update"},{"openapi":"get /subscriptions/{subscription_id}","title":"Subscription - Retrieve","href":"/v1/subscriptions/get"},{"title":"Get plans","href":"/v1/subscriptions/get-plans"},{"openapi":"get /subscriptions/estimate","title":"Subscription - Get Estimate","href":"/v1/subscriptions/estimate"},{"openapi":"post /subscriptions/{subscription_id}/pause","title":"Subscription - Pause Subscription","href":"/v1/subscriptions/pause"},{"openapi":"post /subscriptions/{subscription_id}/resume","title":"Subscription - Resume Subscription","href":"/v1/subscriptions/resume"},{"openapi":"post /subscriptions/{subscription_id}/cancel","title":"Subscription - Cancel Subscription","href":"/v1/subscriptions/cancel"}]}]}]},{"version":"2.0.0 [BETA]","pages":[{"title":"2.0.0 [BETA]","href":"/introduction"}]}]},{"tab":"Locker API Reference","pages":[{"title":"Locker API Reference","href":"/locker-api-reference/overview"}]},{"tab":"Intelligent Router API Reference","pages":[{"title":"Intelligent Router API Reference","href":"/intelligent-router-api-reference/overview"}]}]},"title":"Payouts - Cancel - BirrPay","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}