POST /v1/:facility_id/ledgers/:ledger_id/make_payment
Make a payment on a particular ledger
Examples
POST /v1/a7ccbc47-adde-41e6-a768-874d3d05f415/ledgers/795bcfcd-20d7-4168-93be-10e83e76678e/make_payment
{
"payment": {
"amount": "5.0",
"kind": "custom"
},
"payment_method": {
"billing_address_attributes": {
"address1": "123 Main",
"city": "Somecity",
"country": "US",
"postal": "12345",
"state": "AL"
},
"card_number": "00000000",
"card_type": "visa",
"expiration_date": "10/24",
"first_name": "John",
"kind": "credit_card",
"last_name": "Doe",
"reuseable": "true",
"security_code": "123"
}
}
200
{
"ledger": {
"id": "795bcfcd-20d7-4168-93be-10e83e76678e",
"active": true,
"autopay_info": {
"autopay_enabled": false,
"day": 1,
"next_autopay_date": "2022-10-01",
"payment_method_id": null,
"payment_type": null,
"account_or_card_number": null
},
"closed_on": null,
"current_account_balance": 61.03,
"current_insurance": {
"premium": 22.72,
"description": "Bader Program - $44,000.00"
},
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": "429725",
"invoice_day_of_month": 10,
"lease_number": 1663058208,
"length_of_stay_in_months": 1,
"moved_in_at": "2022-09-12T22:36:34.391-10:00",
"next_charge_amount": 66.03,
"next_charge_amount_by_ledger": 66.03,
"next_charge_date": "2022-10-10",
"paid_through": "2022-09-09",
"rate_last_changed_on": "2022-09-12T22:36:34.391-10:00",
"rate_per_square_foot": 0.3,
"recent_open_charges": [
{
"id": "7b87a667-c5ae-457a-a27f-e5d9d790c7ca",
"description": "Bader Program - $44,000.00",
"code": null,
"internal_code": "4100",
"resolved": false,
"amount": 22.72,
"tax_amount": 0.0,
"amount_leftover": 22.72,
"effective_on": "2022-09-12T22:36:34.728-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "b54fd629-e700-46c7-a0ac-ff9403b2b461"
},
{
"id": "f256fc66-9724-4ddf-8b0b-12cb79e8d070",
"description": "Some service item",
"code": null,
"internal_code": "4150",
"resolved": false,
"amount": 30.18,
"tax_amount": 0.0,
"amount_leftover": 30.18,
"effective_on": "2022-09-12T22:36:34.728-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "18ce47a9-b4ce-4897-8913-84459c8cdb00"
},
{
"id": "ffc953fb-3805-49ad-816a-1bfdc38593a6",
"description": "Rent Unit U25 - 8x5x7",
"code": null,
"internal_code": "4000",
"resolved": false,
"amount": 13.13,
"tax_amount": 1.13,
"amount_leftover": 8.13,
"effective_on": "2022-09-12T22:36:34.728-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "243b219a-bc46-4ab7-949d-a7a0a5542562"
}
],
"recent_payments": [
{
"id": "85d717f9-7f67-4ef7-b295-f1e39c05830b",
"description": "Visa ****0000",
"code": null,
"internal_code": "1020",
"resolved": true,
"amount": -5.0,
"tax_amount": -1.13,
"amount_leftover": 0.0,
"effective_on": "2022-09-12T22:36:34.842-10:00",
"service_start_date": null,
"service_end_date": null,
"accountable_id": "a87b5279-914b-4ac9-b4fe-0c99ca86147a"
}
],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"tenant": {
"id": "23cd3296-8dac-449b-89c9-0f124addc274",
"account_number": 1000000,
"first_name": "Paulina32",
"last_name": "Wehner",
"middle_initial": null,
"email": "justineffertz@hahn.io32",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"795bcfcd-20d7-4168-93be-10e83e76678e"
],
"preferences": {
"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_32",
"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": "2022-09-12T22:36:34.328-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "a5dd127a-c32b-4fb3-9785-75aa7d630a1e",
"primary": true,
"source": null,
"number": "+13103517245",
"formatted_number": "(310) 351-7245 x 7157",
"extension": "7157",
"label": "Other",
"unformatted_number": "3103517245",
"sms_opt_in": false
},
{
"id": "9120b56c-527b-4e88-b781-65fba10db147",
"primary": false,
"source": null,
"number": "+17032346085",
"formatted_number": "(703) 234-6085 x 3373",
"extension": "3373",
"label": "Pager",
"unformatted_number": "7032346085",
"sms_opt_in": false
},
{
"id": "b8723b49-8623-41a6-8f83-e2605fa54d58",
"primary": false,
"source": null,
"number": "+15182063391",
"formatted_number": "(518) 206-3391 x 4483",
"extension": "4483",
"label": "Mobile",
"unformatted_number": "5182063391",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "123612cb-c15d-4c9e-9810-1b816b3e0ad6",
"address1": "246739 Veum Turnpike",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "246739 Veum Turnpike, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "123612cb-c15d-4c9e-9810-1b816b3e0ad6",
"address1": "246739 Veum Turnpike",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "246739 Veum Turnpike, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "a7ccbc47-adde-41e6-a768-874d3d05f415",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"649294df-3127-4c4b-92c9-ad37d4b6150e",
"a03d9e90-6d26-4a17-9c81-fa8c99fdde6f"
],
"password_recovery_question_ids": [
"3d6aa31e-e4a7-4fdd-b75a-372ed00f024b",
"6369274a-2ca6-4900-b0d0-8459e3bdad8e"
]
},
"unit": {
"id": "ac53459a-7c53-45c2-872d-9a2ae4510436",
"price": 847.75,
"name": "U25",
"description": "",
"width": 8.0,
"length": 5.0,
"height": 7.0,
"door_height": 10.0,
"door_width": 2.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "8x5x7",
"area": 40.0,
"standard_rate": 847.75,
"managed_rate": null,
"available_for_move_in": false,
"rentable": true,
"status": "occupied",
"payment_status": "current",
"current_ledger_id": "795bcfcd-20d7-4168-93be-10e83e76678e",
"current_tenant_id": "23cd3296-8dac-449b-89c9-0f124addc274",
"combo_lock_group": null,
"combination_lock_number": null,
"overlock_lock_number": null,
"attribute_description": null,
"deleted": false,
"damaged": false,
"complimentary": false,
"unrentable": false,
"company_owned": false,
"is_prepped": null,
"tiering": {
"cross_sell_group_id": 1948,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "fde5d9f8-2095-4b7c-bd97-72b5e76e6521",
"name": "Unit Type 25",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "fe19ae17-992f-45cb-9592-530046d6125b"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "a7ccbc47-adde-41e6-a768-874d3d05f415"
},
"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": {
"billing_address_attributes": {
"address1": "123 Main",
"city": "Somecity",
"country": "US",
"postal": "12345",
"state": "AL"
},
"card_number": "[FILTERED]",
"card_type": "visa",
"expiration_date": "10/24",
"first_name": "John",
"kind": "credit_card",
"last_name": "Doe",
"reuseable": "true",
"security_code": "[FILTERED]"
},
"facility_id": "a7ccbc47-adde-41e6-a768-874d3d05f415",
"ledger_id": "795bcfcd-20d7-4168-93be-10e83e76678e"
}
}
}
Params
| Param name | Description |
|---|---|
|
ledger_id required |
Value: Must be a String |
|
payment_fee_id optional |
Value: Must be a String |
|
payment required |
Value: Must be a Hash |
|
payment[amount] optional |
Value: Must be a String |
|
payment[kind] required |
Value: Must be one of: <code>custom</code>, <code>prepay</code>, <code>balance</code>. |
|
payment[months] optional |
Number of prepay months, used with Value: Must be a String |
|
payment_method required |
Can accept a paymentmethodid, or fields for CC or ACH payments Value: Must be a Hash |
|
payment_method[payment_method_id] optional |
If you want to use an existing payment method, pass in the id Value: Must be a String |
|
payment_method[first_name] optional |
Required if not using an existing payment method Value: Must be a String |
|
payment_method[last_name] optional |
Required if not using an existing payment method Value: Must be a String |
|
payment_method[kind] optional |
Required if not using an existing payment method Value: Must be one of: <code>ach</code>, <code>credit_card</code>, <code>check</code>, <code>cash</code>, <code>card_swipe</code>. |
|
payment_method[reuseable] optional |
Value: Must be one of: <code>true</code>, <code>false</code>. |
|
payment_method[magnetic_track] optional |
Required if using a card swipe Value: Must be a String |
|
payment_method[card_number] optional |
Required if using a credit card Value: Must be a String |
|
payment_method[card_type] optional |
Required if using a credit card Value: Must be one of: <code>visa</code>, <code>mastercard</code>, <code>american_express</code>, <code>diners</code>, <code>discover</code>, <code>jcb</code>. |
|
payment_method[security_code] optional |
Required if using a credit card Value: Must be a String |
|
payment_method[expiration_date] optional |
Required if using a credit card. Format: MM/YY Value: Must be a String |
|
payment_method[account_number] optional |
Required if using ACH Value: Must be a String |
|
payment_method[account_number_confirmation] optional |
Required if using ACH Value: Must be a String |
|
payment_method[account_type] optional |
Required if using ACH Value: Must be a String |
|
payment_method[bank_name] optional |
Required if using ACH Value: Must be a String |
|
payment_method[routing_number] optional |
Required if using ACH Value: Must be a String |
|
payment_method[billing_address_attributes] optional |
Required if not using an existing payment method Value: Must be a Hash |
|
payment_method[billing_address_attributes][company] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][address1] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][address2] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][city] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][postal] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][state] optional |
Value: Must be a String |
|
payment_method[check_number] optional |
Required if using Check Value: Must be a String |
|
payment_method[name_on_check] optional |
Required if using Check Value: Must be a String |
|
payment_method[check_amount] optional |
Required if using Check Value: Must be a String |
|
payment_method[reference_number] optional |
Required if using Money Order Value: Must be a String |
|
payment_method[money_order_amount] optional |
Required if using Money Order Value: Must be a String |
|
payment_method[amount_tendered] optional |
Required if using Cash Value: Must be a String |