openapi: 3.2.0 info: title: Open Financial Pg Settlements API version: '1' description: 'Operations tagged Pg Settlements across 2 of this provider''s published API definitions: open-financial-1-openapi.yml, open-financial-5-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.zwitch.io security: - sec0: [] tags: - name: Pg Settlements paths: /pg_settlements/sub_accounts: put: summary: Update Sub Account description: Use this API to update the sub account details. operationId: update-sub-account requestBody: content: application/json: schema: type: object required: - sub_accounts_id properties: sub_accounts_id: type: string description: The sub accounts id created during the sub_account onboarding recepient_name: type: string description: recepient_name email_id: type: string description: Email address of the sub-account mobile_number: type: string description: Mobile number of the sub-account bene_account_number: type: string description: Account Number of the sub-account ifsc_code: type: string description: IFSC of the account branch_name: type: string description: Branch name corresponding to the IFSC provided bank_name: type: string description: Bank name of the sub-account's account number examples: Update Sub_account: value: - recepient_name: John Doe email_id: john.doe@gmail.co mobile_number: 7558042380 bene_account_number: 9990009991 branch_name: HSR bank_name: KOTAK MAHINDRA BANK ifsc_code: KKBK0008072 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"data\": [\n {\n \"sub_accounts_id\": \"sa_c7b14dc8cf5c\",\n \"recepient_name\": \"Test\",\n \"email_id\": \"test@bankopen.co\",\n \"mobile_number\": \"1766666889\",\n \"status\":\"pending\" , once changed to active or disabled , update won't work\n \"bene_account_number\": \"0416201006112\",\n \"ifsc_code\": \"KKBK0008072\",\n \"bank_name\": \"KOTAK MAHINDRA BANK\",\n \"branch_name\": \"KOTAK MAHINDRA BANK\"\n }\n ],\n \"meta\": {\n \"pagination\": {\n \"total\": 1,\n \"count\": 1,\n \"per_page\": 15,\n \"current_page\": 1,\n \"total_pages\": 1,\n \"links\": {}\n }\n },\n \"status\": 200\n}" '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Pg Settlements get: summary: Get All Sub-Accounts description: '' operationId: get-all-sub-accounts responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"data\": [\n {\n \"sub_accounts_id\": \"sa_c7b14dc8cf5c\",\n \"recepient_name\": \"Test\",\n \"status\" : \"pending\",\n \"email_id\": \"test@bankopen.co\",\n \"mobile_number\": \"1766666889\",\n \"bene_account_number\": \"0416201006112\",\n \"ifsc_code\": \"KKBK0008072\",\n \"bank_name\": \"KOTAK MAHINDRA BANK\",\n \"branch_name\": \"KOTAK MAHINDRA BANK\"\n },\n {\n \"sub_accounts_id\": \"sa_c0175790d4e8\",\n \"recepient_name\": \"Asif\",\n \"status\" : \"pending\",\n \"email_id\": \"asif11@bankopen.co\",\n \"mobile_number\": \"8301834098\",\n \"bene_account_number\": \"188301834097\",\n \"ifsc_code\": \"INDB0000010\",\n \"bank_name\": \"INDUSIND BANK\",\n \"branch_name\": \"INDUSIND BANK\"\n }\n \"meta\": {\n \"pagination\": {\n \"total\": 3,\n \"count\": 3,\n \"per_page\": 15,\n \"current_page\": 1,\n \"total_pages\": 1,\n \"links\": {}\n }\n },\n \"status\": 200\n}" '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Pg Settlements post: summary: Sub Account Onboarding API description: Use this API to create the subaccount operationId: sub-account-onboarding-api requestBody: content: application/json: schema: type: object required: - recepient_name - email_id - mobile_number - bene_account_number - ifsc_code - branch_name - bank_name properties: recepient_name: type: string description: Name of the sub-account email_id: type: string description: Email address of the sub-account mobile_number: type: string description: Mobile number of the sub-account bene_account_number: type: string description: Account Number of the sub-account ifsc_code: type: string description: IFSC code for the account branch_name: type: string description: Branch name corresponding to the IFSC provided bank_name: type: string description: Bank name of the sub-account's account number examples: Request Example: value: - recepient_name: John Doe email_id: john.doe@gmail.co mobile_number: '7558042380' bene_account_number: '9990009991' branch_name: HSR bank_name: KOTAK MAHINDRA BANK ifsc_code: KKBK0008072 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"data\": [\n {\n \"sub_accounts_id\": \"sa_da4f9f84ac6d\",\n \"recepient_name\": \"John Doe\",\n \"email_id\": \"john.doe@gmail.co\",\n \"mobile_number\": \"7558042380\",\n \"bene_account_number\": \"8912067067\",\n \"ifsc_code\": \"KKBK0008072\",\n \"bank_name\": \"KOTAK MAHINDRA BANK\",\n \"branch_name\": \"KOTAK MAHINDRA BANK\",\n \"status\": \"pending\"\n }\n ],\n \"meta\": {\n \"pagination\": {\n \"total\": 1,\n \"count\": 1,\n \"per_page\": 15,\n \"current_page\": 1,\n \"total_pages\": 1,\n \"links\": {}\n }\n },\n \"status\": 200\n}" schema: type: object properties: data: type: array items: type: object properties: sub_accounts_id: type: string example: sa_da4f9f84ac6d recepient_name: type: string example: John Doe email_id: type: string example: john.doe@gmail.co mobile_number: type: string example: '7558042380' bene_account_number: type: string example: '8912067067' ifsc_code: type: string example: KKBK0008072 bank_name: type: string example: KOTAK MAHINDRA BANK branch_name: type: string example: KOTAK MAHINDRA BANK status: type: string example: pending meta: type: object properties: pagination: type: object properties: total: type: integer example: 1 default: 0 count: type: integer example: 1 default: 0 per_page: type: integer example: 15 default: 0 current_page: type: integer example: 1 default: 0 total_pages: type: integer example: 1 default: 0 links: type: object properties: {} status: type: integer example: 200 default: 0 '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Pg Settlements servers: - url: https://api.zwitch.io /pg_settlements/sub_accounts/{{sub_account_ref_id}}: get: summary: Get Sub Account By ID description: '' operationId: get-sub-account-by-id parameters: - name: sub_account_ref_id in: path description: Sub account reference id schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"data\": [\n {\n \"sub_accounts_id\": \"sa_c7b14dc8cf5c\",\n \"recepient_name\": \"Test\",\n \"email_id\": \"test@bankopen.co\",\n \"mobile_number\": \"1766666889\",\n \"bene_account_number\": \"0416201006112\",\n \"ifsc_code\": \"KKBK0008072\",\n \"status\":\"pending\",\n \"bank_name\": \"KOTAK MAHINDRA BANK\",\n \"branch_name\": \"KOTAK MAHINDRA BANK\"\n }\n ],\n \"meta\": {\n \"pagination\": {\n \"total\": 1,\n \"count\": 1,\n \"per_page\": 15,\n \"current_page\": 1,\n \"total_pages\": 1,\n \"links\": {}\n }\n },\n \"status\": 200\n}" schema: type: object properties: data: type: array items: type: object properties: sub_accounts_id: type: string example: sa_c7b14dc8cf5c recepient_name: type: string example: Test email_id: type: string example: test@bankopen.co mobile_number: type: string example: '1766666889' bene_account_number: type: string example: '0416201006112' ifsc_code: type: string example: KKBK0008072 status: type: string example: pending bank_name: type: string example: KOTAK MAHINDRA BANK branch_name: type: string example: KOTAK MAHINDRA BANK meta: type: object properties: pagination: type: object properties: total: type: integer example: 1 default: 0 count: type: integer example: 1 default: 0 per_page: type: integer example: 15 default: 0 current_page: type: integer example: 1 default: 0 total_pages: type: integer example: 1 default: 0 links: type: object properties: {} status: type: integer example: 200 default: 0 '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Pg Settlements servers: - url: https://api.zwitch.io components: securitySchemes: sec0: type: apiKey name: Authorization in: header x-bearer-format: bearer x-default: '' x-refined-from: - open-financial-1-openapi.yml - open-financial-5-openapi.yml x-readme-fauxas: true x-provenance: method: searched source: https://developers.zwitch.io/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://developers.zwitch.io/reference/accounts-get-all.md - https://developers.zwitch.io/reference/accounts-get-balance.md - https://developers.zwitch.io/reference/accounts-get-by-id.md - https://developers.zwitch.io/reference/accounts-get-statement.md - https://developers.zwitch.io/reference/accounts-virtual-deactivate.md - https://developers.zwitch.io/reference/accounts-virtual-test-balance.md - https://developers.zwitch.io/reference/bank-account-verification-copy-1.md - https://developers.zwitch.io/reference/batch-refund-api.md - https://developers.zwitch.io/reference/beneficiaries-bank-account-create.md - https://developers.zwitch.io/reference/beneficiaries-delete.md - https://developers.zwitch.io/reference/beneficiaries-get-all.md - https://developers.zwitch.io/reference/beneficiaries-get-by-id.md - https://developers.zwitch.io/reference/beneficiaries-update.md - https://developers.zwitch.io/reference/constants-business-categories.md - https://developers.zwitch.io/reference/constants-business-types.md - https://developers.zwitch.io/reference/constants-ifsc.md - https://developers.zwitch.io/reference/constants-state-codes.md - https://developers.zwitch.io/reference/create-payment-token.md - https://developers.zwitch.io/reference/get-all-sub-accounts.md - https://developers.zwitch.io/reference/get-sub-account-by-id.md - https://developers.zwitch.io/reference/requery-batch-refund.md - https://developers.zwitch.io/reference/status-check-api-with-payment_token.md - https://developers.zwitch.io/reference/transfers-bulk-by-id.md - https://developers.zwitch.io/reference/transfers-bulk-create.md - https://developers.zwitch.io/reference/transfers-bulk-get-all.md - https://developers.zwitch.io/reference/transfers-get-all.md - https://developers.zwitch.io/reference/transfers-get-by-id.md - https://developers.zwitch.io/reference/transfers-virtual-accounts-create-to-account-beneficiary.md - https://developers.zwitch.io/reference/update-sub-account.md - https://developers.zwitch.io/reference/upi-qr-intent-string.md - https://developers.zwitch.io/reference/verifications-bank-account-create.md - https://developers.zwitch.io/reference/verifications-name-create.md - https://developers.zwitch.io/reference/verifications-pan-create.md - https://developers.zwitch.io/reference/verifications-vpa-create.md - https://developers.zwitch.io/reference/webhooks-get-all-events.md merge: pages: 35 deduped: 34 conflicts_kept_first: 1