GEgetpliant
Payments

List of Payments

Changed on

Returns a list of payments with metadata. Payments happen according to the payment frequency of the organization. They include and consider all relevant transactions and other payments during the specified period. You can use the limit, page, sortBy and sortDirection parameters to filter and sort the results.

get/payments

Request

Query parameters

organizationIdstring uuid required

The ID of the organization to get the payments for.

cardAccountIdstring uuid

The ID of the card account to get the payments for. Payments keep the card account id they were booked on. If a card account was superseded, filtering by the superseded id returns the payments booked before the switch and filtering by its successor (supersededBy) returns the ones booked after. Query both ids to get a complete list across the switch.

type'BILL' | 'TOPUP' | 'DIRECT_DEBIT_REVERSAL' | 'PAYOUT' | 'PAY_IN'

The type of the payments to filter by.

status'PLANNED' | 'UPCOMING' | 'DEFERRED' | 'READY_FOR_PMT' | 'PENDING' | 'PAID' | 'FAILED' | 'DISCARDED' | 'BOOKED' | 'REVERSED'

The status of the payments to filter by.

fromDatestring date-time nullable
Example:2021-01-30T08:30:00Z

The date from which to return payments, zero-offset UTC time. The date boundary is inclusive. Meaning we compare with >=.

toDatestring date-time nullable
Example:2021-01-30T08:30:00Z

The date until which to return payments, zero-offset UTC time. The date boundary is inclusive. Meaning we compare with <=.

byDateField'cutoffDate' | 'collectionDate' | 'paymentDate' | 'updatedAt' | 'createdAt' nullable

Desired date field to be filtered by if fromDate or toDate present.

limitinteger

The maximum number of items to return per page. The default value if not provided is 100, the maximum allowed value is 1000.

pageinteger

The page number to return, starting with 0, this counts up to the total number of pages. The total number of pages is determined by the total number of records divided by the limit.

sortBy'organizationId' | 'status' | 'type' | 'cutoffDate' | 'collectionDate' | 'paymentDate' | 'createdAt'

The field to sort by.

sortDirection'ASC' | 'DESC'

The direction to sort by.

Response

Ok

hasNextPageboolean

Indicates whether there is a next page available.

Changes

  • a4fbf7d068b4Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • warning

      added the new INTERNAL_TRANSFER enum value to the // response property for the response status

    • warning

      added the new INTERNAL_TRANSFER_REVERSAL enum value to the // response property for the response status

    • warning

      added the new PAY_IN enum value to the // response property for the response status

    • info

      added the new enum value PAY_IN to the query request parameter type

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status