# Payer Add

> Create a payer that can be reused in later Transfer payouts.

```yaml
openapi: 3.1.0
info:
  title: Payer Add
  version: 1.0.0
  description: Create a payer that can be reused in later Transfer payouts.
paths:
  /api/v1/acct/addPayer:
    post:
      summary: Payer Add
      description: Create a payer that can be reused in later Transfer payouts.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                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.
                subEntityType:
                  type: string
                  description: Payer entity type. `0` for business and `1` for individual. This
                    choice determines which business or personal identity fields
                    must be supplied.
                country:
                  type: string
                  description: Country of the payer.
                companyNameEn:
                  type: string
                  description: English company name for business payers.
                companyName:
                  type: string
                  description: Local company name for business payers.
                addressEn1:
                  type: string
                  description: Primary address line of the payer.
                postcode:
                  type: string
                  description: Postal code of the payer.
                email:
                  type: string
                  description: Payer email address.
                areaCode:
                  type: string
                  description: Phone area code.
                phoneNumber:
                  type: string
                  description: Phone number of the payer.
                state:
                  type: string
                  description: State or province of the payer.
                city:
                  type: string
                  description: City of the payer.
                idType:
                  type: string
                  description: Payer identity-document type. The required value depends on whether
                    the payer is a business or an individual.
                idNumber:
                  type: string
                  description: Payer identity-document number.
                idValidDateTo:
                  type: string
                  description: Payer 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:
                - merchantNo
                - subEntityType
                - country
                - addressEn1
                - postcode
                - email
                - areaCode
                - phoneNumber
                - state
                - city
                - idType
                - idNumber
                - idValidDateTo
                - sign
            examples:
              create-business-payer:
                summary: Create a business payer
                value:
                  addressEn1: Nanshan Science & Technology Park, Shenzhen
                  areaCode: "+86"
                  city: London
                  companyName: Demo Company Ltd
                  companyNameEn: Demo Company Ltd
                  country: GB
                  email: payer@example.com
                  idNumber: "4563456546"
                  idType: "2"
                  idValidDateTo: 2046-08-04
                  merchantNo: "801129"
                  phoneNumber: "15072871023"
                  postcode: "518057"
                  sign: "{{SIGN}}"
                  state: London
                  subEntityType: "0"
      responses:
        "200":
          description: Payer created
          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: string
                    description: Created payer ID.
              examples:
                payer-created:
                  summary: Payer created
                  value:
                    respCode: "20000"
                    respMsg: Success
                    data: "1984096429476806656"
```