POST /v1/:facility_id/ledgers/:ledger_id/make_payment
Make a payment on a particular ledger
Params
| Param name | Description |
|---|---|
|
ledger_id
required |
Validations:
|
|
payment_fee_id
optional |
Validations:
|
|
payment
required |
Validations:
|
|
payment[amount]
optional |
Validations:
|
|
payment[kind]
required |
Validations:
|
|
payment[months]
optional |
Number of prepay months, used with Validations:
|
|
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:
|
|
payment_method
required |
Can accept a paymentmethodid, or fields for CC or ACH payments Validations:
|
|
payment_method[payment_method_id]
optional |
If you want to use an existing payment method, pass in the id Validations:
|
|
payment_method[first_name]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[last_name]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[kind]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[reuseable]
optional |
Validations:
|
|
payment_method[magnetic_track]
optional |
Required if using a card swipe Validations:
|
|
payment_method[card_number]
optional |
Required if using a credit card Validations:
|
|
payment_method[card_type]
optional |
Required if using a credit card Validations:
|
|
payment_method[security_code]
optional |
Required if using a credit card Validations:
|
|
payment_method[expiration_date]
optional |
Required if using a credit card. Format: MM/YY Validations:
|
|
payment_method[account_number]
optional |
Required if using ACH Validations:
|
|
payment_method[account_number_confirmation]
optional |
Required if using ACH Validations:
|
|
payment_method[account_type]
optional |
Required if using ACH Validations:
|
|
payment_method[bank_name]
optional |
Required if using ACH Validations:
|
|
payment_method[routing_number]
optional |
Required if using ACH Validations:
|
|
payment_method[billing_address_attributes]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[billing_address_attributes][company]
optional |
Validations:
|
|
payment_method[billing_address_attributes][address1]
optional |
Validations:
|
|
payment_method[billing_address_attributes][address2]
optional |
Validations:
|
|
payment_method[billing_address_attributes][city]
optional |
Validations:
|
|
payment_method[billing_address_attributes][postal]
optional |
Validations:
|
|
payment_method[billing_address_attributes][state]
optional |
Validations:
|
|
payment_method[check_number]
optional |
Required if using Check Validations:
|
|
payment_method[name_on_check]
optional |
Required if using Check Validations:
|
|
payment_method[check_amount]
optional |
Required if using Check Validations:
|
|
payment_method[reference_number]
optional |
Required if using Money Order Validations:
|
|
payment_method[money_order_amount]
optional |
Required if using Money Order Validations:
|
|
payment_method[amount_tendered]
optional |
Required if using Cash Validations:
|
Examples
POST /v1/3b0e3232-d61b-4df9-b857-04e08d434c95/ledgers/5e1d970a-12ad-4e29-9e7a-135ebefc68cc/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": "5e1d970a-12ad-4e29-9e7a-135ebefc68cc",
"active": true,
"autopay_enabled": false,
"autopay_info": {
"autopay_enabled": false,
"day": 1,
"next_autopay_date": "2023-10-01",
"payment_method_id": null,
"payment_type": null,
"account_or_card_number": null
},
"closed_on": null,
"current_account_balance": 76.58,
"current_insurance": {
"premium": 36.24,
"description": "Bader Program - $29,000.00"
},
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": null,
"invoice_day_of_month": 13,
"lease_number": 1694788765,
"length_of_stay_in_months": 0,
"moved_in_at": "2023-09-15T04:38:49.958-10:00",
"next_charge_amount": 81.58,
"next_charge_amount_by_ledger": 81.58,
"next_charge_date": "2023-10-13",
"paid_through": "2023-09-12",
"rate_last_changed_on": "2023-09-15T04:38:49.959-10:00",
"rate_per_square_foot": 0.2,
"recent_open_charges": [
{
"id": "172b3d80-e4a4-4cde-b00d-eafb74f8c8bd",
"description": "Bader Program - $29,000.00",
"code": null,
"internal_code": "4100",
"resolved": false,
"amount": 36.24,
"tax_amount": 0.0,
"amount_leftover": 36.24,
"effective_on": "2023-09-15T04:38:51.116-10:00",
"service_start_date": "2023-09-13",
"service_end_date": "2023-10-12",
"accountable_id": "b9a64a0f-da84-4944-b318-af0075901536"
},
{
"id": "e035c8fc-9c68-4b5a-9ffc-ebe4f4aca68c",
"description": "Some service item",
"code": null,
"internal_code": "4150",
"resolved": false,
"amount": 32.21,
"tax_amount": 0.0,
"amount_leftover": 32.21,
"effective_on": "2023-09-15T04:38:51.116-10:00",
"service_start_date": "2023-09-13",
"service_end_date": "2023-10-12",
"accountable_id": "6200b074-8b58-4df5-a63c-8fc36343b364"
},
{
"id": "4c946214-ed4b-4480-966a-f0c78f697f21",
"description": "Rent Unit U106 - 10x6x4",
"code": null,
"internal_code": "4000",
"resolved": false,
"amount": 13.13,
"tax_amount": 1.13,
"amount_leftover": 8.13,
"effective_on": "2023-09-15T04:38:51.116-10:00",
"service_start_date": "2023-09-13",
"service_end_date": "2023-10-12",
"accountable_id": "52d3681b-c08e-4a93-8cc5-c6eb54ef7011"
}
],
"recent_payments": [
{
"id": "2d72b6b8-8920-4426-a0bb-9c0aa8d5020e",
"description": "Visa ****0000",
"code": null,
"internal_code": "1020",
"resolved": true,
"amount": -5.0,
"tax_amount": -1.13,
"amount_leftover": 0.0,
"effective_on": "2023-09-15T04:38:52.004-10:00",
"service_start_date": null,
"service_end_date": null,
"accountable_id": "d0acca93-9432-4a67-a02f-0fbeef10440e"
}
],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"storage_items": [],
"tenant": {
"id": "1b566253-1269-4cb4-a73c-ec134af7cb06",
"account_number": 1000000,
"first_name": "Lexie151",
"last_name": "Quigley",
"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": [
"5e1d970a-12ad-4e29-9e7a-135ebefc68cc"
],
"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_151",
"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": "2023-09-15T04:38:49.669-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "dd2bb49a-91ca-4291-a0ea-40baa0617b93",
"primary": true,
"source": null,
"number": "+12319363595",
"formatted_number": "(231) 936-3595 x 8746",
"extension": "8746",
"label": "Other",
"unformatted_number": "2319363595",
"sms_opt_in": false
},
{
"id": "780f18ce-0666-4641-8d0e-17f4d6837a4f",
"primary": false,
"source": null,
"number": "+15137089010",
"formatted_number": "(513) 708-9010 x 2190",
"extension": "2190",
"label": "Other",
"unformatted_number": "5137089010",
"sms_opt_in": false
},
{
"id": "81ceda10-fda5-4dcf-aab0-352fa04b9a0e",
"primary": false,
"source": null,
"number": "+15853032077",
"formatted_number": "(585) 303-2077 x 1795",
"extension": "1795",
"label": "Mobile",
"unformatted_number": "5853032077",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "1cb69087-7825-4ab1-a0e7-2899389ca77c",
"address1": "10258399 Flatley Station",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "10258399 Flatley Station, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "1cb69087-7825-4ab1-a0e7-2899389ca77c",
"address1": "10258399 Flatley Station",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "10258399 Flatley Station, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "3b0e3232-d61b-4df9-b857-04e08d434c95",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"42738b0e-1e14-4f19-8986-722d40baf532",
"25889690-98d3-442b-9239-30b1356d6868"
],
"password_recovery_question_ids": [
"02041a8d-920f-475e-a0f6-f5f0a2b1595b",
"88a644d5-62e3-424a-8fdc-14b0b4521fdb"
]
},
"unit": {
"id": "3e63998c-c823-443e-8bfa-24705d18766e",
"price": 764.95,
"name": "U106",
"description": "",
"width": 10.0,
"length": 6.0,
"height": 4.0,
"door_height": 10.0,
"door_width": 1.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "10x6x4",
"area": 60.0,
"standard_rate": 764.95,
"managed_rate": null,
"tiered_rate": null,
"available_for_move_in": false,
"rentable": true,
"status": "occupied",
"payment_status": "current",
"current_ledger_id": "5e1d970a-12ad-4e29-9e7a-135ebefc68cc",
"current_tenant_id": "1b566253-1269-4cb4-a73c-ec134af7cb06",
"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,
"rank": null,
"custom_fields": [],
"allow_future_move_ins_limit": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "278b2e5c-4a05-4666-955b-f82d85db2637",
"name": "Unit Type 135",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "5598ce86-8fef-4b35-88fa-77a69ba14fb7"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "3b0e3232-d61b-4df9-b857-04e08d434c95"
},
"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": "3b0e3232-d61b-4df9-b857-04e08d434c95",
"ledger_id": "5e1d970a-12ad-4e29-9e7a-135ebefc68cc",
"ledger": {}
}
}
}