---
updatedAt: 2026-07-09T19:39:10.000Z
agentTools:
  projectIndex: https://developer.i-payout.com/llms.txt
---

# Edit bank account

This api will update bank account details

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "IPS Portal Rest API - V1",
    "description": "i-payout API",
    "contact": {
      "name": "i-payout tech support",
      "email": "techsupport@i-payout.com"
    },
    "license": {
      "name": "i-payout API",
      "url": "http://www.i-payout.com"
    },
    "version": "v1"
  },
  "paths": {
    "/api/v1/transfer-methods/beneficiaries/{beneficiary-token}/bank-accounts/{bank-account-token}": {
      "put": {
        "tags": [
          "TransferMethod"
        ],
        "summary": "Edit bank account",
        "description": "This api will update bank account details",
        "operationId": "update-bank-account",
        "parameters": [
          {
            "name": "beneficiary-token",
            "in": "path",
            "description": "The beneficiary's unique i-payout identifier.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "bank-account-token",
            "in": "path",
            "description": "Unique token for the bank account.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BankAccountViewModel"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponseUpdateBankAccount"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponseUpdateBankAccount"
                }
              }
            }
          },
          "500": {
            "description": "Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "Bearer": [],
            "X-MerchantId": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ApiResponse": {
        "type": "object",
        "properties": {
          "isSuccess": {
            "type": "boolean",
            "description": "Indicates if the API call was successful or not."
          },
          "message": {
            "type": "string",
            "description": "A human readable status message that may be used for debugging.",
            "nullable": true
          },
          "statusCode": {
            "$ref": "#/components/schemas/StatusConstants"
          },
          "logIdentifier": {
            "type": "string",
            "description": "Utilized for support, a log identifier to provide to i-payout when requesting technical support.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Standard API Response object."
      },
      "ApiResponseUpdateBankAccount": {
        "type": "object",
        "properties": {
          "isSuccess": {
            "type": "boolean",
            "description": "Indicates if the API call was successful or not."
          },
          "message": {
            "type": "string",
            "description": "A human readable status message that may be used for debugging.",
            "nullable": true
          },
          "statusCode": {
            "$ref": "#/components/schemas/StatusConstants"
          },
          "logIdentifier": {
            "type": "string",
            "description": "Utilized for support, a log identifier to provide to i-payout when requesting technical support.",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/MessageAddEditAcctDto"
          }
        },
        "additionalProperties": false,
        "description": "Update bank account response data"
      },
      "BankAccountViewModel": {
        "required": [
          "accountCurrency",
          "accountNumber",
          "accountType1",
          "bankCountry",
          "bankName",
          "beneficiaryAddress1",
          "beneficiaryCity",
          "beneficiaryCountry",
          "beneficiaryState",
          "beneficiaryZipCode"
        ],
        "type": "object",
        "properties": {
          "accountNickName": {
            "maxLength": 100,
            "type": "string",
            "description": "Nickname or identifier for the bank account.",
            "nullable": true
          },
          "accountCurrency": {
            "maxLength": 3,
            "type": "string",
            "description": "Beneficiary bank account currency"
          },
          "accountNumber": {
            "maxLength": 100,
            "type": "string",
            "description": "Account number"
          },
          "accountType1": {
            "maxLength": 10,
            "type": "string",
            "description": "Primary account type. (Available options are : personal and business only)"
          },
          "accountType2": {
            "maxLength": 10,
            "type": "string",
            "description": "Secondary account type. (Available options are : checking and savings only)",
            "nullable": true
          },
          "bankName": {
            "maxLength": 100,
            "type": "string",
            "description": "Name of the bank."
          },
          "bankCode": {
            "maxLength": 100,
            "type": "string",
            "description": "Local bank clearing code",
            "nullable": true
          },
          "bankCountry": {
            "maxLength": 2,
            "type": "string",
            "description": "Beneficiary bank country. 2 character country code (ISO 3166-1 alpha-2)."
          },
          "swiftCode": {
            "type": "string",
            "description": "Bank swift code",
            "nullable": true
          },
          "routingNumber": {
            "maxLength": 9,
            "type": "string",
            "description": "Routing number of the bank (Only for USA bank accounts).",
            "nullable": true
          },
          "branchAddress": {
            "maxLength": 100,
            "type": "string",
            "description": "Address of the bank branch.",
            "nullable": true
          },
          "beneficiaryCompanyName": {
            "maxLength": 150,
            "type": "string",
            "description": "Beneficiary company name",
            "nullable": true
          },
          "beneficiaryFirstName": {
            "maxLength": 50,
            "type": "string",
            "description": "Beneficiary's first name.",
            "nullable": true
          },
          "beneficiaryLastName": {
            "maxLength": 50,
            "type": "string",
            "description": "Beneficiary's last name",
            "nullable": true
          },
          "beneficiaryDateOfBirth": {
            "maxLength": 10,
            "type": "string",
            "description": "Beneficiary date of birth",
            "nullable": true
          },
          "beneficiaryGovernmentID": {
            "maxLength": 50,
            "type": "string",
            "description": "Beneficiary government ID",
            "nullable": true
          },
          "beneficiaryCountry": {
            "maxLength": 2,
            "type": "string",
            "description": "Beneficiary country. 2 character country code (ISO 3166-1 alpha-2)."
          },
          "beneficiaryAddress1": {
            "maxLength": 100,
            "type": "string",
            "description": "Beneficiary's primary address"
          },
          "beneficiaryAddress2": {
            "maxLength": 100,
            "type": "string",
            "description": "Beneficiary's secondary address.'",
            "nullable": true
          },
          "beneficiaryState": {
            "maxLength": 100,
            "type": "string",
            "description": "State of the beneficiary's address."
          },
          "beneficiaryCity": {
            "maxLength": 50,
            "type": "string",
            "description": "City of the beneficiary's address."
          },
          "beneficiaryZipCode": {
            "maxLength": 20,
            "type": "string",
            "description": "ZIP code of the beneficiary's address."
          },
          "beneficiaryPhoneNumber": {
            "maxLength": 20,
            "type": "string",
            "description": "Beneficiary phone number",
            "nullable": true
          },
          "financialInstitutionNumber": {
            "maxLength": 10,
            "type": "string",
            "description": "Financial instituttion number. Required for Canada bank accounts only.",
            "nullable": true
          },
          "branchCode": {
            "maxLength": 20,
            "type": "string",
            "description": "Branch code",
            "nullable": true
          },
          "accountHolderTaxID": {
            "maxLength": 20,
            "type": "string",
            "description": "Tax Id",
            "nullable": true
          },
          "branchName": {
            "maxLength": 100,
            "type": "string",
            "description": "Name of the Branch",
            "nullable": true
          },
          "localLanguage": {
            "$ref": "#/components/schemas/LocalLanguageViewModel"
          }
        },
        "additionalProperties": false,
        "description": "Bank Account View model for Add/Edit bank account"
      },
      "LocalLanguageViewModel": {
        "type": "object",
        "properties": {
          "bankName": {
            "type": "string",
            "description": "Bank name in local language characters",
            "nullable": true
          },
          "branchName": {
            "type": "string",
            "description": "Branch name in local language characters",
            "nullable": true
          },
          "branchState": {
            "type": "string",
            "description": "Branch state in local language characters",
            "nullable": true
          },
          "branchCity": {
            "type": "string",
            "description": "Branch city in local language characters",
            "nullable": true
          },
          "firstName": {
            "type": "string",
            "description": "First name in local language",
            "nullable": true
          },
          "lastName": {
            "type": "string",
            "description": "Last name in local language",
            "nullable": true
          },
          "companyName": {
            "type": "string",
            "description": "Company name in local language",
            "nullable": true
          },
          "beneficiaryAddress1": {
            "type": "string",
            "description": "Beneficiary primary address in local language",
            "nullable": true
          },
          "beneficiaryAddress2": {
            "type": "string",
            "description": "Beneficiary secondary address in local language",
            "nullable": true
          },
          "beneficiaryState": {
            "type": "string",
            "description": "Beneficiary state in local language",
            "nullable": true
          },
          "beneficiaryCity": {
            "type": "string",
            "description": "Beneficiary city in local language",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "MessageAddEditAcctDto": {
        "type": "object",
        "properties": {
          "token": {
            "type": "string",
            "format": "uuid"
          },
          "isDocumentVerificationRequired": {
            "type": "boolean"
          },
          "lstErrMessagesReqFields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RequiredFieldValidationErrorDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "RequiredFieldValidationErrorDto": {
        "type": "object",
        "properties": {
          "accountSectionType": {
            "type": "string",
            "nullable": true
          },
          "accountFieldType": {
            "type": "string",
            "nullable": true
          },
          "validationFailedMessage": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "StatusConstants": {
        "enum": [
          "NO_ERROR",
          "EMAIL_ADDRESS_EXISTS",
          "CAPTCHA_FAILED",
          "INVALID_REFERENCEID",
          "INVALID_OPERATION",
          "INVALID_TIN_VALIDATION_STATUS",
          "RECORD_NOT_FOUND",
          "Already_Exist",
          "Batch_Closed",
          "IP_BLACKLISTED",
          "CREDIT_CARD_PROCESSOR_ISSUE",
          "FEES_NOT_ACCEPTED",
          "PAYOUT_CAPABILITIES_DISABLED",
          "INVALID_RECURRING_PAYMENT_STATUS",
          "INVOICE_CAPABILITIES_DISABLED",
          "INVALID_EWALLET_REGISTRATION",
          "PRIVATE_KEY_ISSUE",
          "FILE_NOT_EXISTS",
          "OLDUSER_NEWUSER_MISMATCH",
          "USER_CANNOT_CREATED",
          "CANNOT_CREATE_NEW_BATCH",
          "REFERENCEID_ALREADY_EXISTS",
          "DELETE_RECORD_ERROR",
          "FX_ConversionRate_Issue",
          "RATE_LIMIT_EXCEEDED",
          "IP_NOT_ALLOWED",
          "COUNTRY_NOT_ALLOWED",
          "INVALID_FIELD_VALUE_LENGTH",
          "UNAUTHORIZED_API_CALL",
          "FEE_VALUE_NOT_FOUND_FOR_CUSTOMER",
          "IPADDRESS_GENERATION_ISSUE",
          "MERCHANT_NOT_FOUND",
          "INVALID_PARAMS",
          "Missing_HEADER_PARAMS",
          "INVALID_URL",
          "INVALID_AMOUNT",
          "INVALID_CURRENCY",
          "REQUIRED_PARAMETER",
          "INVALID_REQUEST_PARAM",
          "INVALID_REQUEST_RESPONSE_PARAM",
          "INVALID_SERVER_CONFIG",
          "ACCESS_DENIED",
          "INVALID_COUNTRY_CODE",
          "PROCESSING",
          "PENDING",
          "NO_RECORDS_FOUND",
          "INVALID_MERCHANT",
          "PAL_INVALID_EMAIL",
          "INVALID_CARD_NUMBER",
          "INSUFFICIENT_FUNDS",
          "USERNAME_EXISTS",
          "USER_NOT_LOGGED_IN",
          "INVALID_CLIENT_CREDENTIALS",
          "ACCOUNT_NOT_FOUND",
          "GENERAL_ERROR",
          "CUSTOMER_NOT_FOUND",
          "INTERNAL_ERROR"
        ],
        "type": "string",
        "description": "Api response status code. For possible values, see <a target='_blank' href='https://i-payout.readme.io/reference/status-code-values' />Status Code Values </a>."
      }
    },
    "securitySchemes": {
      "basic": {
        "type": "http",
        "description": "Use API username and password to get the dynamic bearer token which can be used to access all other API, Example: 'Basic 12345adfad'",
        "scheme": "basic"
      },
      "Bearer": {
        "type": "apiKey",
        "description": "JWT Authorization header using the Bearer scheme.Enter 'Bearer' [space] and then your token in the text input below. Example: 'Bearer 12345abcdef'",
        "name": "Authorization",
        "in": "header"
      },
      "X-MerchantId": {
        "type": "apiKey",
        "description": "Merchant Identifier (GUID)",
        "name": "X-MerchantId",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "Bearer": [],
      "basic": [],
      "X-MerchantId": []
    }
  ]
}
```