# Payer Edit

> Update an existing payer profile.

```yaml
openapi: 3.1.0
info:
  title: Payer Edit
  version: 1.0.0
  description: Update an existing payer profile.
paths:
  /api/v1/acct/editPayer:
    post:
      summary: Payer Edit
      description: Update an existing payer profile.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Payer ID to update.
                merchantNo:
                  type: string
                  description: Merchant number assigned by Onerway. Retrieve it from the merchant
                    portal or onboarding material after your sandbox or
                    production account is created.
                companyNameEn:
                  type: string
                  description: English company name for business payers.
                companyName:
                  type: string
                  description: Local company name for business payers.
                country:
                  type: string
                  description: Payer country.
                addressEn1:
                  type: string
                  description: Primary address line of the payer.
                addressEn2:
                  type: string
                  description: Secondary address line.
                addressEn3:
                  type: string
                  description: Tertiary address line.
                registerNo:
                  type: string
                  description: Registration number.
                registerDate:
                  type: string
                  description: Registration date.
                postcode:
                  type: string
                  description: Postal code.
                email:
                  type: string
                  description: Email address.
                areaCode:
                  type: string
                  description: Phone area code.
                phoneNumber:
                  type: string
                  description: Phone number.
                state:
                  type: string
                  description: State or province.
                city:
                  type: string
                  description: City.
                subEntityType:
                  type: string
                  description: Payer entity type.
                firstName:
                  type: string
                  description: First name for individual payers.
                lastName:
                  type: string
                  description: Last name for individual payers.
                idType:
                  type: string
                  description: Identity-document type.
                idNumber:
                  type: string
                  description: Identity-document number.
                birthDate:
                  type: string
                  description: Birth date for individual payers.
                idValidDateFrom:
                  type: string
                  description: Identity-document valid-from date.
                idValidDateTo:
                  type: string
                  description: Identity-document expiry date.
                sign:
                  type: string
                  description: Request signature string. Generate it according to the Transfer
                    request-signing rules with your merchant private key.
              required:
                - id
                - merchantNo
                - country
                - addressEn1
                - postcode
                - email
                - areaCode
                - phoneNumber
                - state
                - city
                - idType
                - idNumber
                - idValidDateTo
                - sign
            examples:
              update-payer:
                summary: Update payer request
                value:
                  addressEn1: Nanshan Science & Technology Park, Shenzhen
                  addressEn2: 2all
                  addressEn3: "3"
                  areaCode: "+86"
                  city: London
                  companyName: 卡玛有限公司 &sunshine
                  companyNameEn: keyma LTD.
                  country: GB
                  email: 324321@qq.com
                  id: 1984096429476806700
                  idType: "2"
                  idValidDateFrom: 2006-08-04
                  idValidDateTo: 2046-08-04
                  merchantNo: 801129
                  phoneNumber: "15072871023"
                  postcode: "518057"
                  registerDate: 2005-08-04
                  registerNo: "4563456546"
                  sign: d2ea92efff636320122021f65b613201403f6d34334cfbc7e589ce9f842282q4
                  state: London
                  subEntityType: "0"
      responses:
        "200":
          description: Update payer response
          content:
            application/json:
              schema:
                type: object
                properties:
                  respCode:
                    type: string
                    description: Response code returned by Onerway.
                  respMsg:
                    type:
                      - string
                      - "null"
                    description: Response message returned by Onerway.
                    x-onerway-value:
                      nullable: true
                      when:
                        en: No response message is returned.
                        zh: 未返回响应信息时为 `null`。
                  data:
                    type:
                      - object
                      - "null"
                    properties:
                      {}
                    description: Update result placeholder.
                    x-onerway-value:
                      nullable: true
                      when:
                        en: The API may return `null` for a successful update result.
                        zh: 接口在更新成功时可能返回 `null`。
              examples:
                payer-updated:
                  summary: Update payer response
                  value:
                    respCode: "20000"
                    respMsg: Success
                    data: null
```