v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB

q) Payments

List payments for the tenant

Returns payments initiated within the tenant, optionally filtered by wallet, status, type, amount, date range, and payment data such as a QR code value.

get/eclipse-conductor/rest/v1/tenants/{tenantId}/payments

Path parameters

tenantIdinteger required

Query parameters

amountnumber

dateFilterOnstring

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

dateFromInclstring

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

dateToExclstring

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

externalUniqueIdstring

fieldsstring

send includeCallbackResult to enrich extraInfo field with callback data

limitinteger

offsetinteger

paymentDatastring

The payment data used in the payment. E.g. QRCode

paymentReferencestring

paymentTypestring

statusstring

typestring

walletIdinteger

Response

acceptedCardSchemesstring[]

If the payment can be made by card then the allowed card schemes that can be used

acceptedPaymentMechanismsstring[]

The ways that the payment can be made

accountNumberstring

accountTypestring

amountnumber

The amount payable. Amounts are in major currency unit

amountOptionstring

Contain Json string for purchase amount minimum and maximum. If it is not empty then the purchase amount must be in between of min and max amount specified in this attribute(min and max inclusive) and that amount must be sent on the updated purchase request

associatedPaymentIdinteger

authCodestring

bankResponsestring

branchCodestring

cardPhonestring

Deprecated. Use phone instead

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 posted

currencystring

The currency of the payment amount - e.g. USD, ZAR, NGN, TSH

customerIdinteger

descriptionstring

A description for the payment created from the payment data.E.g. Merchant info and QR description for a QR payment

emvIssuerAuthenticationDatastring

Data delivered to the chip card including the ARPC cryptogram for online issuer authentication

errorDescriptionstring

This will only be populated if there was an error

expiresstring date-time

When the payment must complete by. If not in final state before this time, Eclipse will timeout the payment

externalUniqueIdstring

extraInfostring

Loosely typed data resulting from the payment. E.g. could be a voucher id if the payment was for a VAS. The structure depends on what was being paid for.

feenumber

gatewayTransactionIdstring

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

lastModifiedstring date-time

When the payment was last modified

locationstring

Optional. Any location information to add to the payment such as GPS coordinates or branch name etc

merchantIdstring

The unique identifier for the merchant

merchantNamestring

The name of the merchant to whome the payment will go

merchantReferencestring

Reference for the merchant

notestring

organisationIdinteger

otherWalletIdinteger

payment receiver’s wallet ID, if applicable.

partialPaymentAllowedboolean

Will be true if the value allows a partial payment and amount must be sent on the updated purchase request

paymentDatastring

Loosely typed data about the payment. Depends on the payment type. E.g. could be a QRCode

paymentIdinteger

Unique identifier for this payment transaction

paymentReferencestring

paymentTypestring required

The deduced type of payment being done based on the type and paymentData

phonestring

pspIdstring

retrievalReferenceNumberinteger

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

tracingContextstring

Tracing data about the payment

walletIdinteger

Example response

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