Skip to content
/
Consumer_Payment_Request_...

Consumer_Payment_Request_Create

Request

Security
basicAuth
Body
required
request_user_idstring, <= 255 charactersrequired

The ID in the partner system making the request.

consumer_application_uuidstring, <= 128 charactersrequired

The identifier in the partner system for this loan application.

transaction_descriptionintegerrequired

The ID of the transaction type being sent:

  • 109 - Consumer Deposit/Initial Charge,
  • 111 - Consumer Project Charge,
  • 113 - Consumer Final Charge
transaction_callback_urlstring, (uri)required
consumer_charge_amountstring, (decimal)^-?\d{0,8}(?:\.\d{0,2})?$required

Total amount being charged to the consumer

net_to_merchant_amountstring, (decimal)^-?\d{0,8}(?:\.\d{0,2})?$required

Net amount out of the consumer charge that should be credited to merchant

net_to_sponsor_amountstring, (decimal)^-?\d{0,8}(?:\.\d{0,2})?$required

Net amount out of the consumer charge that should be debited from the merchant deposit and credited to the sponsor. (i.e. processing fees, materials, etc.).

net_artis_feestring, (decimal)^-?\d{0,8}(?:\.\d{0,2})?$required

Net amount due to Momnt for the transaction - this should equal consumer charge amount * merchant fee % for the loan product. This should be pulled directly from the merchant's rate sheet every time - the request will fail if the amount is incorrect.

sponsor_account_uuidstring, (uuid)

Sponsor/Partner payment account UUID of which sponsor payment account should receive the funds in the net_to_sponsor field of the request

external_org_idstring, <= 255 characters

The external organization ID of the consumer.

curl -i -X POST \
  -u '<username>:<password>' \
  https://momnt-api-docs.redocly.app/_mock/docs/openapi/sponsor_consumer_v1/api/v1/sponsor/merchants/payment-request/ \
  -H 'Content-Type: application/json' \
  -d '{
    "request_user_id": "string",
    "consumer_application_uuid": "string",
    "transaction_description": 0,
    "transaction_callback_url": "http://example.com",
    "consumer_charge_amount": "string",
    "net_to_merchant_amount": "string",
    "net_to_sponsor_amount": "string",
    "net_artis_fee": "string",
    "sponsor_account_uuid": "3213467f-4f84-4449-97a0-4297bc72927f",
    "external_org_id": "string"
  }'

Responses

Bodyapplication/json
detailobject(DetailSchema)required
Response
{
  "detail": {
    "payment_request_uuid": "392cdba5-fba6-4dd7-b3c0-68bd0d6591f0",
    "consumer_application_uuid": "c3f532da-0620-4c5c-a079-be4538361751"
  }
}

Callbacks

Consumer Charge Callback (POST)After the sponsor i
post