RocketKOR

Design  /  Payment Reason Use Cases  /  List Payment Reasons

List Payment Reasons

Overview

In this use case, we’ll walk through retrieving a list of payment reason IDs and their corresponding descriptions. These payment IDs can be used when creating a transaction.

API Operation

Steps

Send a request to the following endpoint:

GET /v1/payment-reasons

  • Include an Authorization header with your RocketKOR access token as a Bearer Token.
  • Request body is not required.

Sample Response

Returns an array of payment reasons. For each payment reason, the payment ID (reason) and description are returned.

				
					[
  {
    "reason": "healthcare-disbursements",
    "description": "Healthcare Disbursements"
  },
  {...},
  {...}
]
				
			
ON THIS PAGE