---
updatedAt: 2026-07-09T19:39:10.000Z
agentTools:
projectIndex: https://developer.i-payout.com/llms.txt
---
# Update sender
This API will update the sender profile information.
# 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/beneficiaries/sender/{sender-token}": {
"put": {
"tags": [
"Beneficiary"
],
"summary": "Update sender",
"description": "This API will update the sender profile information.",
"operationId": "update-sender",
"parameters": [
{
"name": "sender-token",
"in": "path",
"description": "The sender's unique i-payout identifier.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSenderViewModel"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponseUpdateCustomer"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponseUpdateCustomer"
}
}
}
},
"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."
},
"ApiResponseUpdateCustomer": {
"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/ApiResponseUpdateCustomerData"
}
},
"additionalProperties": false,
"description": "Update customer response."
},
"ApiResponseUpdateCustomerData": {
"type": "object",
"properties": {
"beneficiaryToken": {
"type": "string",
"description": "i-payout assigned user identifier for the account",
"nullable": true
}
},
"additionalProperties": false,
"description": "Update customer response data."
},
"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 ."
},
"UpdateSenderViewModel": {
"required": [
"firstName",
"lastName"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 100,
"type": "string",
"description": "The customer's updated first name."
},
"lastName": {
"maxLength": 100,
"type": "string",
"description": "The customer's updated last name."
},
"companyName": {
"maxLength": 300,
"type": "string",
"description": "The customer's updated company name.",
"nullable": true
},
"address1": {
"maxLength": 500,
"type": "string",
"description": "The customer's updated address, line 1.",
"nullable": true
},
"address2": {
"maxLength": 500,
"type": "string",
"description": "The customer's updated address, line 2.",
"nullable": true
},
"city": {
"maxLength": 300,
"type": "string",
"description": "The customer's updated city.",
"nullable": true
},
"state": {
"maxLength": 500,
"type": "string",
"description": "The customer's updated state.",
"nullable": true
},
"zipCode": {
"maxLength": 25,
"type": "string",
"description": "The customer's updated ZIP or postal code.",
"nullable": true
},
"country": {
"minLength": 2,
"type": "string",
"description": "The customer's two-letter country code (ISO 3166-1 alpha-2). See Country / Currency Support ",
"nullable": true
},
"phoneNumber": {
"maxLength": 50,
"type": "string",
"description": "The customer's updated phone number.",
"nullable": true
},
"dateOfBirth": {
"type": "string",
"description": "The customer's updated date of birth. Format: \"yyyy-mm-dd\"",
"nullable": true
},
"companyIncorporatedDate": {
"type": "string",
"description": "The company's updated incorporation date. Format: \"yyyy-mm-dd\"",
"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": []
}
]
}
```