Skip to content
/
Refundable_Transactions

Refundable_Transactions

Request

Returns a list of refundable transactions to check which transactions are eligible for a refund based on a consumer application. Requirements:

  • Authentication information, user, and password are required for this endpoint.
  • Sponsor ID will be determined by the authentication information used.
  • request_user_id: There must be a user ID in the Momnt system for this GET request to succeed. That user must be active and should have been established in previous interactions, such as pre-onboarding or create_user.
  • loan_id: Partner’s ID for the Application sent in the consumer invitation initial POST.
Security
basicAuth
Path
external_application_idstringrequired
request_user_idstringrequired
curl -i -X GET \
  -u '<username>:<password>' \
  'https://momnt-api-docs.redocly.app/_mock/docs/openapi/sponsor_consumer_v1/api/v1/sponsor/merchants/{request_user_id}/refundable-transactions/{external_application_id}/'

Responses

Bodyapplication/json
Array [
transaction_descriptionstring, <= 255 charactersrequired
transaction_amountstring, (decimal)^-?\d{0,8}(?:\.\d{0,2})?$required
createdstring, (date-time)read-onlyrequired
submitted_bystringread-onlyrequired
payment_identifierstring, <= 64 characters
max_refundable_amountstring, (decimal)^-?\d{0,8}(?:\.\d{0,2})?$required
refunded_transactionsArray of objects(ConsumerRefundedTransactionList)read-onlyrequired
full_refund_availablebooleanrequired
partial_refund_availablebooleanrequired
]
Response
[
  {
    "transaction_description": "string",
    "transaction_amount": "string",
    "created": "2019-08-24T14:15:22Z",
    "submitted_by": "string",
    "payment_identifier": "string",
    "max_refundable_amount": "string",
    "refunded_transactions": [ … ],
    "full_refund_available": true,
    "partial_refund_available": true
  }
]