Skip to content
Last updated

Momnt API - Merchant Endpoints

This API documentation is specific to a merchant’s onboarding and ongoing account requests and maintenance.

Merchant Onboarding

Before any consumer operations can take place, a merchant must be onboarded and fully configured. The steps in this section are sequential.

Step 1 — Register the merchant

POST /api/v1/sponsor/merchants/onboarding/

This is the entry point for bringing a new merchant onto the platform. The sponsor submits the merchant's business information and the details of the initial admin user. Momnt stores this data, creates the merchant record, and sends the admin user an email invitation to complete the onboarding workflow in Momnt's UI.

The response returns two identifiers that the sponsor must persist:

  • artis_merchant_id — the Momnt UUID for the merchant
  • artis_merchant_user_id — the Momnt UID for the first admin user

A callback is posted to sponsor_callback_url only after the merchant user completes the UI workflow and accepts the Terms & Conditions. The POST alone does not activate the merchant.

contractor_id, user_id, and user_business_email must be unique across all requests for a given sponsor. Reusing any of these values will return a 400 error.


Step 2 — Create merchant users

MethodEndpointDescription
POST/api/v1/sponsor/merchants/users/Create a user
PATCH/api/v1/sponsor/merchants/users/Update an existing user
POST/api/v1/sponsor/merchants/users/{request_user_id}/batch-create-users/Create multiple users
GET/api/v1/sponsor/merchants/users/{user_id}/Retrieve a user by external ID

The request_user_id in the request body must belong to an Admin user on the merchant. The merchant itself must already exist from Step 1 before users can be added.


Step 3 — Add payment details

POST /api/v1/sponsor/merchants/payment-detail/

Registers or updates the merchant's business bank account. After this call completes successfully, Momnt initiates the micro-deposit verification process automatically.


Step 4 — Verify the bank account via micro-deposits

Momnt sends two small deposits (between $0.01 and $0.99 each) to the bank account. The merchant confirms ownership by submitting the exact amounts. The calling user must have the Admin role.

MethodEndpointDescription
POST/api/v1/sponsor/merchants/payment-detail/verify-micro-deposits/{request_user_id}/Verify micro-deposits
POST/api/v1/sponsor/merchants/payment-detail/initiate-micro-deposits/{request_user_id}/Initiate micro-deposits

If verification fails — either due to more than three incorrect attempts or because the deposits expire after 14 days — use Initiate Micro-Deposits to restart the process. This endpoint is only applicable when the bank account status is VerificationFailed.


Step 5 — Configure the rate sheet

MethodEndpointDescription
GET/api/v1/sponsor/merchants/rate-sheets/{request_user_id}/View available loan products
PATCH/api/v1/sponsor/merchants/rate-sheets/Select products for the merchant

A rate sheet defines which loan products are available to consumers applying through this merchant. If no products are selected, consumers will receive no offers regardless of their creditworthiness.

The request_user_id for the GET must belong to an Admin user.


Offer Codes (Optional)

Offer codes allow sponsors to customize or restrict the loan products presented to a consumer at application time.

MethodEndpointDescription
GET /api/v1/sponsor/merchants/{merchant_uuid}/offer-code/List all offer codes for a merchant
POST/api/v1/sponsor/merchants/{merchant_uuid}/offer-code/Create a new offer code
GET/api/v1/sponsor/merchants/{merchant_uuid}/offer-code/{id}/Retrieve a single offer code
PATCH/api/v1/sponsor/merchants/{merchant_uuid}/offer-code/{id}Deactivate an offer code

Offer code deletion is implemented as a soft delete. Setting is_deleted to true is permanent — the operation cannot be reversed through the API.


Merchant Lookups

Once merchants are onboarded, the following endpoints provide read access:

MethodEndpointDescription
GET/api/v1/sponsor/merchants/List all merchants associated with the sponsor
GET/api/v1/sponsor/merchants/{external_org_id}/Retrieve a specific merchant by the sponsor's external organization ID