--- updatedAt: 2026-07-09T19:39:10.000Z agentTools: projectIndex: https://developer.i-payout.com/llms.txt --- # Get beneficiary transfers method This API returns matching transfers methods based on the filters applied # 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/reports/transfer-methods": { "get": { "tags": [ "Report" ], "summary": "Get beneficiary transfers method", "description": "This API returns matching transfers methods based on the filters applied", "operationId": "get-beneficiary-transfer-method", "parameters": [ { "name": "beneficiaryToken", "in": "query", "description": "Beneficiary Token", "schema": { "type": "string" } }, { "name": "destinationToken", "in": "query", "description": "Destination Token", "schema": { "type": "string" } }, { "name": "transferType", "in": "query", "description": "Transfer Type. Available values Bank = 1,Wire = 2 and CreditCard = 3", "schema": { "$ref": "#/components/schemas/TransferType" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseTransferMethod" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseTransferMethod" } } } }, "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." }, "ApiResponseTransferMethod": { "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/TransferMethodDto" } }, "additionalProperties": false }, "BankAccountDetailsDto": { "type": "object", "properties": { "token": { "type": "string", "description": "Token", "nullable": true }, "accountNickName": { "type": "string", "description": "Account Nick Name", "nullable": true }, "bankCountry": { "type": "string", "description": "Bank Country", "nullable": true }, "accountCurrency": { "type": "string", "description": "Bank account currency code", "nullable": true }, "swiftCode": { "type": "string", "description": "Bank swift code", "nullable": true }, "bankCode": { "type": "string", "description": "Bank code", "nullable": true }, "routingNumber": { "type": "string", "description": "Routing Number", "nullable": true }, "accountNumber": { "type": "string", "description": "Account Number", "nullable": true }, "accountType1": { "type": "string", "description": "Account Type 2 (Available options are: Personal/Business)", "nullable": true }, "accountType2": { "type": "string", "description": "Account Type 2 (Available options are: Checking/Savings)", "nullable": true }, "bankName": { "type": "string", "description": "Bank Name", "nullable": true }, "branchName": { "type": "string", "description": "Name of the branch", "nullable": true }, "branchAddress": { "type": "string", "description": "Branch Address", "nullable": true }, "beneficiaryFirstName": { "type": "string", "description": "Beneficiary First Name", "nullable": true }, "beneficiaryLastName": { "type": "string", "description": "Beneficiary Last Name", "nullable": true }, "beneficiaryDateOfBirth": { "type": "string", "description": "Date of birth of beneficiary", "nullable": true }, "beneficiaryGovernmentID": { "type": "string", "description": "Government Id of the beneficiary", "nullable": true }, "accountHolderTaxID": { "type": "string", "description": "Tax payer identification number", "nullable": true }, "beneficiaryCompanyName": { "type": "string", "description": "Beneficiary Company Name", "nullable": true }, "beneficiaryCountry": { "type": "string", "description": "Beneficiary Country", "nullable": true }, "beneficiaryAddress1": { "type": "string", "description": "Beneficiary Address 1", "nullable": true }, "beneficiaryAddress2": { "type": "string", "description": "Beneficiary Address 2", "nullable": true }, "beneficiaryCity": { "type": "string", "description": "Beneficiar yCity", "nullable": true }, "beneficiaryState": { "type": "string", "description": "Beneficiary State", "nullable": true }, "beneficiaryZipCode": { "type": "string", "description": "Beneficiary ZipCode", "nullable": true }, "beneficiaryPhoneNumber": { "type": "string", "description": "Beneficiary phone number", "nullable": true }, "localLanguage": { "$ref": "#/components/schemas/LocalLanguage" } }, "additionalProperties": false, "description": "Bank account details model" }, "CreditCardAccountDetailsDto": { "type": "object", "properties": { "token": { "type": "string", "description": "Token", "format": "uuid" }, "creditCardNumber": { "type": "string", "description": "Credit Card Number", "nullable": true }, "expiryMonth": { "type": "string", "description": "Credit Card Expiration Date Month", "nullable": true }, "expiryYear": { "type": "string", "description": "Credit Card Expiration Date Year", "nullable": true }, "cardType": { "type": "string", "description": "Cared type", "nullable": true }, "beneficiaryAddress1": { "type": "string", "description": "Beneficiary Address 1", "nullable": true }, "beneficiaryAddress2": { "type": "string", "description": "Beneficiary Address 2", "nullable": true }, "beneficiaryCity": { "type": "string", "description": "Beneficiary City", "nullable": true }, "beneficiaryCountry": { "type": "string", "description": "Beneficiary country", "nullable": true }, "beneficiaryState": { "type": "string", "description": "Beneficiary State", "nullable": true }, "beneficiaryZipCode": { "type": "string", "description": "Beneficiary ZipCode", "nullable": true }, "beneficiaryPhoneNumber": { "type": "string", "description": "Beneficiary phone number", "nullable": true } }, "additionalProperties": false }, "LocalLanguage": { "type": "object", "properties": { "bankName": { "type": "string", "description": "Local bank name", "nullable": true }, "branchName": { "type": "string", "description": "Local branch name", "nullable": true }, "branchState": { "type": "string", "description": "Local branch state", "nullable": true }, "branchCity": { "type": "string", "description": "Local branch city", "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 }, "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 Status Code Values ." }, "TransferMethodDto": { "type": "object", "properties": { "wireProfile": { "type": "array", "items": { "$ref": "#/components/schemas/WireProfileDetailsDto" }, "description": "Wire profile details", "nullable": true }, "bankAccount": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccountDetailsDto" }, "description": "Bank account details", "nullable": true }, "creditCardAccount": { "type": "array", "items": { "$ref": "#/components/schemas/CreditCardAccountDetailsDto" }, "description": "Creditcard account details", "nullable": true } }, "additionalProperties": false }, "TransferType": { "enum": [ "Unknown", "Bank", "Wire", "CreditCard", "Check", "Crypto", "Interac", "RegularACH", "SameDayACH", "RealtimeACH", "DebitCard", "Paypal" ], "type": "string" }, "WireProfileDetailsDto": { "type": "object", "properties": { "token": { "type": "string", "description": "A unique token for wire account", "format": "uuid" }, "accountNickName": { "type": "string", "description": "Account Nick Name", "nullable": true }, "beneficiaryCountry": { "type": "string", "description": "Beneficiary Country", "nullable": true }, "beneficiaryFirstName": { "type": "string", "description": "Beneficiary First Name", "nullable": true }, "beneficiaryLastName": { "type": "string", "description": "Beneficiary Last Name", "nullable": true }, "beneficiaryCompanyName": { "type": "string", "description": "Beneficiary Company Name", "nullable": true }, "beneficiaryAddress1": { "type": "string", "description": "Beneficiary Address 1", "nullable": true }, "beneficiaryAddress2": { "type": "string", "description": "Beneficiary Address 2", "nullable": true }, "beneficiaryCity": { "type": "string", "description": "Beneficiary City", "nullable": true }, "beneficiaryState": { "type": "string", "description": "Beneficiary State", "nullable": true }, "beneficiaryZipCode": { "type": "string", "description": "Beneficiary Zip Code", "nullable": true }, "accountType1": { "type": "string", "description": "Beneficiary account type (Available options are - personal and business)", "nullable": true }, "bankCountry": { "type": "string", "description": "Bank Country", "nullable": true }, "swiftCode": { "type": "string", "description": "Swift Code", "nullable": true }, "routingNumber": { "type": "string", "description": "Routing Number", "nullable": true }, "accountNumber": { "type": "string", "description": "Account Number", "nullable": true }, "bankName": { "type": "string", "description": "Bank Name", "nullable": true }, "bankCode": { "type": "string", "description": "Bank Code", "nullable": true }, "branchCode": { "type": "string", "description": "Branch Code", "nullable": true }, "bankAddress1": { "type": "string", "description": "Bank Address 1", "nullable": true }, "bankAddress2": { "type": "string", "description": "Bank Address 2", "nullable": true }, "bankCity": { "type": "string", "description": "Bank City", "nullable": true }, "bankState": { "type": "string", "description": "Bank State", "nullable": true }, "bankZipCode": { "type": "string", "description": "Bank Zip Code", "nullable": true } }, "additionalProperties": false } }, "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": [] } ] } ```