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

# Create payment profile

> Creates a payment profile and links it to the given unit rental record. Use this to attach a payment method to a tenant's unit.
See the Credit Card Integrations Guide for tokenization and processor setup details.



## OpenAPI

````yaml /openapi/integration-openapi.json post /api/{portfolio}/portfolios/v1/payment/profile
openapi: 3.0.0
info:
  title: Monument Integration API
  description: Monument Integration API
  version: '1.0'
  contact: {}
servers:
  - url: https://public-api.prd.monument.io
    description: Production
  - url: https://public-api.stg.monument.io
    description: Staging
security: []
tags:
  - name: Portfolios
    description: List portfolios accessible to the API key
  - name: Facilities
    description: Facility retrieval and coverage-option configuration
  - name: Units
    description: Unit listing and MORA execution
  - name: Unit Groups
    description: Unit group listing, rate management, and unit assignment
  - name: Rental Records
    description: Rental record listing, coverage, fees, autopay, and payment links
  - name: Ledger Entries
    description: Ledger entry retrieval at facility and rental-record level
  - name: Leads
    description: Lead listing and lease sending
  - name: Tasks
    description: Task creation and listing for integrations
  - name: Tenants
    description: Tenant listing and person updates
  - name: People
    description: Person listing
  - name: Notes
    description: Note listing and creation for tenants and leads
  - name: Auctions
    description: Auction listing
  - name: Coverage
    description: Portfolio-level coverage CRUD and coverage history
  - name: Summary
    description: Portfolio-level aggregate summaries (insurance enrollment/occupancy)
  - name: Promotions
    description: Promotion listing
  - name: ECRI
    description: Effective Current Rent Increase scheduling
  - name: Item Types
    description: Item type listing per facility
  - name: Delinquencies
    description: Delinquency listing per facility
  - name: Physical Locks
    description: Physical lock assignment and unassignment
  - name: Lead Source Options
    description: Lead source option listing
  - name: Webhooks
    description: Webhook subscription management
  - name: Payments
    description: Payment profile creation
paths:
  /api/{portfolio}/portfolios/v1/payment/profile:
    post:
      tags:
        - Payments
      summary: Create payment profile
      description: >-
        Creates a payment profile and links it to the given unit rental record.
        Use this to attach a payment method to a tenant's unit.

        See the Credit Card Integrations Guide for tokenization and processor
        setup details.
      operationId: PrivateApiPaymentController_postPaymentProfile
      parameters:
        - name: portfolio
          required: true
          in: path
          schema:
            type: string
        - in: header
          required: true
          name: x-api-key
          schema:
            example: monument-2230012-2312321
            description: >-
              Api key required to authenticate your request. Please reach out to
              monument for a key.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostPaymentProfileIntegrationRequestDto'
      responses:
        '201':
          description: Payment profile created and linked to the unit rental record
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostPaymentProfileIntegrationResponseDto'
        '404':
          description: Unit rental record not found
components:
  schemas:
    PostPaymentProfileIntegrationRequestDto:
      type: object
      properties:
        lastFour:
          type: string
        paymentType:
          $ref: '#/components/schemas/ProcessorPaymentType'
        processorToken:
          type: string
        processorAuthTransactionId:
          type: string
        processorTokenId:
          type: string
        billingFirstName:
          type: string
        billingLastName:
          type: string
        billingCity:
          type: string
        billingZip:
          type: string
        billingState:
          type: string
        billingAddressLine1:
          type: string
        billingAddressLine2:
          type: string
        autopayEnabled:
          type: boolean
          description: >-
            Will set this payment method to be used for future bills for this
            unit.
        unitRentalRecordUuid:
          type: string
          description: UUID of the unit rental record to link the payment profile to
      required:
        - lastFour
        - paymentType
        - processorToken
        - processorAuthTransactionId
        - processorTokenId
        - billingFirstName
        - billingLastName
        - billingCity
        - billingZip
        - billingState
        - autopayEnabled
        - unitRentalRecordUuid
    PostPaymentProfileIntegrationResponseDto:
      type: object
      properties:
        paymentProfileUuid:
          type: string
          description: UUID of the created payment profile
      required:
        - paymentProfileUuid
    ProcessorPaymentType:
      type: string
      enum:
        - CREDIT/DEBIT
        - ACH

````