| Param name | Description |
|---|---|
|
page
optional |
Page index Validations:
|
|
per
optional |
Items per page Validations:
|
|
includes
optional |
Comma-separated list of associations to include in the response. Available values: Validations:
|
{
'data': [
{
'id': 'payment-uuid',
'amount': '1000.00',
'date': '2026-01-01',
'status': { 'name': 'Pending', 'value': 'pending' },
'type_of': { 'name': 'Capital', 'value': 'capital' },
'category': { 'name': 'Final Capital', 'value': 'capital_final' },
'source_folio': 'SRC-001',
'source_type': 'PromissoryNote',
'source_id': 'source-uuid',
'source_folio_label': 'SRC-001 001',
'currency': { 'name': 'MXN', 'value': 'mxn' },
'payment_method': 'electronic_funds_transfer',
'marked_as_paid_at_date': null,
'percentage': '100.00',
'gross': '1000.00',
'tax': '160.00',
'iva': '0.00',
'retained_iva': '0.00',
'paid_iva': '0.00',
'dispersable': true,
'penalty_amount': null,
'bank_name': 'Test Bank',
'bank_alias': 'Test Alias',
'not_formatted_amount': '1000.0',
'recipient_id': 'recipient-uuid',
'recipient_type': 'Investor',
'recipient_full_name': 'Test User',
'interval_end_date': null,
'interval_start_date': null,
'interval_number_of_days': null,
'recipient': {
'id': 'recipient-uuid',
'sequential_id': 1,
'code': null,
'comment': null,
'name': 'Test',
'lastname': 'User',
'matriname': 'Example',
'full_name': 'Test User Example',
'company': false,
'company_name': null,
'person_type': 'Persona física',
'nationality': 'test_nationality',
'translated_nationality': 'Test Nationality',
'national_id_number': 'NID123456',
'phone_number': null,
'phone_number_extension': null,
'mobile_number': null,
'gender': 'other',
'dob': '1990-01-01',
'human_readable_dob': 'lunes, 1 de enero de 1990',
'email': 'testuser@example.com',
'admission_date': '2026-01-01',
'balance': { 'mxn': '1000.00', 'usd': '0.00' },
'active_investment_amount': 1,
'promoter_id': 'promoter-uuid',
'created_at': '2026-01-01 - 10:00',
'updated_at': '2026-01-02 - 12:00',
'created_by_full_name': 'Test Admin',
'country': 'MEX',
'country_translated': 'México',
'is_financial_entity': false,
'prospect_id': null,
'user_created': true,
'document_type': null,
'document_number': null,
'marital_status': null,
'account_statement_password': null,
'access_keys_sent': false,
'extra_fields_attributes': [],
'subsidiary_id': null,
'subsidiary_name': null
},
'bank_account': {
'id': 'bank-account-uuid',
'account_holder': 'Test User Example',
'account_holder_name': 'Test',
'account_holder_lastname': 'User',
'account_holder_matriname': 'Example',
'account_number': '123456789012',
'type_of': 'bank_account',
'alias': 'Test Alias',
'trust_number': null,
'branch_name': null,
'swift_code': null,
'aba_code': 'ABA123456789',
'is_foreign_bank': false,
'currency': { 'name': 'MXN', 'value': 'mxn' },
'bank_name': null,
'company': false,
'company_name': null,
'person_type': 'Persona física',
'extras': {},
'banxico_bank': {
'id': 'banxico-bank-uuid',
'name': 'Test Bank Name',
'abbreviation': 'BANK',
'code': '001'
},
'fiscal_address': {
'id': 'address-uuid',
'tax_id_number': 'TAXID123456',
'street': 'Street Name',
'street_number': '123',
'street_number_internal': null,
'zip_code': '12345',
'suburb': 'Suburb Name',
'city': 'City Name',
'state': 'State Name',
'country': 'MEX',
'country_translated': 'México',
'name': 'Name',
'lastname': 'Lastname',
'matriname': 'Matriname',
'company': false,
'company_name': null,
'default': false
}
},
'source': {
'id': 'source-uuid',
'initial_amount': '1000.00',
'folio': 'SRC-001',
'parent_id': 'parent-uuid',
'child_id': null,
'currency': { 'name': 'MXN', 'value': 'mxn' },
'interest_rate': '10.00',
'interest_rate_unformatted': '10.0',
'start_date': '2026-01-01',
'end_date': '2026-12-31',
'total_days': 365,
'monthly_periodicity': 1,
'capitalization_periodicity': 0,
'capitalization_payment': 0,
'tax_percentage': '16.00',
'current_tax_percentage': '16.0',
'iva_percentage': '0.00',
'cut_day': 31,
'investor_id': 'recipient-uuid',
'promoter_id': 'promoter-uuid',
'society_id': 'society-uuid',
'promoter_commission': '2.00',
'additional_interest_rate': '0.00',
'interest_rate_ceiling': '15.00',
'interest_rate_floor': '10.00',
'iva_retention_percentage': '0.00',
'rate_type': 'Fixed',
'external_rate_label': null,
'external_rate_label_translated': null,
'variable_rate_days_translated': '',
'type_of': { 'name': 'Simple', 'value': 'simple' },
'configuration': {},
'created_at': '2026-01-01 - 10:00',
'updated_at': '2026-01-02 - 12:00',
'created_by_full_name': 'Test Admin',
'mixed_rates': [],
'comment': null,
'extra_fields_attributes': [],
'applies_penalty_interest': false,
'penalty_basis': null,
'penalty_rate': null,
'penalty_basis_translated': null,
'canceled_date': null,
'investor': {
'id': 'recipient-uuid',
'full_name': 'Test User Example',
'company': false,
'is_financial_entity': false
},
'promoter': {
'id': 'promoter-uuid',
'full_name': 'Test Promoter'
},
'beneficiaries': [],
'organization': {
'id': 'org-uuid',
'configuration': {}
},
'co_owners': [],
'end_date_editable': false,
'society': {
'id': 'society-uuid',
'name': 'Test Society',
'is_financial_entity': true
},
'mixed_rates_electronic_funds_transfer': null,
'mixed_rates_other': null,
'status': 'Inactive',
'payment_on_expiration?': false,
'includes_external_rate': false,
'variable_rate_date': null,
'variable_rate_days': null,
'promissory_duration_months': { 'name': null, 'value': null },
'minimum_term_months': { 'name': null, 'value': null },
'current_balance': '1000.0',
'payment_on_expiration': 'PayOnExpiration',
'parent': { 'id': 'parent-uuid', 'folio': 'SRC-000' },
'children': null
}
}
]
}
| Code | Description |
|---|---|
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |