GEgetpliant
Transactions

List of Transactions

Changed on

Returns a list of transactions. You can use the limit, page, sortBy, sortDirection parameters to filter and sort the results. You can also use filters like the partnerSubmissionStatus to e.g. only get transactions that you as a partner have not synced yet.

get/transactions

Request

Query parameters

organizationIdstring uuid required

The ID of the organization to get the transactions for.

status'DECLINED' | 'PENDING' | 'REVERSED' | 'CONFIRMED' | 'BOOKED'

The status of the transactions to filter by.

type'PURCHASE' | 'CASH_WITHDRAWAL' | 'REFUND' | 'CHARGEBACK' | 'RECHARGE' | 'STATUS_INQUIRY'

The type of the transactions to filter by.

partnerSubmissionStatus'NOT_SYNCED' | 'SYNCED' | 'TEMP_LOCKED' | 'LOCKED'

The partner submission status of the transactions to filter by.

cardAccountIdstring uuid

The ID of the card account to get the transactions for. Transactions keep the card account id they were booked on. If a card account was superseded, filtering by the superseded id returns the transactions 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.

cardholderIdstring uuid

The ID of the cardholder to get the transactions for.

cardIdstring uuid

The ID of the card to get the transactions for.

fromDatestring date-time
Example:2024-07-19T15:00:00.000000Z

The from date to filter by as zero-offset UTC time. The date boundary is inclusive. Meaning we compare with >=.

toDatestring date-time
Example:2024-07-19T15:00:00.000000Z

The to date to filter by as zero-offset UTC time. The date boundary is inclusive. Meaning we compare with <=.

byDateField'confirmedAt' | 'createdAt' | 'bookedAt' | 'updatedAt' nullable

The date field to filter by if fromDate and toDate are 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' | 'cardholderId' | 'cardId' | 'merchantId' | 'confirmedAt' | '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

    • 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