Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
z) Global Functionality

List cross-tenant payments

Returns a cross-tenant list of payments with optional filtering by status, date range, payment type, amount, bank account, and reference. Only available to administrators.

get/eclipse-conductor/rest/v1/global/payments

Query parameters

amountstring

Filter by exact payment amount.

bankAccountstring

Filter by bank account number.

dateFilterOnstring

Column to apply the date range filter on. Use 'expiry' to filter on the expiry date; leave empty to filter on the created date.

dateFromInclstring

Start of date range (inclusive). ISO date string.

dateToExclstring

End of date range (exclusive). ISO date string.

limitinteger
offsetinteger
onlyUnmatchedboolean

Whether to only return unmatched payments.

paymentReferencestring
paymentTypestring

Filter by payment type.

statusstring
walletIdinteger

Response

OK

amountnumber

Amount in the major currency unit e.g. 50.80 for 50 GBP and 80 pence

authCodestring
bankAccountstring
bankNamestring
cardBinstring
cardExpiresstring date-time
cardLast4string
cardNamestring
cardPhonestring
cardTypestring
completionUrlstring

URL to open in an iFrame or browser where customer can securely complete 3DS details if required. Normally this will not be provided until the payment has been posted/updated with sufficient data to be processable. However this is provided for GLOBAL_PAYMENT_LINK payments as these dont require further info from the API caller for the payment to be made

createdstring date-time

When the payment was created

currencystring

Currency of the transaction. E.g. USD, ZAR, NGN etc

descriptionstring
errorDescriptionstring

This will only be populated if there was an error

expiresstring date-time
externalUniqueIdstring
gatewaystring
gatewayTransactionIdstring

The transaction identifier for this payment as provided by the gateway itself

paIdstring
paymentIdinteger
paymentReferencestring
status'BUILDING' | 'CANCELLED' | 'ERROR_PERM' | 'ERROR_TEMP' | 'PENDING' | 'REVERSED' | 'SUCCESSFUL' | 'TIMEOUT'

Status of a payment BUILDING: Not yet submitted as more data needs to be captured, PENDING:Being processed and can no longer be enhanced, SUCCESSFUL: Successfully completed, ERROR_PERM: Failed and wont ever succeed, ERROR_TEMP: Currently having an error but its being retried and may succeed or permanently fail, TIMEOUT: Failed as the process was not finalised in time, CANCELLED: Cancelled prior to SUCCESS or FAILURE, REVERSED: Reversed after success

subTypestring
typestring
walletIdinteger

Example response

[
  {
    "cardExpires": "2022-03-10T12:15:50-04:00",
    "created": "2022-03-10T12:15:50-04:00",
    "expires": "2022-03-10T12:15:50-04:00"
  }
]