Skip to content
/
Consumer_Refund_Request

Consumer_Refund_Request

Request

For a merchant/contractor to refund a consumer, the partner/sponsor must first send a POST to Momnt to request a payment refund. This request triggers an SMS message to the consumer requesting the refund confirmation. The content of this SMS provides the consumer with the transaction amount, transaction type, and a code they must reply with to approve the refund.

There will be a response to this POST request to notify the partner/sponsor that the refund request was successfully sent or if it failed before sending. Additionally, a callback will be posted to the partner/sponsor once the transaction is completed (success or failure), this is documented next.

Requirements:

  • Authentication information (username and password) is required for this endpoint. Sponsor ID will be determined by the authentication information used.
  • This API will only be processed successfully if the merchant's status is 'Active' or 'Hold – Pause Applications'.
  • Only Admin users are authorized to initiate a refund request. If a user with insufficient permissions attempts to initiate a refund, the request will return an error.
Security
basicAuth
Body
required
request_user_idstring, <= 255 charactersrequired

The partner's merchant user UUID for the user making the request.

consumer_application_uuidstring, <= 128 charactersrequired

The identifier in the partner system for this loan application.

payment_identifierstringrequired
One of:

Payment identifier number of consumer transaction

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

Total amount being refunded to the consumer

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

Net amount out of the consumer refund that should be debited from merchant

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

Net amount out of the consumer refund that should be credited from the merchant deposit and debited from 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 refund will fail if the amount is incorrect.

transaction_callback_urlstring, (uri)required

When consumer refunded is completed (Successful or Failed), Momnt will POST information to this fully qualified URL.

external_org_idstring, <= 255 characters
curl -i -X POST \
  -u '<username>:<password>' \
  https://momnt-api-docs.redocly.app/_mock/docs/openapi/sponsor_consumer_v1/api/v1/sponsor/merchants/refund-payment-request/ \
  -H 'Content-Type: application/json' \
  -d '{
    "request_user_id": "string",
    "consumer_application_uuid": "string",
    "payment_identifier": "dc8b6f5d-792f-4caa-9ffc-351a69c91328",
    "consumer_refund_amount": "string",
    "net_to_merchant_amount": "string",
    "net_to_sponsor_amount": "string",
    "net_artis_fee": "string",
    "transaction_callback_url": "http://example.com",
    "external_org_id": "string"
  }'

Responses

Bodyapplication/json
detailstringrequired
Response
{
  "detail": "string"
}

Callbacks

Consumer Refund Callback (POST)The result of the c
post