List payment reasons

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.staging.lumepay.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Lumepay Staging API MCP server": {
    "url": "https://docs.staging.lumepay.com/mcp"
  }
}

Close
GET /api/v1/payment-reasons

Returns configured payment reasons. Put the selected id in paymentReasons.paymentReasonId when creating a beneficiary withdrawal. requiredTextFields describes the additional flat paymentReasons fields; requiredUploadFile describes required documents and their allowedFileTypes.

Responses

  • 200 application/json

    Payment reasons returned successfully

    Hide response attributes Show response attributes object
    • id integer(int64)

      Payment reason id to submit as paymentReasonId.

    • reason string

      Consumer-facing payment reason.

    • requiredTextFields object

      Text inputs required in paymentReasonTextValues, keyed by input name.

      Hide requiredTextFields attribute Show requiredTextFields attribute object
      • * object Additional properties
    • requiredUploadFile object

      Required upload inputs keyed by document name, including allowedFileTypes metadata.

      Hide requiredUploadFile attribute Show requiredUploadFile attribute object
      • * object Additional properties
  • 429 application/json

    Cloudflare API rate limit exceeded

    Hide response attributes Show response attributes object
    • error string
    • message string
  • 500 application/json

    Unexpected server error

    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string
    • httpStatus integer(int32)
    • requestId string
    • timestamp string(date-time)
    • errors array[object]
      Hide errors attributes Show errors attributes object
      • field string
      • message string
  • 400 application/json

    Request validation failed

    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string
    • httpStatus integer(int32)
    • requestId string
    • timestamp string(date-time)
    • errors array[object]
      Hide errors attributes Show errors attributes object
      • field string
      • message string
GET /api/v1/payment-reasons
curl \
 --request GET 'https://api.staging.lumepay.com/api/v1/payment-reasons'
Response examples (200)
[
  {
    "id": 1,
    "reason": "Payment for goods",
    "requiredTextFields": {
      "additionalProperty1": {},
      "additionalProperty2": {}
    },
    "requiredUploadFile": {
      "additionalProperty1": {},
      "additionalProperty2": {}
    }
  }
]
Response examples (429)
{
  "error": "rate_limit_exceeded",
  "message": "API rate limit exceeded"
}
Response examples (500)
{
  "httpStatus": 500,
  "requestId": "req_01HY0000000000000000000000",
  "message": "Unexpected server error",
  "code": 500,
  "timestamp": "2026-01-01T00:00:00Z",
  "errors": []
}
Response examples (400)
{
  "httpStatus": 400,
  "requestId": "req_01HY0000000000000000000000",
  "message": "Request validation failed",
  "code": 400,
  "timestamp": "2026-01-01T00:00:00Z",
  "errors": []
}