Transactions

Read what happened on a card and correct it — transaction history, pending provisions, reversals and slip receipts.

getAuthorizationListByBegindateEnddate

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/getAuthorizationListByBegindateEnddate

Retrieves authorization list for a customer between given dates.

getAuthorizationListByBegindateEnddate › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getAuthorizationListByBegindateEnddate › Request Body

GetAuthorizationListByBegindateEnddateRequest

object

Get Authorization List By Begindate Enddate Param - [Optional]

getAuthorizationListByBegindateEnddate › Responses

Success

GetAuthorizationListByBegindateEnddateResponse

array | null

Get Authorization List By Begindate Enddate Result - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getAuthorizationListByBegindateEnddate

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getAuthorizationListByBegindateEnddate \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "GetAuthorizationListByBegindateEnddateParam": {
    "AuthorizationMatchStatus": "AuthorizationMatchStatus",
    "BeginDate": "2024-08-25T15:00:00Z",
    "CardRefNumber": "CardRefNumber",
    "CustomerNumber": 0,
    "EndDate": "2024-08-25T15:00:00Z",
    "Mcc": "Mcc",
    "NetworkType": "NetworkType",
    "NotSuccesfullResponse": "NotSuccesfullResponse",
    "ResponseCode": "ResponseCode",
    "ResponseReasonCode": "ResponseReasonCode",
    "Rrn": "Rrn",
    "ShadowCardNumber": "ShadowCardNumber",
    "TrnCodeMatrixId": "TrnCodeMatrixId",
    "TrnStatus": "TrnStatus"
  }
}'

Example Request Body

{
  "GetAuthorizationListByBegindateEnddateParam": {
    "AuthorizationMatchStatus": "AuthorizationMatchStatus",
    "BeginDate": "2024-08-25T15:00:00Z",
    "CardRefNumber": "CardRefNumber",
    "CustomerNumber": 0,
    "EndDate": "2024-08-25T15:00:00Z",
    "Mcc": "Mcc",
    "NetworkType": "NetworkType",
    "NotSuccesfullResponse": "NotSuccesfullResponse",
    "ResponseCode": "ResponseCode",
    "ResponseReasonCode": "ResponseReasonCode",
    "Rrn": "Rrn",
    "ShadowCardNumber": "ShadowCardNumber",
    "TrnCodeMatrixId": "TrnCodeMatrixId",
    "TrnStatus": "TrnStatus"
  }
}

json

application/json

Example Responses

{
  "GetAuthorizationListByBegindateEnddateResult": [
    {
      "AuthorizationMatchStatus": "AuthorizationMatchStatus",
      "CardRefNumber": "CardRefNumber",
      "CardSeqNumber": 0,
      "ChannelType": "ChannelType",
      "ChannelTypeDescription": "ChannelTypeDescription",
      "CommissionAmount": 0,
      "Customer": "Customer",
      "CustomerNumber": 0,
      "EarnedPoint": 0,
      "FeeAmount": 0,
      "IsChipFlag": true,
      "LocalAmount": 0,
      "LocalCurrencyCode": "LocalCurrencyCode",
      "LocalCurrencyDescription": "LocalCurrencyDescription",
      "MainCardRefNumber": "MainCardRefNumber",
      "MainCustomerNumber": 0,
      "MaskedCardNumber": "MaskedCardNumber",
      "MatchStatusDescription": "MatchStatusDescription",
      "Mcc": "Mcc",
      "MccDescription": "MccDescription",
      "MccGroupCode": "MccGroupCode",
      "MerchantCountryCode": "MerchantCountryCode",
      "MerchantName": "MerchantName",
      "NetworkTypeDescription": "NetworkTypeDescription",
      "OfflineFlag": true,
      "OpenReceiptFormIsEnabledFlag": true,
      "PanEntryMode": "PanEntryMode",
      "PinUsage": "PinUsage",
      "PreAuthorizationStatus": "PreAuthorizationStatus",
      "ProductDigitalFlag": true,
      "ProductName": "ProductName",
      "ProductVirtualFlag": true,
      "ResponseCodeDescription": "ResponseCodeDescription",
      "ResponseReasonCodeDescription": "ResponseReasonCodeDescription",
      "Rrn": "Rrn",
      "SettlementAmount": 0,
      "SettlementCurrencyDescription": "SettlementCurrencyDescription",
      "ShadowCardNumber": "ShadowCardNumber",
      "SourceTab": "SourceTab",
      "SuccessCode": "SuccessCode",
      "TerminalType": "TerminalType",
      "TransactionDate": "2024-08-25T15:00:00Z",
      "TransactionDescription": "TransactionDescription",
      "TransactionTime": "TransactionTime",
      "TrnAmount": 0,
      "TrnCodeMatrixDescription": "TrnCodeMatrixDescription",
      "TrnCodeMatrixId": "TrnCodeMatrixId",
      "TrnCurrencyCode": "TrnCurrencyCode",
      "TrnCurrencyDescription": "TrnCurrencyDescription",
      "TrnEffect": "TrnEffect",
      "TrnRewardAbility": "TrnRewardAbility",
      "TrnStatusDescription": "TrnStatusDescription",
      "Utid": "Utid"
    }
  ]
}

json

application/json

getPddtransactionByCardrefCustomernum

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/getPddtransactionByCardrefCustomernum

Retrieves PDD transactions by card reference and customer number.

getPddtransactionByCardrefCustomernum › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getPddtransactionByCardrefCustomernum › Request Body

GetPddtransactionByCardrefCustomernumRequest

object

Get Pddtransaction By Cardref Customernum Param - [Optional]

getPddtransactionByCardrefCustomernum › Responses

Success

GetPddtransactionByCardrefCustomernumResponse

array | null

Get Pddtransaction By Cardref Customernum Result - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getPddtransactionByCardrefCustomernum

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getPddtransactionByCardrefCustomernum \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "GetPddtransactionByCardrefCustomernumParam": {
    "CardRefNumber": "CardRefNumber",
    "CustomerNumber": 0,
    "EmbossName": "EmbossName",
    "MaxAmount": 0,
    "MinAmount": 0,
    "ShadowCardNumber": "ShadowCardNumber",
    "SourceNetwork": "SourceNetwork",
    "Transactiondatebegin": "2024-08-25T15:00:00Z",
    "Transactiondateend": "2024-08-25T15:00:00Z",
    "TrnCodeMatrixId": "TrnCodeMatrixId"
  }
}'

Example Request Body

{
  "GetPddtransactionByCardrefCustomernumParam": {
    "CardRefNumber": "CardRefNumber",
    "CustomerNumber": 0,
    "EmbossName": "EmbossName",
    "MaxAmount": 0,
    "MinAmount": 0,
    "ShadowCardNumber": "ShadowCardNumber",
    "SourceNetwork": "SourceNetwork",
    "Transactiondatebegin": "2024-08-25T15:00:00Z",
    "Transactiondateend": "2024-08-25T15:00:00Z",
    "TrnCodeMatrixId": "TrnCodeMatrixId"
  }
}

json

application/json

Example Responses

{
  "GetPddtransactionByCardrefCustomernumResult": [
    {
      "AcqRefNumber": "AcqRefNumber",
      "AuthorizationNumber": "AuthorizationNumber",
      "BillingAmount": 0,
      "BillingCurrency": "BillingCurrency",
      "BkmUniqueMerchantId": "BkmUniqueMerchantId",
      "CampaignCodeAcq": "CampaignCodeAcq",
      "CampaignCodeIss": "CampaignCodeIss",
      "ChannelType": "ChannelType",
      "ChannelTypeDescription": "ChannelTypeDescription",
      "ClearingChannel": "ClearingChannel",
      "ClearingDate": "2024-08-25T15:00:00Z",
      "ClearingNumber": 0,
      "CustomerNumberList": 0,
      "DisplayAtChannels": 0,
      "EarnedRewardBank": 0,
      "EarnedRewardCampaignAcq": 0,
      "EarnedRewardCampaignIss": 0,
      "EarnedRewardMerchant": 0,
      "EmbossName": "EmbossName",
      "EodDate": "2024-08-25T15:00:00Z",
      "InvoiceNumber": "InvoiceNumber",
      "LocalAmount": 0,
      "LocalCurrency": "LocalCurrency",
      "LocalCurrencyCode": "LocalCurrencyCode",
      "MainCardRefNumber": "MainCardRefNumber",
      "MainCustomerNumber": 0,
      "MaskedCardNumber": "MaskedCardNumber",
      "Mcc": "Mcc",
      "MccDescription": "MccDescription",
      "MccGroupCode": "MccGroupCode",
      "MerchantAmexId": "MerchantAmexId",
      "MerchantCity": "MerchantCity",
      "MerchantCountryCode": "MerchantCountryCode",
      "MerchantName": "MerchantName",
      "NetworkDescription": "NetworkDescription",
      "OfflineFlag": true,
      "PanEntryMode": "PanEntryMode",
      "Product": "Product",
      "ProductDigitalFlag": true,
      "ProductVirtualFlag": true,
      "RefUtid": "RefUtid",
      "RequestDate": "2024-08-25T15:00:00Z",
      "RewardTypeDescription": "RewardTypeDescription",
      "SettlementAmount": 0,
      "SettlementCurrency": "SettlementCurrency",
      "ShadowCardNumber": "ShadowCardNumber",
      "TerminalNumber": "TerminalNumber",
      "TerminalType": "TerminalType",
      "TransactionDescription": "TransactionDescription",
      "TrnAmount": 0,
      "TrnCodeMatrixDesc": "TrnCodeMatrixDesc",
      "TrnCodeMatrixId": "TrnCodeMatrixId",
      "TrnCurrency": "TrnCurrency",
      "TrnCurrencyCode": "TrnCurrencyCode",
      "TrnDate": "2024-08-25T15:00:00Z",
      "TrnDescription": "TrnDescription",
      "TrnEffect": "TrnEffect",
      "TrnOrigin": 0,
      "TrnRewardAbility": "TrnRewardAbility",
      "Utid": "Utid"
    }
  ]
}

json

application/json

getPrepaidTransactionAll

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidTransactionAll

Retrieves all prepaid transactions for a card or customer.

getPrepaidTransactionAll › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getPrepaidTransactionAll › Request Body

GetPrepaidTransactionAllRequest

beginDate

string · date-time · required

Begin Date

endDate

string · date-time · required

End Date

shadowCardNumber

string | null

Shadow Card Number - [Optional]

responseCode

string | null

Response Code - [Optional]

responseReasonCode

string | null

Response Reason Code - [Optional]

networkType

string | null

Network Type - [Optional]

trnCodeMatrixId

string | null

Trn Code Matrix Id - [Optional]

maxAmount

number | null · double

Max Amount - [Optional]

minAmount

number | null · double

Min Amount - [Optional]

getPrepaidTransactionAll › Responses

Success

GetPrepaidTransactionAllResponse

totalAmount

number · double · required

Total Amount

array | null

List Of Transaction - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidTransactionAll

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidTransactionAll \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber",
  "beginDate": "2024-08-25T15:00:00Z",
  "endDate": "2024-08-25T15:00:00Z",
  "responseCode": "responseCode",
  "responseReasonCode": "responseReasonCode",
  "networkType": "networkType",
  "trnCodeMatrixId": "trnCodeMatrixId",
  "maxAmount": 0,
  "minAmount": 0
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber",
  "beginDate": "2024-08-25T15:00:00Z",
  "endDate": "2024-08-25T15:00:00Z",
  "responseCode": "responseCode",
  "responseReasonCode": "responseReasonCode",
  "networkType": "networkType",
  "trnCodeMatrixId": "trnCodeMatrixId",
  "maxAmount": 0,
  "minAmount": 0
}

json

application/json

Example Responses

{
  "listOfTransaction": [
    {
      "terminalNumber": "terminalNumber",
      "authorizationNumber": "authorizationNumber",
      "authorizationMatchStatus": "authorizationMatchStatus",
      "cardRefNumber": "cardRefNumber",
      "cardSeqNumber": 0,
      "channelTypeDescription": "channelTypeDescription",
      "customer": "customer",
      "customerNumber": 0,
      "isChipFlag": true,
      "localAmount": 0,
      "localCurrencyDescription": "localCurrencyDescription",
      "mainCustomerNumber": 0,
      "maskedCardNumber": "maskedCardNumber",
      "matchStatusDescription": "matchStatusDescription",
      "mccDescription": "mccDescription",
      "merchantCountryCode": "merchantCountryCode",
      "merchantName": "merchantName",
      "networkTypeDescription": "networkTypeDescription",
      "offlineFlag": true,
      "panEntryMode": "panEntryMode",
      "pinUsage": "pinUsage",
      "responseCodeDescription": "responseCodeDescription",
      "responseReasonCodeDescription": "responseReasonCodeDescription",
      "rrn": "rrn",
      "settlementAmount": 0,
      "settlementCurrencyDescription": "settlementCurrencyDescription",
      "terminalType": "terminalType",
      "transactionDate": "2024-08-25T15:00:00Z",
      "trnAmount": 0,
      "trnCodeMatrixDescription": "trnCodeMatrixDescription",
      "trnCurrencyDescription": "trnCurrencyDescription",
      "trnStatusDescription": "trnStatusDescription",
      "utid": "utid",
      "trnEffect": "trnEffect",
      "channelType": "channelType",
      "capitalRewardIndicator": "capitalRewardIndicator",
      "cardProductVirtualFlag": true,
      "trnCurrencyCode": "trnCurrencyCode",
      "cardProductDigitalFlag": true,
      "transactionDescription": "transactionDescription",
      "earnedPoint": {
        "amount": 0,
        "rewardType": "rewardType"
      },
      "trnCodeMatrixId": "trnCodeMatrixId",
      "shadowCardNumber": "shadowCardNumber",
      "mainCardRefNumber": "mainCardRefNumber",
      "mcc": "mcc",
      "mccGroupCode": "mccGroupCode",
      "localCurrencyCode": "localCurrencyCode"
    }
  ],
  "totalAmount": 0
}

json

application/json

getPrepaidTransactionByUtid

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidTransactionByUtid

Retrieves a prepaid transaction by UTID.

getPrepaidTransactionByUtid › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getPrepaidTransactionByUtid › Request Body

GetPrepaidCardTransactionByUtidRequest

utid

string | null

Utid - [Optional]

getPrepaidTransactionByUtid › Responses

Success

GetPrepaidTransactionAllResponseItem

cardProductVirtualFlag

boolean · required

Card Product Virtual Flag

cardProductDigitalFlag

boolean · required

Card Product Digital Flag

terminalNumber

string | null

Terminal Number - [Optional]

authorizationNumber

string | null

Authorization Number - [Optional]

authorizationMatchStatus

string | null

Authorization Match Status - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

cardSeqNumber

integer | null · int32

Card Seq Number - [Optional]

channelTypeDescription

string | null

Channel Type Description - [Optional]

customer

string | null

Customer - [Optional]

customerNumber

integer | null · int64

Customer Number - [Optional]

isChipFlag

boolean | null

Is Chip Flag - [Optional]

localAmount

number | null · double

Local Amount - [Optional]

localCurrencyDescription

string | null

Local Currency Description - [Optional]

mainCustomerNumber

integer | null · int64

Main Customer Number - [Optional]

maskedCardNumber

string | null

Masked Card Number - [Optional]

matchStatusDescription

string | null

Match Status Description - [Optional]

mccDescription

string | null

Mcc Description - [Optional]

merchantCountryCode

string | null

Merchant Country Code - [Optional]

merchantName

string | null

Merchant Name - [Optional]

networkTypeDescription

string | null

Network Type Description - [Optional]

offlineFlag

boolean | null

Offline Flag - [Optional]

panEntryMode

string | null

Pan Entry Mode - [Optional]

pinUsage

string | null

Pin Usage - [Optional]

responseCodeDescription

string | null

Response Code Description - [Optional]

responseReasonCodeDescription

string | null

Response Reason Code Description - [Optional]

rrn

string | null

Rrn - [Optional]

settlementAmount

number | null · double

Settlement Amount - [Optional]

settlementCurrencyDescription

string | null

Settlement Currency Description - [Optional]

terminalType

string | null

Terminal Type - [Optional]

transactionDate

string | null · date-time

Transaction Date - [Optional]

trnAmount

number | null · double

Trn Amount - [Optional]

trnCodeMatrixDescription

string | null

Trn Code Matrix Description - [Optional]

trnCurrencyDescription

string | null

Trn Currency Description - [Optional]

trnStatusDescription

string | null

Trn Status Description - [Optional]

utid

string | null

Utid - [Optional]

trnEffect

string | null

Trn Effect - [Optional]

channelType

string | null

Channel Type - [Optional]

capitalRewardIndicator

string | null

Capital Reward Indicator - [Optional]

trnCurrencyCode

string | null

Trn Currency Code - [Optional]

transactionDescription

string | null

Transaction Description - [Optional]

object

Earned Point - [Optional]

trnCodeMatrixId

string | null

Trn Code Matrix Id - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

mcc

string | null

Mcc - [Optional]

mccGroupCode

string | null

Mcc Group Code - [Optional]

localCurrencyCode

string | null

Local Currency Code - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidTransactionByUtid

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidTransactionByUtid \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "utid": "utid"
}'

Example Request Body

{
  "utid": "utid"
}

json

application/json

Example Responses

{
  "terminalNumber": "terminalNumber",
  "authorizationNumber": "authorizationNumber",
  "authorizationMatchStatus": "authorizationMatchStatus",
  "cardRefNumber": "cardRefNumber",
  "cardSeqNumber": 0,
  "channelTypeDescription": "channelTypeDescription",
  "customer": "customer",
  "customerNumber": 0,
  "isChipFlag": true,
  "localAmount": 0,
  "localCurrencyDescription": "localCurrencyDescription",
  "mainCustomerNumber": 0,
  "maskedCardNumber": "maskedCardNumber",
  "matchStatusDescription": "matchStatusDescription",
  "mccDescription": "mccDescription",
  "merchantCountryCode": "merchantCountryCode",
  "merchantName": "merchantName",
  "networkTypeDescription": "networkTypeDescription",
  "offlineFlag": true,
  "panEntryMode": "panEntryMode",
  "pinUsage": "pinUsage",
  "responseCodeDescription": "responseCodeDescription",
  "responseReasonCodeDescription": "responseReasonCodeDescription",
  "rrn": "rrn",
  "settlementAmount": 0,
  "settlementCurrencyDescription": "settlementCurrencyDescription",
  "terminalType": "terminalType",
  "transactionDate": "2024-08-25T15:00:00Z",
  "trnAmount": 0,
  "trnCodeMatrixDescription": "trnCodeMatrixDescription",
  "trnCurrencyDescription": "trnCurrencyDescription",
  "trnStatusDescription": "trnStatusDescription",
  "utid": "utid",
  "trnEffect": "trnEffect",
  "channelType": "channelType",
  "capitalRewardIndicator": "capitalRewardIndicator",
  "cardProductVirtualFlag": true,
  "trnCurrencyCode": "trnCurrencyCode",
  "cardProductDigitalFlag": true,
  "transactionDescription": "transactionDescription",
  "earnedPoint": {
    "amount": 0,
    "rewardType": "rewardType"
  },
  "trnCodeMatrixId": "trnCodeMatrixId",
  "shadowCardNumber": "shadowCardNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "mcc": "mcc",
  "mccGroupCode": "mccGroupCode",
  "localCurrencyCode": "localCurrencyCode"
}

json

application/json

getDigitalSlipReceipt

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/getDigitalSlipReceipt

Retrieves digital slip receipts for prepaid transactions.

getDigitalSlipReceipt › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getDigitalSlipReceipt › Request Body

GetDigitalSlipReceiptRequest

channel

string | null

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

utid

string | null

Utid - [Optional]

getDigitalSlipReceipt › Responses

Success

GetDigitalSlipReceiptResponse

utid

string | null

Utid - [Optional]

refUtid

string | null

Ref Utid - [Optional]

trnCodeMatrixId

string | null

Trn Code Matrix Id - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

maskedCardNumber

string | null

Masked Card Number - [Optional]

trnAmount

number | null · double

Trn Amount - [Optional]

trnCurrencyCode

string | null

Trn Currency Code - [Optional]

responseCode

string | null

Response Code - [Optional]

trnDatetime

string | null · date-time

Trn Datetime - [Optional]

trnStatus

string | null

Trn Status - [Optional]

stan

integer | null · int32

Stan - [Optional]

rrn

string | null

Rrn - [Optional]

authorizationNumber

string | null

Authorization Number - [Optional]

terminalNumber

string | null

Terminal Number - [Optional]

merchantNumber

string | null

Merchant Number - [Optional]

merchantName

string | null

Merchant Name - [Optional]

panEntryMode

string | null

Pan Entry Mode - [Optional]

iccData84

string | null

Icc Data84 - [Optional]

iccData9f26

string | null

Icc Data9f26 - [Optional]

cardSeqNumber

string | null

Card Seq Number - [Optional]

merchantAddress

string | null

Merchant Address - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getDigitalSlipReceipt

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getDigitalSlipReceipt \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "utid": "utid"
}'

Example Request Body

{
  "channel": "channel",
  "utid": "utid"
}

json

application/json

Example Responses

{
  "utid": "utid",
  "refUtid": "refUtid",
  "trnCodeMatrixId": "trnCodeMatrixId",
  "shadowCardNumber": "shadowCardNumber",
  "cardRefNumber": "cardRefNumber",
  "maskedCardNumber": "maskedCardNumber",
  "trnAmount": 0,
  "trnCurrencyCode": "trnCurrencyCode",
  "responseCode": "responseCode",
  "trnDatetime": "2024-08-25T15:00:00Z",
  "trnStatus": "trnStatus",
  "stan": 0,
  "rrn": "rrn",
  "authorizationNumber": "authorizationNumber",
  "terminalNumber": "terminalNumber",
  "merchantNumber": "merchantNumber",
  "merchantName": "merchantName",
  "panEntryMode": "panEntryMode",
  "iccData84": "iccData84",
  "iccData9f26": "iccData9f26",
  "cardSeqNumber": "cardSeqNumber",
  "merchantAddress": "merchantAddress"
}

json

application/json

Customers Operation limits

getAuthorizationListByBegindateEnddate

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/getAuthorizationListByBegindateEnddate

Retrieves authorization list for a customer between given dates.

getAuthorizationListByBegindateEnddate › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getAuthorizationListByBegindateEnddate › Request Body

GetAuthorizationListByBegindateEnddateRequest

object

Get Authorization List By Begindate Enddate Param - [Optional]

getAuthorizationListByBegindateEnddate › Responses

Success

GetAuthorizationListByBegindateEnddateResponse

array | null

Get Authorization List By Begindate Enddate Result - [Optional]

getPddtransactionByCardrefCustomernum

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/getPddtransactionByCardrefCustomernum

Retrieves PDD transactions by card reference and customer number.

getPddtransactionByCardrefCustomernum › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getPddtransactionByCardrefCustomernum › Request Body

GetPddtransactionByCardrefCustomernumRequest

object

Get Pddtransaction By Cardref Customernum Param - [Optional]

getPddtransactionByCardrefCustomernum › Responses

Success

GetPddtransactionByCardrefCustomernumResponse

array | null

Get Pddtransaction By Cardref Customernum Result - [Optional]

getPrepaidTransactionAll

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidTransactionAll

Retrieves all prepaid transactions for a card or customer.

getPrepaidTransactionAll › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getPrepaidTransactionAll › Request Body

GetPrepaidTransactionAllRequest

beginDate

string · date-time · required

Begin Date

endDate

string · date-time · required

End Date

shadowCardNumber

string | null

Shadow Card Number - [Optional]

responseCode

string | null

Response Code - [Optional]

responseReasonCode

string | null

Response Reason Code - [Optional]

networkType

string | null

Network Type - [Optional]

trnCodeMatrixId

string | null

Trn Code Matrix Id - [Optional]

maxAmount

number | null · double

Max Amount - [Optional]

minAmount

number | null · double

Min Amount - [Optional]

getPrepaidTransactionAll › Responses

Success

GetPrepaidTransactionAllResponse

totalAmount

number · double · required

Total Amount

array | null

List Of Transaction - [Optional]

getPrepaidTransactionByUtid

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidTransactionByUtid

Retrieves a prepaid transaction by UTID.

getPrepaidTransactionByUtid › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getPrepaidTransactionByUtid › Request Body

GetPrepaidCardTransactionByUtidRequest

utid

string | null

Utid - [Optional]

getPrepaidTransactionByUtid › Responses

Success

GetPrepaidTransactionAllResponseItem

cardProductVirtualFlag

boolean · required

Card Product Virtual Flag

cardProductDigitalFlag

boolean · required

Card Product Digital Flag

terminalNumber

string | null

Terminal Number - [Optional]

authorizationNumber

string | null

Authorization Number - [Optional]

authorizationMatchStatus

string | null

Authorization Match Status - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

cardSeqNumber

integer | null · int32

Card Seq Number - [Optional]

channelTypeDescription

string | null

Channel Type Description - [Optional]

customer

string | null

Customer - [Optional]

customerNumber

integer | null · int64

Customer Number - [Optional]

isChipFlag

boolean | null

Is Chip Flag - [Optional]

localAmount

number | null · double

Local Amount - [Optional]

localCurrencyDescription

string | null

Local Currency Description - [Optional]

mainCustomerNumber

integer | null · int64

Main Customer Number - [Optional]

maskedCardNumber

string | null

Masked Card Number - [Optional]

matchStatusDescription

string | null

Match Status Description - [Optional]

mccDescription

string | null

Mcc Description - [Optional]

merchantCountryCode

string | null

Merchant Country Code - [Optional]

merchantName

string | null

Merchant Name - [Optional]

networkTypeDescription

string | null

Network Type Description - [Optional]

offlineFlag

boolean | null

Offline Flag - [Optional]

panEntryMode

string | null

Pan Entry Mode - [Optional]

pinUsage

string | null

Pin Usage - [Optional]

responseCodeDescription

string | null

Response Code Description - [Optional]

responseReasonCodeDescription

string | null

Response Reason Code Description - [Optional]

rrn

string | null

Rrn - [Optional]

settlementAmount

number | null · double

Settlement Amount - [Optional]

settlementCurrencyDescription

string | null

Settlement Currency Description - [Optional]

terminalType

string | null

Terminal Type - [Optional]

transactionDate

string | null · date-time

Transaction Date - [Optional]

trnAmount

number | null · double

Trn Amount - [Optional]

trnCodeMatrixDescription

string | null

Trn Code Matrix Description - [Optional]

trnCurrencyDescription

string | null

Trn Currency Description - [Optional]

trnStatusDescription

string | null

Trn Status Description - [Optional]

utid

string | null

Utid - [Optional]

trnEffect

string | null

Trn Effect - [Optional]

channelType

string | null

Channel Type - [Optional]

capitalRewardIndicator

string | null

Capital Reward Indicator - [Optional]

trnCurrencyCode

string | null

Trn Currency Code - [Optional]

transactionDescription

string | null

Transaction Description - [Optional]

object

Earned Point - [Optional]

trnCodeMatrixId

string | null

Trn Code Matrix Id - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

mcc

string | null

Mcc - [Optional]

mccGroupCode

string | null

Mcc Group Code - [Optional]

localCurrencyCode

string | null

Local Currency Code - [Optional]

getDigitalSlipReceipt

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/getDigitalSlipReceipt

Retrieves digital slip receipts for prepaid transactions.

getDigitalSlipReceipt › Headers

evrst-ptrnid

string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getDigitalSlipReceipt › Request Body

GetDigitalSlipReceiptRequest

channel

string | null

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

utid

string | null

Utid - [Optional]

getDigitalSlipReceipt › Responses

Success

GetDigitalSlipReceiptResponse

utid

string | null

Utid - [Optional]

refUtid

string | null

Ref Utid - [Optional]

trnCodeMatrixId

string | null

Trn Code Matrix Id - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

maskedCardNumber

string | null

Masked Card Number - [Optional]

trnAmount

number | null · double

Trn Amount - [Optional]

trnCurrencyCode

string | null

Trn Currency Code - [Optional]

responseCode

string | null

Response Code - [Optional]

trnDatetime

string | null · date-time

Trn Datetime - [Optional]

trnStatus

string | null

Trn Status - [Optional]

stan

integer | null · int32

Stan - [Optional]

rrn

string | null

Rrn - [Optional]

authorizationNumber

string | null

Authorization Number - [Optional]

terminalNumber

string | null

Terminal Number - [Optional]

merchantNumber

string | null

Merchant Number - [Optional]

merchantName

string | null

Merchant Name - [Optional]

panEntryMode

string | null

Pan Entry Mode - [Optional]

iccData84

string | null

Icc Data84 - [Optional]

iccData9f26

string | null

Icc Data9f26 - [Optional]

cardSeqNumber

string | null

Card Seq Number - [Optional]

merchantAddress

string | null

Merchant Address - [Optional]