Skip to content

SponsorAPI _ Consumer

Operations

Consumer_Account_Cancel

Request

Endpoint to cancel a consumer account using external_application_id.

Requirements:

  • Authentication is required; the sponsor/partner must provide valid credentials.
  • external_application_id: The external application ID must be provided in the request path to identify the consumer account to cancel.
  • request_user_id: The user ID in the Momnt system must be included in the request payload. The user must be active and previously established (e.g., via pre-onboarding or create_user).
  • Only users with appropriate permissions (Admin, Salesmanager, or the original Salesrep who sent the invitation) may cancel the account.
  • If the consumer account has any activity (e.g., amount spent > 0), cancellation will be forbidden.
  • On success, the consumer account will be deactivated and the application status updated to "Cancelled".
Security
basicAuth
Body
required
request_user_idstring, <= 255 charactersrequired

The ID of the user in the partner system making the application soft pull request.

external_application_idstring, <= 255 charactersrequired

The unique identifier in the partner system for this loan application.

curl -i -X POST \
  -u '<username>:<password>' \
  https://momnt-api-docs.redocly.app/_mock/docs/openapi/sponsor_consumer_v1/api/v1/sponsor/consumers/accounts/cancel/ \
  -H 'Content-Type: application/json' \
  -d '{
    "request_user_id": "string",
    "external_application_id": "string"
  }'

Responses

Success response

Bodyapplication/json
detailstringrequired
Response
{
  "detail": "Consumer account cancellation for invitation 12345."
}

Callbacks

Consumer Account Cancel Callback (POST)OverviewAft
post