Skip to main content

Retrieve Transactions

GET 
/entities/{processing-entity-id}/transactions

Retrieves a list of transactions based on provided search criteria.

Request​

Path Parameters

    processing-entity-id uuidrequired

    Processing entityId provided by Nuvei.

    Example: 369bbe6d-4cbd-4d33-9205-2c83541cddab

Query Parameters

    start_date date-timerequired

    Start Date

    Example: 2020-02-20
    end_date date-timerequired

    End Date

    Example: 2020-02-21
    transaction_type TransactionType

    Possible values: [SALE, AUTH, REFUND, SETTLE, VOID]

    Transaction Type

    Example: SALE
    transaction_status TransactionStatus

    Possible values: [APPROVED, DECLINE, ERROR, PENDING]

    Transaction Status

    Example: APPROVED
    size SizeQuery

    Possible values: >= 1 and <= 200

    Page size for pagination.

    Default value: 200
    offset OffsetQuery

    Page number for pagination.

    Default value: 0

Responses​

OK

Schema

    transactions

    object[]

  • Array [

    • transactionType TransactionType (string)

    Possible values: [SALE, AUTH, REFUND, SETTLE, VOID]

    Example: SALE
    externalTransactionId string
    paymentId string
    transactionId string
    transactionDate date-time
    relatedTransactionId string
    transactionStatus string
    Example: approved
    merchantTransactionId string
    authCode string
    custom string
    credited string
    processedAmount string
    processedCurrency string
    creditType string
    acquiringBankName string
    isVoided string
    errorDescription string

    paymentOption

    object

    card

    object

    threeD

    object

    eci string
    isLiabilityOnIssuer string
    flow string
    isExemptionRequestInAuthentication boolean
    challengePreferenceReason string
    exemptionRequest string
    whiteListStatus boolean
    authenticationType string
    authenticationResult string
    challengeStatus string
    challengeCancelReason string
    merchantPreference string
    merchantPreferenceReason string
    avsCode string
    cvv2Code string
    cardHolderName string
    maskedCardNumber string
    expirationMonth string
    expirationYear string
    bin integer
    issuerBankName string
    issuingCountry string
    isPrepaid boolean
    cardBrand string
    cardType string
    paymentTokenId string

    paymentToken

    object

    paymentTokenId string

    additionalData

    object

    accountNumber string
    routingNumber string

    temporaryPaymentToken

    object

    paymentTokenId string
    merchantReference string

    alternativePaymentMethod

    object

    name string

    data

    object

    accountNumber string
    routingNumber string
    merchantContactInformation string

    The merchant contact information, as is displayed for the transaction on the consumer's card statement. It can also be an email address.

    Possible values: <= 255 characters

    subMerchant

    object

    id string

    Represents the internal merchant’s ID, which is forwarded to Visa and Mastercard

    Possible values: <= 15 characters

    city string

    The payment facilitator’s sub-merchant’s city name.

    Possible values: <= 20 characters

    countryCode string

    The payment facilitator’s sub-merchant’s 2-letter ISO country code.

    Possible values: >= 2 characters and <= 2 characters

    dynamicDescriptor

    object

    merchantName string

    The merchant name, as is displayed for the transaction on the consumer's card statement.

    Possible values: <= 25 characters

    merchantContactInformation string

    The merchant contact information, as is displayed for the transaction on the consumer's card statement. It can also be an email address.

    Possible values: <= 255 characters

    additionalTransactionInfo

    object

    additionalTransactionBankId string
    referenceId string

  • ]

    • result

    object

    status ResultStatus (string)required

    Status of the request: success | error

    Possible values: [success, error]

    errors

    object

    Object describing the error in case such occurred during processing of the request.

    code stringrequired

    Code of the error in case such occurred during processing of the request.

    Possible values: <= 11 characters

    reason string

    Description of the error in case such occurred during processing of the request.

    Possible values: <= 400 characters

Loading...