GET STARTED

RECIPIENT

FINANCIAL ACCOUNT

PAYMENT REASON

TRANSACTION

NOTE

List Payment Reasons

Retrieve a list of payment reason IDs and their corresponding descriptions. These payment IDs can be used when creating a transaction. Use the page and size query parameters to limit the number of results returned.

Endpoint

GET /api/external/payment-reasons

Authorization Header

Basic Auth  REQUIRED

username is your API key ID and password is your API key secret.

Query Parameters

page  

integer (int32)

Page number to return.

size  

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns an array of payment reasons. The following fields are returned for each payment reason.

id

string (UUID)

Payment reason ID.

reason

string, max length: 50, min length: 0

Payment reason description.

createdAt

string (date-time)

Date and time the payment ID was created.

updatedAt

string (date-time)

Date and time the payment ID was last updated.

SAMPLE RESPONSE

				
					{
  "totalElements": 8,
  "totalPages": 1,
  "number": 0,
  "numberOfElements": 8,
  "hasNext": false,
  "content": [
    {
      "id": "89c24c91-854b-4880-8a16-e5a31b007292",
      "createdAt": "2021-04-27T14:23:36.129667Z",
      "reason": "Emergency relief disbursements",
      "updatedAt": "2021-06-25T15:40:44.119419Z"
    },
    {
      "id": "b9c0752d-113d-4825-a15d-60c15992d59e",
      "createdAt": "2021-04-27T14:23:36.129667Z",
      "reason": "Healthcare disbursements",
      "updatedAt": "2021-06-25T15:40:44.119419Z"
    },
    {
      "id": "e4716244-5fbc-4541-8485-1fad3849b996",
      "createdAt": "2021-04-27T14:23:36.129667Z",
      "reason": "Payment of rebates",
      "updatedAt": "2021-06-25T15:40:44.119419Z"
    },
    {
      "id": "bf982522-d9f4-461e-8e33-4e3fbd44176d",
      "createdAt": "2021-04-27T14:23:36.129667Z",
      "reason": "Reimbursement of customer expenses",
      "updatedAt": "2021-06-25T15:40:44.119419Z"
    },
    {
      "id": "26fa9b4d-0588-46f9-8660-f166b7105cc2",
      "createdAt": "2021-04-27T14:23:36.129667Z",
      "reason": "Litigation and settlement disbursements",
      "updatedAt": "2021-06-25T15:40:44.119419Z"
    },
    {
      "id": "63a15325-435d-4333-bfa0-9fe6fffcdc1c",
      "createdAt": "2021-04-27T14:23:36.129667Z",
      "reason": "Sponsored pay advance disbursements",
      "updatedAt": "2021-06-25T15:40:44.119419Z"
    },
    {
      "id": "fce32b66-3170-4a7f-9eb4-2dc57e78eb3b",
      "createdAt": "2021-04-27T14:23:36.129667Z",
      "reason": "Tax refunds",
      "updatedAt": "2021-06-25T15:40:44.119419Z"
    },
    {
      "id": "543be0f6-9942-46b9-80c7-f12848af5a0a",
      "createdAt": "2021-04-27T14:23:36.129667Z",
      "reason": "Loan payouts",
      "updatedAt": "2021-06-25T15:40:44.119419Z"
    }
  ]
}