> ## Documentation Index
> Fetch the complete documentation index at: https://developer.paywint.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Add a Payee Address

> Adds a cross-border address for a payee.

Identify the payee by `payee_id` (the payee's user id). Send the payee's name and address fields
(with the country as an ISO2 code). Each field only accepts values within the maximum length allowed
by the payee rules for the destination country — see `GET /cross-border/payee-rules`. Returns the
created cross-border address.



## OpenAPI

````yaml POST /api/platform/cross-border/payee/address/{user_id}
openapi: 3.1.0
info:
  title: paywint
  version: 0.1.0
servers:
  - url: https://api.paywint.com
  - url: https://api.sandbox.paywint.com
security: []
paths:
  /api/platform/cross-border/payee/address/{user_id}:
    post:
      tags:
        - Platform Cross-Border
      summary: Add a Payee Address
      description: >-
        Adds a cross-border address for a payee.


        Identify the payee by `payee_id` (the payee's user id). Send the payee's
        name and address fields

        (with the country as an ISO2 code). Each field only accepts values
        within the maximum length allowed

        by the payee rules for the destination country — see `GET
        /cross-border/payee-rules`. Returns the

        created cross-border address.
      operationId: >-
        create_payee_address_api_platform_cross_border_payee_address__user_id__post
      parameters:
        - name: user_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Unique identifier (UUID) of the platform user who owns the payee.
            title: User Id
          description: Unique identifier (UUID) of the platform user who owns the payee.
          example: f47ac10b-****-****-****-0e02b2c3d479
        - name: X-Platform-ID
          in: header
          required: true
          schema:
            type: string
            format: uuid
            description: >-
              Unique platform identifier (UUID). You receive this during
              onboarding. Must be sent with every API request.
            title: X-Platform-Id
          description: >-
            Unique platform identifier (UUID). You receive this during
            onboarding. Must be sent with every API request.
        - name: X-Signature
          in: header
          required: true
          schema:
            type: string
            description: >-
              HMAC-SHA256 request signature for authentication. Use your
              platform secret key to compute it as: `METHOD + PATH + QUERY +
              BODY_HASH`.
            title: X-Signature
          description: >-
            HMAC-SHA256 request signature for authentication. Use your platform
            secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformCrossBorderAddressCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CommonResponse_PlatformCrossBorderAddressRead_
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PlatformCrossBorderAddressCreate:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 2
          title: Name
          description: Recipient's first name.
          example: John
        last_name:
          type: string
          maxLength: 100
          minLength: 1
          title: Last Name
          description: Recipient's last name.
          example: Smith
        address_line_1:
          type: string
          maxLength: 100
          minLength: 1
          title: Address Line 1
          description: Street address including apartment, suite, or unit number.
          example: 123 Main Street, Apt 4B
        city:
          type: string
          maxLength: 40
          minLength: 1
          title: City
          description: City name.
          example: New York
        state:
          type: string
          maxLength: 30
          minLength: 1
          title: State
          description: State, province, or region.
          example: NY
        zipcode:
          anyOf:
            - type: string
              maxLength: 10
            - type: 'null'
          title: Zipcode
          description: Postal code or ZIP code (optional).
          example: '10001'
        country:
          type: string
          maxLength: 2
          minLength: 2
          title: Country
          description: >-
            Payee country ISO2 code (e.g. IN). Use the `iso2` value from GET
            /cross-border/payout-countries for the destination country.
          example: IN
        payee_id:
          type: string
          format: uuid
          title: Payee Id
          description: Payee's user id.
          example: f47ac10b-****-****-****-0e02b2c3d479
      type: object
      required:
        - name
        - last_name
        - address_line_1
        - city
        - state
        - country
        - payee_id
      title: PlatformCrossBorderAddressCreate
      description: >-
        Cross-border payee address create. Identify the payee by `payee_id` (the
        payee's user id).


        Deliberately carries only the fields a cross-border payee needs — no
        `address_line_2` or

        `company_name` (unlike the general `ExternalContactAddressCreate`).
    CommonResponse_PlatformCrossBorderAddressRead_:
      properties:
        success:
          type: boolean
          title: Success
          description: Indicates whether the request was processed successfully.
          default: true
          example: true
        message:
          type: string
          title: Message
          description: >-
            A short, human-readable message describing the result of the
            request.
          default: Success
          example: Operation completed.
        data:
          anyOf:
            - $ref: '#/components/schemas/PlatformCrossBorderAddressRead'
            - type: 'null'
          description: The main response payload, if applicable
        queryGeneratedTime:
          anyOf:
            - type: number
            - type: 'null'
          title: Querygeneratedtime
          description: >-
            The Unix timestamp (in seconds) indicating when the response was
            generated.
          default: 1783409763.80796
          example: 1718006400
      type: object
      title: CommonResponse[PlatformCrossBorderAddressRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PlatformCrossBorderAddressRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        user_id:
          type: string
          format: uuid
          title: User Id
        name:
          type: string
          title: Name
        last_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Name
        address_line_1:
          type: string
          title: Address Line 1
        city:
          type: string
          title: City
        state:
          type: string
          title: State
        zipcode:
          type: string
          title: Zipcode
        country:
          type: string
          title: Country
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
        - user_id
        - name
        - address_line_1
        - city
        - state
        - zipcode
        - country
        - created_at
      title: PlatformCrossBorderAddressRead
      description: >-
        Cross-border payee address response — returns only the submitted payload
        fields plus the

        record's id and timestamps. Deliberately omits `address_line_2`,
        `company_name`, `is_default`

        and `address_type` (none are part of the cross-border address payload),
        and the internal

        contact id (the payee is identified by `payee_id` on the request, never
        surfaced back).
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````