{"templateId":"markdown","sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":["cards","card","json-example"]},"type":"markdown"},"seo":{"title":"Consumer Application"},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"consumer-application","__idx":0},"children":["Consumer Application"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are two distinct integration paths for consumer onboarding. The appropriate path depends on whether the sponsor controls the consumer-facing UX."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"path-a--direct-invitation","__idx":1},"children":["Path A — Direct Invitation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this path when Momnt handles the consumer-facing application workflow end-to-end."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-1--send-an-application-invitation","__idx":2},"children":["Step 1 — Send an Application Invitation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v1/sponsor/consumers/application/"]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":1,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Send Application Invitation","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/sponsor_consumers_application_create"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submits the consumer's contact information and triggers an invitation via SMS ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["or"]}," email. Providing both channels in a single request will result in a validation error. The consumer follows the link to complete their application in Momnt's UI."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-2--monitor-invitation-status","__idx":3},"children":["Step 2 — Monitor Invitation Status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v1/sponsor/merchants/{request_user_id}/invitation/"]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":1,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"List Invitations","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/consumer_invitation_list"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns all invitations associated with the merchant user. Salesreps see only invitations they originated; Admins and Salesmanagers see all."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-3--prompt-payment-portal-setup-if-needed","__idx":4},"children":["Step 3 — Prompt Payment Portal Setup (if needed)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v1/sponsor/merchants/loan-applications/{request_user_id}/loan/{loan_id}/invite-portal/"]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":1,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Send Payment Portal Setup Email","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/consumer_payment_portal_account_email_request"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A consumer must have an active Payment Portal account before a payment request can be created against their loan. If the consumer skipped that step, this endpoint sends them a setup email. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loan_id"]}," is the sponsor's own identifier supplied in the original application POST."]},{"$$mdtype":"Tag","name":"JsonExample","attributes":{"json":{"is_valid_for_transaction":false,"transaction_status_code":2,"no_transaction_message":"You are unable to transact with this Customer at this time."},"errors":[]},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"path-b--soft-pull-embedded--headless","__idx":5},"children":["Path B — Soft Pull (Embedded / Headless)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this path when you need to initiate a soft credit pull and receive a real-time decision inline."," ","The response returns either:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["loan product offers or"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a No Offers result, which may trigger an Adverse Action Notice (AAN) email to the consumer."," ","Requires the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allow_soft_pull_process"]}," feature flag to be enabled on the sponsor account."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-1--initiate-a-soft-credit-pull","__idx":6},"children":["Step 1 — Initiate a Soft Credit Pull"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v1/sponsor/consumers/soft-pull/"]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":1,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Initiate Soft Credit Pull","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer-soft-pull/consumer_soft_pull_request"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is a consolidated endpoint that executes the following steps in a single call:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Creates the consumer invitation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Runs GUCA (de-duping),loan-stacking eligibility, and KYC checks"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Performs a soft credit pull"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Generates loan product offers"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response includes a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["decision"]}," field set to either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offers"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["no_offers"]},", along with a list of offer objects. Each offer contains an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offer_uuid"]}," required for the next step."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the decision is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["no_offers"]},", an Adverse Action Notice (AAN) email may be sent to the consumer depending on the decline reason."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-2--record-offer-selection","__idx":7},"children":["Step 2 — Record Offer Selection"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v1/sponsor/consumers/offers/{offer_uuid}/select/"]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":1,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Select Consumer Offer","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer-soft-pull/selected_consumer_offer"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once the consumer selects a loan product within the sponsor's UI, call this endpoint with the corresponding ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offer_uuid"]},". The response returns a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["consumer_invitation_link"]}," — redirect the consumer to this URL to review and accept their loan terms on Momnt's platform."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A callback is posted to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sponsor_callback_url"]}," once the consumer completes the application."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"consumer-loan-lookups","__idx":8},"children":["Consumer Loan Lookups"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v1/sponsor/merchants/loan-applications/{request_user_id}/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List all consumer loan applications for the merchant"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v1/sponsor/merchants/loan-applications/{request_user_id}/loan/{loan_id}/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve details for a single consumer loan"]}]}]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":2,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"List Consumer Loan Applications","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/merchant_consumer_applications_list"},"children":[]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Retrieve Consumer Loan Details","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/consumer_information_details"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"consumer-account-management","__idx":9},"children":["Consumer Account Management"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v1/sponsor/consumers/accounts/cancel/"]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":1,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Cancel Consumer Account","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/consumer_account_cancel"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cancels a consumer account and sets its status to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cancelled"]},". This action is only permitted when the consumer has no spending activity (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount_spent == 0"]},"). The requesting user must be an Admin, Salesmanager, or the Salesrep who originated the invitation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v1/sponsor/consumers/accounts/credit-line-increase/"]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":1,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Request Credit Line Increase","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/consumer_account_credit_line_increase"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submits a request to increase the consumer's credit limit. The following conditions must all be met:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The consumer's account balance must be zero"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The requested amount must exceed the current credit limit"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The requested amount must not exceed the maximum approved amount"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Only one credit line increase is permitted per account"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"funding","__idx":10},"children":["Funding"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"prerequisites","__idx":11},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before creating a charge request, verify that:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The consumer application status is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Approved: Accepted"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The consumer has an active Payment Portal account"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The merchant has an active bank account on file"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"transaction-status-codes","__idx":12},"children":["Transaction Status Codes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Controls when a merchant can initiate a charge request with a consumer:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Code"},"children":["Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Allowed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Able to transact with the customer."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Blocked"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unable to transact with the customer."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cannot transact with the customer. A Customer Payment Portal account is required."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"fee-split-requirement","__idx":13},"children":["Fee Split Requirement"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every charge request must include an exact fee breakdown. The following equation must hold:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"consumer_charge_amount = net_to_merchant_amount + net_artis_fee + net_to_sponsor_amount\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Momnt validates this server-side. Requests that do not balance will be rejected with a 400 error."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-1--create-a-charge-request","__idx":14},"children":["Step 1 — Create a Charge Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v1/sponsor/merchants/payment-request/"]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":1,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Create Payment Request","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/consumer_payment_request_create"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Triggers an SMS and email to the consumer containing a URL that directs to the Charge Request landing page. The consumer then enters the last four digits of their SSN and loan number to approve the charge request. Once approved, Momnt processes the transaction and posts the outcome to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction_callback_url"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the consumer's phone number is opted out of SMS and no email fallback is available, the endpoint returns a 424 error. If an email was attempted as a fallback, a 201 is returned with a warning in the response body."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," All charge requests expire after 48 hours without approval."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-2--approve-on-behalf-of-consumer-optional","__idx":15},"children":["Step 2 — Approve on Behalf of Consumer (Optional)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v1/sponsor/merchants/payment-request/{payment_request_uuid}/approve/"]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":1,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Approve Charge Request","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/sponsor_merchants_payment_request_approve_create"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Bypasses consumer landing page and SMS confirmation and approves the charge request programmatically. This capability is not enabled by default and must be requested from Momnt support."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-pending-charge-requests","__idx":16},"children":["List Pending Charge Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v1/sponsor/merchants/payment-request/{request_user_id}/"]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":1,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"List Pending Charge Requests","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/consumer_payment_request_list"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns charge requests that have been sent but not yet approved by the consumer. Accepts optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["begin_date"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end_date"]}," query parameters in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YYYY-MM-DD"]}," format to filter by date range."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"refunds","__idx":17},"children":["Refunds"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-1--identify-refundable-transactions","__idx":18},"children":["Step 1 — Identify Refundable Transactions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v1/sponsor/merchants/{request_user_id}/refundable-transactions/{external_application_id}/"]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":1,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"List Refundable Transactions","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/refundable_transactions"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the list of transactions eligible for a refund for a given consumer application."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-2--submit-the-refund","__idx":19},"children":["Step 2 — Submit the Refund"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v1/sponsor/merchants/refund-payment-request/"]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":1,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Submit Refund Request","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/consumer_refund_request"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Initiates a refund and triggers a successful refund email to both the consumer and merchant user. The requesting user must have the Admin role."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Constraints:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Transactions processed through Moov cannot be refunded unless they have settled"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Partial refunds are only permitted on settled transactions; unsettled transactions require a full refund"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The refund amount cannot exceed the transaction's maximum refundable amount"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The same fee-split validation applies as for charges"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A callback is posted to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction_callback_url"]}," on completion."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"transaction-history","__idx":20},"children":["Transaction History"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v1/sponsor/merchants/transactions/{request_user_id}/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Completed charges and refunds only (excludes pending charge requests)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v1/sponsor/merchants/{request_user_id}/all-transactions/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All activity including charge requests; supports filtering by loan"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v1/sponsor/merchants/{request_user_id}/available-transactions/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transactions available to the merchant user"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v1/sponsor/merchants/{request_user_id}/settled/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check settlement status for a specific transaction"]}]}]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":2,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"List Completed Transactions","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/consumer_transactions_list"},"children":[]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"List All Transaction Activity","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/consumer_all_transaction_activity"},"children":[]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"List Available Transactions","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/available_consumer_transactions"},"children":[]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Check Settlement Status","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_consumer_v1/sponsorapi-_-consumer/consumer_charge_settled"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"statements","__idx":21},"children":["Statements"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v1/sponsor/merchants/{request_user_id}/statement/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List all statements for a merchant user"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v1/sponsor/merchants/{request_user_id}/statement/{id}/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve a specific statement"]}]}]}]}]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":2,"cardMinWidth":180},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"List Statements","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_merchant_v1/sponsorapi-_-merchant/merchant_statement_list"},"children":[]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Retrieve Statement","icon":"images/code.svg","iconRawContent":"","imagePosition":"start","iconPosition":"auto","layout":"horizontal","align":"center","variant":"filled","iconVariant":"filled","to":"/docs/openapi/sponsor_merchant_v1/sponsorapi-_-merchant/merchant_statement_detail"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"callbacks","__idx":22},"children":["Callbacks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Momnt uses callbacks to deliver asynchronous event outcomes. Callbacks are authenticated using Basic Auth; the sponsor must provide credentials to Momnt in advance."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event"},"children":["Event"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Trigger"},"children":["Trigger"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant onboarding complete"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Merchant finishes UI workflow and accepts T&C"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consumer application complete"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consumer accepts loan terms (Soft Pull path)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consumer charge outcome"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consumer approves or rejects a charge request"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consumer refund outcome"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Refund is settled"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All callback URLs must be fully qualified and support POST requests."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]}]},"headings":[{"value":"Consumer Application","id":"consumer-application","depth":2},{"value":"Path A — Direct Invitation","id":"path-a--direct-invitation","depth":3},{"value":"Step 1 — Send an Application Invitation","id":"step-1--send-an-application-invitation","depth":4},{"value":"Step 2 — Monitor Invitation Status","id":"step-2--monitor-invitation-status","depth":4},{"value":"Step 3 — Prompt Payment Portal Setup (if needed)","id":"step-3--prompt-payment-portal-setup-if-needed","depth":4},{"value":"Path B — Soft Pull (Embedded / Headless)","id":"path-b--soft-pull-embedded--headless","depth":3},{"value":"Step 1 — Initiate a Soft Credit Pull","id":"step-1--initiate-a-soft-credit-pull","depth":4},{"value":"Step 2 — Record Offer Selection","id":"step-2--record-offer-selection","depth":4},{"value":"Consumer Loan Lookups","id":"consumer-loan-lookups","depth":3},{"value":"Consumer Account Management","id":"consumer-account-management","depth":3},{"value":"Funding","id":"funding","depth":2},{"value":"Prerequisites","id":"prerequisites","depth":3},{"value":"Transaction Status Codes","id":"transaction-status-codes","depth":3},{"value":"Fee Split Requirement","id":"fee-split-requirement","depth":3},{"value":"Step 1 — Create a Charge Request","id":"step-1--create-a-charge-request","depth":3},{"value":"Step 2 — Approve on Behalf of Consumer (Optional)","id":"step-2--approve-on-behalf-of-consumer-optional","depth":3},{"value":"List Pending Charge Requests","id":"list-pending-charge-requests","depth":3},{"value":"Refunds","id":"refunds","depth":2},{"value":"Step 1 — Identify Refundable Transactions","id":"step-1--identify-refundable-transactions","depth":3},{"value":"Step 2 — Submit the Refund","id":"step-2--submit-the-refund","depth":3},{"value":"Transaction History","id":"transaction-history","depth":2},{"value":"Statements","id":"statements","depth":2},{"value":"Callbacks","id":"callbacks","depth":2}],"frontmatter":{"title":"Consumer Workflows","description":"Step-by-step flows for inviting consumers, processing payments, managing accounts, and reporting.","seo":{"title":"Consumer Application"}},"lastModified":"2026-09-16T18:50:52.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/consumer-workflows","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}