v2

POST /prospections
Create a prospection

Params

Param name Description
prospection
required

Prospection attributes

Validations:

  • Must be a Hash
prospection[prospect_id]
required

Prospect ID to link

Validations:

  • Must be a String
prospection[initial_amount]
optional

Initial investment amount

Validations:

  • Must be a String
prospection[type_of]
optional

Type: promissory_note

Validations:

  • Must be a String
prospection[status]
optional

Status: in_process, approved, rejected

Validations:

  • Must be a String
prospection[start_date]
optional

Start date (YYYY-MM-DD)

Validations:

  • Must be a String
prospection[end_date]
optional

End date (YYYY-MM-DD)

Validations:

  • Must be a String
prospection[currency]
optional

Currency: mxn, usd

Validations:

  • Must be a String
prospection[interest_rate]
optional

Annual interest rate

Validations:

  • Must be a String
prospection[includes_external_rate]
optional

Whether rate includes an external index

Validations:

  • Must be one of: true, false, 1, 0.
prospection[external_rate_label]
optional

External rate label (e.g. TIIE)

Validations:

  • Must be a String
prospection[interest_rate_floor]
optional

Minimum rate floor

Validations:

  • Must be a String
prospection[interest_rate_ceiling]
optional

Maximum rate ceiling

Validations:

  • Must be a String
prospection[commentary]
optional

Optional commentary

Validations:

  • Must be a String
prospection[society_id]
optional

Society ID

Validations:

  • Must be a String
prospection[promissory_duration_months]
optional

Duration in months

Validations:

  • Must be a Integer
prospection[minimum_term_months]
optional

Minimum term in months

Validations:

  • Must be a Integer

Examples

# Request body
{
  'prospection': {
    'prospect_id': '...',
    'initial_amount': '1000000.00',
    'type_of': 'promissory_note',
    'status': 'in_process',
    'start_date': '2025-01-01',
    'end_date': '2026-01-01',
    'currency': 'mxn',
    'interest_rate': '12.00',
    'commentary': null
  }
}
# Response
{
  'data': {
    'id': '...',
    'sequential_id': 2,
    'initial_amount': '1000000.00',
    'type_of': 'promissory_note',
    'status': 'in_process',
    'status_translated': 'En proceso',
    'start_date': '2025-01-01',
    'end_date': '2026-01-01',
    'currency': { 'name': 'MXN', 'value': 'mxn' },
    'interest_rate': '12.00',
    'promoter': { ... },
    'investor': null,
    'prospect': { ... }
  }
}

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error