Params

Param name Description
ledger_id
required

Validations:

  • Must be a String

payment_fee_id
optional

Validations:

  • Must be a String

payment
required

Validations:

  • Must be a Hash

payment[amount]
optional

Validations:

  • Must be a String

payment[kind]
required

Validations:

  • Must be one of: custom, prepay, balance.

payment[months]
optional

Number of prepay months, used with prepay

Validations:

  • Must be a String

payment[idempotency_key]
optional

A unique key to ensure that the payment is not processed more than once. If not provided, one will be generated for you.

Validations:

  • Must be a String

payment_method
required

Can accept a paymentmethodid, or fields for CC or ACH payments

Validations:

  • Must be a Hash

payment_method[payment_method_id]
optional

If you want to use an existing payment method, pass in the id

Validations:

  • Must be a String

payment_method[first_name]
optional

Required if not using an existing payment method

Validations:

  • Must be a String

payment_method[last_name]
optional

Required if not using an existing payment method

Validations:

  • Must be a String

payment_method[kind]
optional

Required if not using an existing payment method

Validations:

  • Must be one of: ach, creditcard, check, cash, cardswipe.

payment_method[reuseable]
optional

Validations:

  • Must be one of: true, false, 1, 0.

payment_method[magnetic_track]
optional

Required if using a card swipe

Validations:

  • Must be a String

payment_method[card_number]
optional

Required if using a credit card

Validations:

  • Must be a String

payment_method[card_type]
optional

Required if using a credit card

Validations:

  • Must be one of: visa, mastercard, american_express, diners, discover, jcb.

payment_method[security_code]
optional

Required if using a credit card

Validations:

  • Must be a String

payment_method[expiration_date]
optional

Required if using a credit card. Format: MM/YY

Validations:

  • Must be a String

payment_method[account_number]
optional

Required if using ACH

Validations:

  • Must be a String

payment_method[account_number_confirmation]
optional

Required if using ACH

Validations:

  • Must be a String

payment_method[account_type]
optional

Required if using ACH

Validations:

  • Must be a String

payment_method[bank_name]
optional

Required if using ACH

Validations:

  • Must be a String

payment_method[routing_number]
optional

Required if using ACH

Validations:

  • Must be a String

payment_method[billing_address_attributes]
optional

Required if not using an existing payment method

Validations:

  • Must be a Hash

payment_method[billing_address_attributes][company]
optional

Validations:

  • Must be a String

payment_method[billing_address_attributes][address1]
optional

Validations:

  • Must be a String

payment_method[billing_address_attributes][address2]
optional

Validations:

  • Must be a String

payment_method[billing_address_attributes][city]
optional

Validations:

  • Must be a String

payment_method[billing_address_attributes][postal]
optional

Validations:

  • Must be a String

payment_method[billing_address_attributes][state]
optional

Validations:

  • Must be a String

payment_method[check_number]
optional

Required if using Check

Validations:

  • Must be a String

payment_method[name_on_check]
optional

Required if using Check

Validations:

  • Must be a String

payment_method[check_amount]
optional

Required if using Check

Validations:

  • Must be a String

payment_method[reference_number]
optional

Required if using Money Order

Validations:

  • Must be a String

payment_method[money_order_amount]
optional

Required if using Money Order

Validations:

  • Must be a String

payment_method[amount_tendered]
optional

Required if using Cash

Validations:

  • Must be a String

Examples

POST /v1/be783525-0ddb-4773-bdd8-f5d7a4eb33ae/ledgers/c21ffd2d-2cf1-4706-aad1-cbecfcb5300a/make_payment
{
  "payment": {
    "amount": 5.0,
    "kind": "custom"
  },
  "payment_method": {
    "kind": "credit_card",
    "first_name": "John",
    "last_name": "Doe",
    "reuseable": true,
    "card_type": "visa",
    "card_number": "00000000",
    "security_code": "123",
    "expiration_date": "10/24",
    "billing_address_attributes": {
      "address1": "123 Main",
      "city": "Somecity",
      "state": "AL",
      "postal": "12345",
      "country": "US"
    }
  },
  "ledger": {}
}
200
{
  "ledger": {
    "id": "c21ffd2d-2cf1-4706-aad1-cbecfcb5300a",
    "active": true,
    "autopay_enabled": false,
    "autopay_info": {
      "autopay_enabled": false,
      "day": 1,
      "next_autopay_date": "2024-07-01",
      "payment_method_id": null,
      "payment_type": null,
      "account_or_card_number": null
    },
    "closed_on": null,
    "current_account_balance": 36.19,
    "current_insurance": {
      "premium": 11.38,
      "description": "Bader Program - $43,000.00"
    },
    "current_prepay_balance": 0.0,
    "current_rate": 12.0,
    "delinquent": false,
    "gate_access_code": null,
    "invoice_day_of_month": 24,
    "lease_number": 1719397023,
    "length_of_stay_in_months": 1,
    "moved_in_at": "2024-06-26T00:16:52.618-10:00",
    "next_charge_amount": 41.19,
    "next_charge_amount_by_ledger": 41.19,
    "next_charge_date": "2024-07-24",
    "paid_through": "2024-06-23",
    "rate_last_changed_on": "2024-06-26T00:16:52.618-10:00",
    "rate_per_square_foot": 0.12,
    "recent_open_charges": [
      {
        "id": "0db174db-3d1b-4774-8f09-9227b0c00828",
        "description": "Bader Program - $43,000.00",
        "code": null,
        "internal_code": "4100",
        "resolved": false,
        "amount": 11.38,
        "tax_amount": 0.0,
        "amount_leftover": 11.38,
        "effective_on": "2024-06-26T00:16:53.257-10:00",
        "service_start_date": "2024-06-24",
        "service_end_date": "2024-07-23",
        "accountable_id": "ed6d44c2-d89f-4e27-b1f1-6e2078a1afc3"
      },
      {
        "id": "3c3c1a64-c087-41dc-a430-ca2bd36b0930",
        "description": "Some service item",
        "code": null,
        "internal_code": "4150",
        "resolved": false,
        "amount": 16.68,
        "tax_amount": 0.0,
        "amount_leftover": 16.68,
        "effective_on": "2024-06-26T00:16:53.257-10:00",
        "service_start_date": "2024-06-24",
        "service_end_date": "2024-07-23",
        "accountable_id": "b1a9b1ee-2cbd-49b3-80d2-2de888bdc2b9"
      },
      {
        "id": "4f1a1afc-bfdf-47c6-b2b1-f3ed52ba1940",
        "description": "Rent Unit U11 - 10x10x2",
        "code": null,
        "internal_code": "4000",
        "resolved": false,
        "amount": 13.13,
        "tax_amount": 1.13,
        "amount_leftover": 8.13,
        "effective_on": "2024-06-26T00:16:53.257-10:00",
        "service_start_date": "2024-06-24",
        "service_end_date": "2024-07-23",
        "accountable_id": "1a361ecd-cc82-4738-93fc-a621cc7f754b"
      }
    ],
    "recent_payments": [
      {
        "id": "c47e4887-9080-4e8e-9258-cb099a2ade1f",
        "description": "Visa ****0000",
        "code": null,
        "internal_code": "1020",
        "resolved": true,
        "amount": -5.0,
        "tax_amount": -1.13,
        "amount_leftover": 0.0,
        "effective_on": "2024-06-26T00:16:54.030-10:00",
        "service_start_date": null,
        "service_end_date": null,
        "accountable_id": "4dbebbd0-2ee7-4551-bd67-fa6db85fe713"
      }
    ],
    "scheduled_move_out": null,
    "scheduled_rate_change": null,
    "scheduled_transfer": null,
    "manage_revenue": "automatic",
    "rate_increase_exempt": false,
    "storage_items": [],
    "is_lease_signed": false,
    "tenant": {
      "id": "04e70b91-aed5-4e85-92b4-d7e25ccb6cd0",
      "account_number": 1000000,
      "first_name": "Luetta11",
      "last_name": "Reichel",
      "middle_initial": null,
      "email": "[email protected]",
      "tax_exempt": false,
      "is_military": false,
      "is_business": false,
      "business_name": null,
      "last_sign_in_at": null,
      "title": null,
      "delinquent": false,
      "current_ledger_ids": [
        "c21ffd2d-2cf1-4706-aad1-cbecfcb5300a"
      ],
      "preferences": {
        "locale": null,
        "email_invoices": true,
        "print_invoices": false,
        "charge_invoice_fee": true,
        "receive_legal_notices_by_email": null,
        "delinquency_exempt": false,
        "delinquency_docs_by_email": false,
        "delinquency_docs_by_mail": false,
        "receive_sms_for_gate_activity": false,
        "opt_in_to_marketing_emails": false,
        "opt_in_to_marketing_sms": false,
        "opt_in_to_transactional_sms": false,
        "exclude_from_insurance_auto_enroll": false,
        "exclude_from_insurance_auto_enroll_reason": null,
        "exclude_from_insurance_auto_enroll_created_by": null,
        "exclude_from_insurance_auto_enroll_on": null
      },
      "military_information": null,
      "username": "username_11",
      "drivers_license_number": null,
      "drivers_license_state": null,
      "vehicle_license_plate_number": null,
      "vehicle_license_state": null,
      "vehicle_description": null,
      "has_tenant_portal_account": false,
      "created_at": "2024-06-26T00:16:52.431-10:00",
      "gate_24_hour_access": false,
      "active": true,
      "tenant_account_kind_name": "Standard",
      "blocked_payments": false,
      "date_of_birth": null,
      "phone_numbers": [
        {
          "id": "7c7dd935-7d37-4dca-a91d-255c1456e37c",
          "primary": true,
          "source": null,
          "number": "+13034159578",
          "formatted_number": "(303) 415-9578 x 9519",
          "extension": "9519",
          "label": "Pager",
          "unformatted_number": "3034159578",
          "sms_opt_in": false
        },
        {
          "id": "59491139-ddfd-413a-8392-c8cfacb1e805",
          "primary": false,
          "source": null,
          "number": "+16188630422",
          "formatted_number": "(618) 863-0422 x 9958",
          "extension": "9958",
          "label": "Home",
          "unformatted_number": "6188630422",
          "sms_opt_in": false
        },
        {
          "id": "ffdd558a-4b04-46a8-b7cb-f9d8bcaf420d",
          "primary": false,
          "source": null,
          "number": "+15409134890",
          "formatted_number": "(540) 913-4890 x 0729",
          "extension": "0729",
          "label": "Work",
          "unformatted_number": "5409134890",
          "sms_opt_in": false
        }
      ],
      "mailing_address": {
        "id": "aaf66664-8f01-4c0b-9170-1702663c601b",
        "address1": "905556 Effertz Rapid",
        "address2": null,
        "city": "South Kareemmouth",
        "state": "NH",
        "postal": "47130",
        "country": "US",
        "full_address": "905556 Effertz Rapid, South Kareemmouth, NH 47130",
        "latitude": 39.114844,
        "longitude": -94.630169,
        "time_zone_id": "America/New_York",
        "time_zone_offset": "-04:00",
        "invalid_data": false,
        "label": "Home"
      },
      "addresses": [
        {
          "id": "aaf66664-8f01-4c0b-9170-1702663c601b",
          "address1": "905556 Effertz Rapid",
          "address2": null,
          "city": "South Kareemmouth",
          "state": "NH",
          "postal": "47130",
          "country": "US",
          "full_address": "905556 Effertz Rapid, South Kareemmouth, NH 47130",
          "latitude": 39.114844,
          "longitude": -94.630169,
          "time_zone_id": "America/New_York",
          "time_zone_offset": "-04:00",
          "invalid_data": false,
          "label": "Home"
        }
      ],
      "facility_id": "be783525-0ddb-4773-bdd8-f5d7a4eb33ae",
      "previous_ledger_ids": [],
      "lead_ids": [],
      "closed_lead_ids": [],
      "contact_ids": [],
      "support_case_ids": [],
      "event_ids": [
        "2a627d53-dffe-4f78-acd2-56c4b81bb785",
        "c57aafe1-03e0-4aac-aec4-59e0473f2d90"
      ],
      "password_recovery_question_ids": [
        "e3c6f5fa-3908-4141-91c9-c020f0e75108",
        "5a455ee6-32d5-4c10-80cd-349ebafbed39"
      ]
    },
    "unit": {
      "id": "8cfe3381-10e9-4cb9-ba6e-8236a283f029",
      "price": 710.86,
      "name": "U11",
      "description": "",
      "width": 10.0,
      "length": 10.0,
      "height": 2.0,
      "door_height": 8.0,
      "door_width": 4.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x10x2",
      "area": 100.0,
      "standard_rate": 710.86,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": false,
      "rentable": true,
      "status": "occupied",
      "payment_status": "current",
      "current_ledger_id": "c21ffd2d-2cf1-4706-aad1-cbecfcb5300a",
      "current_tenant_id": "04e70b91-aed5-4e85-92b4-d7e25ccb6cd0",
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "exclude_from_api": false,
      "deleted": false,
      "damaged": false,
      "complimentary": false,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "coverage_minimum_amount": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "962e1532-622b-4c4c-9c7a-9f29fbc08b1c",
        "name": "Unit Type 11",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": [],
        "insurable": true
      },
      "tier": null,
      "unit_group_id": "c8603b89-b485-4c11-9bdd-c16ff5a36e29"
    },
    "alternate_contact_assignment_id": null,
    "auction_id": null,
    "facility_id": "be783525-0ddb-4773-bdd8-f5d7a4eb33ae"
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "payment": {
        "amount": 5.0,
        "kind": "custom"
      },
      "payment_method": {
        "kind": "credit_card",
        "first_name": "John",
        "last_name": "Doe",
        "reuseable": true,
        "card_type": "visa",
        "card_number": "[FILTERED]",
        "security_code": "[FILTERED]",
        "expiration_date": "10/24",
        "billing_address_attributes": {
          "address1": "123 Main",
          "city": "Somecity",
          "state": "AL",
          "postal": "12345",
          "country": "US"
        }
      },
      "facility_id": "be783525-0ddb-4773-bdd8-f5d7a4eb33ae",
      "ledger_id": "c21ffd2d-2cf1-4706-aad1-cbecfcb5300a",
      "ledger": {}
    }
  }
}