Instalments

Split a purchase or a cash advance across a repayment schedule, then track, settle early or cancel the plan.

getEarlyCloseCandidateList

POST

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

/IntegrationDigitalChannelCredit/credit/api/getEarlyCloseCandidateList

Service that lists installment transactions eligible for early closure for the given customer and card.

getEarlyCloseCandidateList › 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

getEarlyCloseCandidateList › Request Body

GetEarlyCloseCandidateListRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

customerNumber

integer · int64

Customer Number - [Optional]

getEarlyCloseCandidateList › Responses

Success

GetEarlyCloseCandidateListResponse

array | null

List Of Early Close Candidate Row - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getEarlyCloseCandidateList

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getEarlyCloseCandidateList \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber",
  "customerNumber": 0
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber",
  "customerNumber": 0
}

json

application/json

Example Responses

{
  "listOfEarlyCloseCandidateRow": [
    {
      "customerNumber": 0,
      "shadowCardNumber": "shadowCardNumber",
      "trnDate": "2024-08-25T15:00:00Z",
      "authorizationNumber": "authorizationNumber",
      "utid": "utid",
      "totalInstallmentAmount": 0,
      "totalCapitalAmount": 0,
      "totalInstallmentProfitAmount": 0,
      "totalTaxAmount": 0,
      "installmentCount": 0,
      "deferringMonthCount": 0,
      "remainingInstallmentAmount": 0,
      "remainingCapitalAmount": 0,
      "remainingInstallmentProfitAmount": 0,
      "remainingTaxAmount": 0,
      "remainingInstallmentCount": 0
    }
  ]
}

json

application/json

doEarlyClose

POST

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

/IntegrationDigitalChannelCredit/credit/api/doEarlyClose

Performs early closure of a credit card installment. Returns the early release log record ID and the shadow card number.

doEarlyClose › 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

doEarlyClose › Request Body

DoEarlyCloseRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

utid

string | null

Utid - [Optional]

feeAmount

number · double

Fee Amount - [Optional]

earlyReleaseType

integer · int32

Early Release Type - [Optional]

doEarlyClose › Responses

Success

DoEarlyCloseResponse

erLogRecordId

integer · int64 · required

Er Log Record Id

shadowCardNumber

string | null

Shadow Card Number - [Optional]

getInstallmentCountsByUtid

POST

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

/IntegrationDigitalChannelCredit/credit/api/getInstallmentCountsByUtid

Retrieves the installment counts and limits for a credit card transaction identified by UTID. Returns minimum and maximum installment counts, deferring month limits, MCC-based limits, profile-based limits, and transaction details (amount, date, description). Adjusts MaxInstallmentCount and MaxDeferringMonthCount if the transaction occurs in an emergency city.

getInstallmentCountsByUtid › 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

getInstallmentCountsByUtid › Request Body

GetInstallmentCountsByUtidRequest

Utid

string | null

Utid - [Optional]

getInstallmentCountsByUtid › Responses

Success

GetInstallmentCountsByUtidResponse

Amount

number · double · required

Amount

Date

string · date-time · required

Date

MinInstallmentCount

integer | null · int32

Min Installment Count - [Optional]

MaxInstallmentCount

integer | null · int32

Max Installment Count - [Optional]

MinDeferringMonthCount

integer | null · int32

Min Deferring Month Count - [Optional]

MaxDeferringMonthCount

integer | null · int32

Max Deferring Month Count - [Optional]

InstallmentCountLimit

integer | null · int32

Installment Count Limit - [Optional]

InstallmentCountMccGroupLimit

integer | null · int32

Installment Count Mcc Group Limit - [Optional]

InstallmentCountMccLimit

integer | null · int32

Installment Count Mcc Limit - [Optional]

InstallmentProfileDeferringLimit

integer | null · int32

Installment Profile Deferring Limit - [Optional]

InstallmentProfileInstallmentLimit

integer | null · int32

Installment Profile Installment Limit - [Optional]

MccDefinitionInstallmentLimit

integer | null · int32

Mcc Definition Installment Limit - [Optional]

Description

string | null

Description - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getInstallmentCountsByUtid

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getInstallmentCountsByUtid \
  --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

{
  "MinInstallmentCount": 0,
  "MaxInstallmentCount": 0,
  "MinDeferringMonthCount": 0,
  "MaxDeferringMonthCount": 0,
  "InstallmentCountLimit": 0,
  "InstallmentCountMccGroupLimit": 0,
  "InstallmentCountMccLimit": 0,
  "InstallmentProfileDeferringLimit": 0,
  "InstallmentProfileInstallmentLimit": 0,
  "MccDefinitionInstallmentLimit": 0,
  "Amount": 0,
  "Date": "2024-08-25T15:00:00Z",
  "Description": "Description"
}

json

application/json

getCashInstallmentParameter

POST

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

/IntegrationDigitalChannelCredit/credit/api/getCashInstallmentParameter

Retrieves cash installment parameters for a given shadow card and transaction amount. Returns a list of installment options including minimum and maximum installment counts, transaction amount limits, profit rates, and fees. Requires a valid ShadowCardNumber.

Part of:

Journey 03 · Enabling additional capabilities — step 2, Installment cash (IPP)
Journey 03 · Enabling additional capabilities — step 2, Same services, debit card

getCashInstallmentParameter › 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

getCashInstallmentParameter › Request Body

GetCashInstallmentParameterRequest

shadowCardNumber

string · required

Shadow Card Number

accountNumber

string | null

Account Number - [Optional]

transactionAmount

number · double

Transaction Amount - [Optional]

channelId

string | null

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

Example: 002

getCashInstallmentParameter › Responses

Success

GetCashInstallmentParameterResponse

array | null

Cash Installment Parameter List - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCashInstallmentParameter

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCashInstallmentParameter \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber",
  "accountNumber": "accountNumber",
  "transactionAmount": 0,
  "channelId": "002"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber",
  "accountNumber": "accountNumber",
  "transactionAmount": 0,
  "channelId": "002"
}

json

application/json

Example Responses

{
  "cashInstallmentParameterList": [
    {
      "minInstallmentCount": 0,
      "maxInstallmentCount": 0,
      "minTrnAmount": 0,
      "maxTrnAmount": 0,
      "profitRate": 0,
      "feeAmount": 0
    }
  ]
}

json

application/json

simulateCashInstallmentForAll

POST

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

/IntegrationDigitalChannelCredit/credit/api/simulateCashInstallmentForAll

Simulates cash installments for all possible installment counts, providing a detailed breakdown of the total amount, installment amounts, profit, fees, and the remaining balance for each installment count.

Part of:

Journey 03 · Enabling additional capabilities — step 2, Installment cash (IPP)
Journey 03 · Enabling additional capabilities — step 2, Same services, debit card

simulateCashInstallmentForAll › 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

simulateCashInstallmentForAll › Request Body

SimulateCashInstallmentForAllRequest

shadowCardNumber

string · required

Shadow Card Number

accountNumber

string | null

Account Number - [Optional]

transactionAmount

number · double

Transaction Amount - [Optional]

channelId

string | null

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

Example: 002

simulateCashInstallmentForAll › Responses

Success

SimulateCashInstallmentForAllResponse

array | null

Cash Installment Simulate List - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/simulateCashInstallmentForAll

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/simulateCashInstallmentForAll \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber",
  "accountNumber": "accountNumber",
  "transactionAmount": 0,
  "channelId": "002"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber",
  "accountNumber": "accountNumber",
  "transactionAmount": 0,
  "channelId": "002"
}

json

application/json

Example Responses

{
  "cashInstallmentSimulateList": [
    {
      "totalAmount": 0,
      "totalProfitAmount": 0,
      "totalBsmvAmount": 0,
      "totalKkdfAmount": 0,
      "insterestRate": 0,
      "firstInstallAmount": 0,
      "installmentAmount": 0,
      "installmentDate": "2024-08-25T15:00:00Z",
      "installmentCount": 0,
      "installmentList": [
        {
          "installmentNumber": 0,
          "installmentDate": "2024-08-25T15:00:00Z",
          "installmentAmount": 0,
          "installmentCapitalAmount": 0,
          "installmentProfitAmount": 0,
          "installmentBsmvAmount": 0,
          "installmentKkdfAmount": 0,
          "remainingTotalAmount": 0,
          "remainingCapitalAmount": 0,
          "remainingProfitAmount": 0,
          "remainingBsmvAmount": 0,
          "remainingKkdfAmount": 0
        }
      ]
    }
  ]
}

json

application/json

simulateCashInstallment

POST

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

/IntegrationDigitalChannelCredit/credit/api/simulateCashInstallment

Simulates the cash installment process for a given card, calculating the installment amounts, profit, and other associated fees based on the requested installment count and transaction amount.

simulateCashInstallment › 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

simulateCashInstallment › Request Body

SimulateCashInstallmentRequest

shadowCardNumber

string · required

Shadow Card Number

accountNumber

string | null

Account Number - [Optional]

transactionAmount

number · double

Transaction Amount - [Optional]

installmentCount

integer · int32

Installment Count - [Optional]

channelId

string | null

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

Example: 002

simulateCashInstallment › Responses

Success

SimulateCashInstallmentResponse

object

Cash Installment Simulate Item - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/simulateCashInstallment

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/simulateCashInstallment \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber",
  "accountNumber": "accountNumber",
  "transactionAmount": 0,
  "installmentCount": 0,
  "channelId": "002"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber",
  "accountNumber": "accountNumber",
  "transactionAmount": 0,
  "installmentCount": 0,
  "channelId": "002"
}

json

application/json

Example Responses

{
  "cashInstallmentSimulateItem": {
    "totalAmount": 0,
    "totalProfitAmount": 0,
    "totalBsmvAmount": 0,
    "totalKkdfAmount": 0,
    "insterestRate": 0,
    "firstInstallAmount": 0,
    "installmentAmount": 0,
    "installmentDate": "2024-08-25T15:00:00Z",
    "installmentCount": 0,
    "installmentList": [
      {
        "installmentNumber": 0,
        "installmentDate": "2024-08-25T15:00:00Z",
        "installmentAmount": 0,
        "installmentCapitalAmount": 0,
        "installmentProfitAmount": 0,
        "installmentBsmvAmount": 0,
        "installmentKkdfAmount": 0,
        "remainingTotalAmount": 0,
        "remainingCapitalAmount": 0,
        "remainingProfitAmount": 0,
        "remainingBsmvAmount": 0,
        "remainingKkdfAmount": 0
      }
    ]
  }
}

json

application/json

doCashInstallment

POST

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

/IntegrationDigitalChannelCredit/credit/api/doCashInstallment

Processes a cash installment payment (early release). Returns transaction ID, authorization number, UTID, and RRN.

Part of:

Journey 03 · Enabling additional capabilities — step 2, Installment cash (IPP)
Journey 03 · Enabling additional capabilities — step 2, Same services, debit card

doCashInstallment › 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

doCashInstallment › Request Body

DoCashInstallmentRequest

shadowCardNumber

string · required

Shadow Card Number

accountNumber

string | null

Account Number - [Optional]

referenceNumber

string | null

Reference Number - [Optional]

transactionAmount

number · double

Transaction Amount - [Optional]

installmentCount

integer · int32

Installment Count - [Optional]

channelId

string | null

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

Example: 002

doCashInstallment › Responses

Success

DoCashInstallmentResponse

isSuccess

boolean · required

Is Success

feeAmount

number · double · required

Fee Amount

uTID

string | null

U T I D - [Optional]

authCode

string | null

Auth Code - [Optional]

responseCode

string | null

Response Code - [Optional]

responseReasonCode

string | null

Response Reason Code - [Optional]

reasonDescription

string | null

Reason Description - [Optional]

rrn

string | null

Rrn - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/doCashInstallment

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/doCashInstallment \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber",
  "accountNumber": "accountNumber",
  "referenceNumber": "referenceNumber",
  "transactionAmount": 0,
  "installmentCount": 0,
  "channelId": "002"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber",
  "accountNumber": "accountNumber",
  "referenceNumber": "referenceNumber",
  "transactionAmount": 0,
  "installmentCount": 0,
  "channelId": "002"
}

json

application/json

Example Responses

{
  "uTID": "uTID",
  "authCode": "authCode",
  "responseCode": "responseCode",
  "responseReasonCode": "responseReasonCode",
  "reasonDescription": "reasonDescription",
  "isSuccess": true,
  "feeAmount": 0,
  "rrn": "rrn"
}

json

application/json

reverseCashInstallment

POST

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

/IntegrationDigitalChannelCredit/credit/api/reverseCashInstallment

Reverses a cash installment transaction using the provided amount, shadow card number, UTID, and reference number.

Part of:

Journey 03 · Enabling additional capabilities — step 2, Installment cash (IPP)

reverseCashInstallment › 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

reverseCashInstallment › Request Body

ReverseCashInstallmentRequest

amount

number · double

Amount - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

uTID

string | null

U T I D - [Optional]

referenceNumber

string | null

Reference Number - [Optional]

reverseCashInstallment › Responses

Success

ReverseCashInstallmentResponse

isSuccess

boolean · required

Is Success

uTID

string | null

U T I D - [Optional]

authCode

string | null

Auth Code - [Optional]

responseReasonCode

string | null

Response Reason Code - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/reverseCashInstallment

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/reverseCashInstallment \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "amount": 0,
  "shadowCardNumber": "shadowCardNumber",
  "uTID": "uTID",
  "referenceNumber": "referenceNumber"
}'

Example Request Body

{
  "amount": 0,
  "shadowCardNumber": "shadowCardNumber",
  "uTID": "uTID",
  "referenceNumber": "referenceNumber"
}

json

application/json

Example Responses

{
  "uTID": "uTID",
  "authCode": "authCode",
  "responseReasonCode": "responseReasonCode",
  "isSuccess": true
}

json

application/json

getCancelableCashInstallmentList

POST

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

/IntegrationDigitalChannelCredit/credit/api/getCancelableCashInstallmentList

Retrieves a list of cancellable cash installments for a given shadow card number, including transaction details and card master information.

getCancelableCashInstallmentList › 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

getCancelableCashInstallmentList › Request Body

GetCancelableCashInstallmentListRequest

shadowCardNumber

string · required

Shadow Card Number

getCancelableCashInstallmentList › Responses

Success

GetCancelableCashInstallmentListResponse

array | null

List Of Cash Installment - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCancelableCashInstallmentList

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCancelableCashInstallmentList \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

json

application/json

Example Responses

{
  "listOfCashInstallment": [
    {
      "cardRefNumber": "cardRefNumber",
      "customerNumber": 0,
      "mainCardRefNumber": "mainCardRefNumber",
      "mainCustomerNumber": 0,
      "shadowCardNumber": "shadowCardNumber",
      "trnAmount": 0,
      "trnDescription": "trnDescription",
      "utid": "utid",
      "trnDate": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

getEarlyReleaseCashInstallments

POST

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

/IntegrationDigitalChannelCredit/credit/api/getEarlyReleaseCashInstallments

Retrieves cash installment transactions available for early release for a given ShadowCardNumber. Returns a list of transactions with details including total installment amount, installment count, fees, profit, taxes (Bsmv, Kkdf, interest), remaining installment capital, and a breakdown of each installment in DetailList with dates, amounts, and flags.

getEarlyReleaseCashInstallments › 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

getEarlyReleaseCashInstallments › Request Body

GetEarlyReleaseCashInstallmentsRequest

shadowCardNumber

string · required

Shadow Card Number

getEarlyReleaseCashInstallments › Responses

Success

GetEarlyReleaseCashInstallmentsResponse

array | null

Transaction List - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getEarlyReleaseCashInstallments

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getEarlyReleaseCashInstallments \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

json

application/json

Example Responses

{
  "transactionList": [
    {
      "shadowCardNumber": "shadowCardNumber",
      "mainCardRefNumber": "mainCardRefNumber",
      "utid": "utid",
      "transactionDate": "2024-08-25T15:00:00Z",
      "transactionAmount": 0,
      "installmentCount": 0,
      "totalFeeAmount": 0,
      "installmentProfitRate": 0,
      "totalInstallmentAmount": 0,
      "remainingInstallmentCount": 0,
      "remainingInstallmentCapitalAmount": 0,
      "earlyReleaseTotalAmount": 0,
      "earlyReleaseInterestAmount": 0,
      "earlyReleaseTotalTaxAmount": 0,
      "earlyReleaseBsmvAmount": 0,
      "earlyReleaseKkdfAmount": 0,
      "detailList": [
        {
          "installmentNumber": 0,
          "installmentDate": "2024-08-25T15:00:00Z",
          "installmentAmount": 0,
          "installmentCapitalAmount": 0,
          "installmentProfitAmount": 0,
          "installmentBsmvAmount": 0,
          "installmentKkdfAmount": 0,
          "statementFlag": true,
          "moveCurrentFlag": true
        }
      ]
    }
  ]
}

json

application/json

getEarlyReleaseCashInstallment

POST

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

/IntegrationDigitalChannelCredit/credit/api/getEarlyReleaseCashInstallment

Service that returns early-closed installment cash advance details.

getEarlyReleaseCashInstallment › 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

getEarlyReleaseCashInstallment › Request Body

GetEarlyReleaseCashInstallmentRequest

shadowCardNumber

string · required

Shadow Card Number

utid

string · required

Utid

getEarlyReleaseCashInstallment › Responses

Success

GetEarlyReleaseCashInstallmentResponse

transactionDate

string · date-time · required

Transaction Date

transactionAmount

number · double · required

Transaction Amount

installmentCount

integer · int32 · required

Installment Count

totalFeeAmount

number · double · required

Total Fee Amount

installmentProfitRate

number · double · required

Installment Profit Rate

totalInstallmentAmount

number · double · required

Total Installment Amount

remainingInstallmentCount

integer · int32 · required

Remaining Installment Count

remainingInstallmentCapitalAmount

number · double · required

Remaining Installment Capital Amount

earlyReleaseTotalAmount

number · double · required

Early Release Total Amount

earlyReleaseInterestAmount

number · double · required

Early Release Interest Amount

earlyReleaseTotalTaxAmount

number · double · required

Early Release Total Tax Amount

earlyReleaseBsmvAmount

number · double · required

Early Release Bsmv Amount

earlyReleaseKkdfAmount

number · double · required

Early Release Kkdf Amount

shadowCardNumber

string | null

Shadow Card Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

utid

string | null

Utid - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getEarlyReleaseCashInstallment

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getEarlyReleaseCashInstallment \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber",
  "utid": "utid"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber",
  "utid": "utid"
}

json

application/json

Example Responses

{
  "shadowCardNumber": "shadowCardNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "utid": "utid",
  "transactionDate": "2024-08-25T15:00:00Z",
  "transactionAmount": 0,
  "installmentCount": 0,
  "totalFeeAmount": 0,
  "installmentProfitRate": 0,
  "totalInstallmentAmount": 0,
  "remainingInstallmentCount": 0,
  "remainingInstallmentCapitalAmount": 0,
  "earlyReleaseTotalAmount": 0,
  "earlyReleaseInterestAmount": 0,
  "earlyReleaseTotalTaxAmount": 0,
  "earlyReleaseBsmvAmount": 0,
  "earlyReleaseKkdfAmount": 0
}

json

application/json

doCashInstallmentEarlyReleasePayment

POST

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

/IntegrationDigitalChannelCredit/credit/api/doCashInstallmentEarlyReleasePayment

Processes an early release cash installment payment. Returns UTID, transaction ID, authorization number, and RRN.

doCashInstallmentEarlyReleasePayment › 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

doCashInstallmentEarlyReleasePayment › Request Body

DoCashInstallmentEarlyReleasePaymentRequest

amount

number · double · required

Early-release settlement amount.

clientReferenceNumber

integer · int64 · required

Caller business key for the payment.

shadowCardNumber

string | null · required

Card the early-release payment is posted against.

channel

string | null · required

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

Example: 002

currencyCode

string | null · required

ISO currency of the payment.

cashInstallmentUtid

string | null · required

UTID of the cash-installment plan being settled early.

accountNumber

integer · int32

Accepted on the request; not mapped into the payment entity.

doCashInstallmentEarlyReleasePayment › Responses

Success

DoCashInstallmentEarlyReleasePaymentResponse

trnId

integer · int64 · required

Trn Id

utid

string | null

Utid - [Optional]

rrn

string | null

Rrn - [Optional]

authorizationNumber

string | null

Authorization Number - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/doCashInstallmentEarlyReleasePayment

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/doCashInstallmentEarlyReleasePayment \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "accountNumber": 0,
  "amount": 0,
  "clientReferenceNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "channel": "002",
  "currencyCode": "currencyCode",
  "cashInstallmentUtid": "cashInstallmentUtid"
}'

Example Request Body

{
  "accountNumber": 0,
  "amount": 0,
  "clientReferenceNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "channel": "002",
  "currencyCode": "currencyCode",
  "cashInstallmentUtid": "cashInstallmentUtid"
}

json

application/json

Example Responses

{
  "utid": "utid",
  "trnId": 0,
  "rrn": "rrn",
  "authorizationNumber": "authorizationNumber"
}

json

application/json

cancelCashInstallEarlyReleasePayment

POST

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

/IntegrationDigitalChannelCredit/credit/api/cancelCashInstallEarlyReleasePayment

Cancels an early release cash installment payment for a credit card. Calls the transaction management service to reverse the payment using transaction ID, amount, currency, card reference, and other identifiers. Returns the transaction ID of the cancellation.

cancelCashInstallEarlyReleasePayment › 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

cancelCashInstallEarlyReleasePayment › Request Body

CancelCashInstallEarlyReleasePaymentRequest

trnId

integer | null · int64 · required

Transaction id of the early-release payment being reversed.

amount

number | null · double · required

Amount of the original early-release payment.

currencyCode

string | null · required

Currency of the original payment.

clientReferenceNumber

integer · int64 · required

Same client reference used on the payment call.

channel

string | null · required

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

Example: 002

cashInstallmentUtid

string | null · required

UTID of the cash-installment plan the payment belonged to.

cardRefNumber

string | null

Card reference when needed to locate the original payment.

mainCustomerNumber

integer | null · int64

Main customer number when required by the cancel criteria.

trnDate

string | null · date-time

Original transaction date when the cancel needs date scoping.

cancelCashInstallEarlyReleasePayment › Responses

Success

CancelCashInstallEarlyReleasePaymentResponse

trnId

integer · int64 · required

Trn Id

POST/IntegrationDigitalChannelCredit/credit/api/cancelCashInstallEarlyReleasePayment

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/cancelCashInstallEarlyReleasePayment \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "trnId": 0,
  "amount": 0,
  "currencyCode": "currencyCode",
  "clientReferenceNumber": 0,
  "cardRefNumber": "cardRefNumber",
  "mainCustomerNumber": 0,
  "trnDate": "2024-08-25T15:00:00Z",
  "channel": "002",
  "cashInstallmentUtid": "cashInstallmentUtid"
}'

Example Request Body

{
  "trnId": 0,
  "amount": 0,
  "currencyCode": "currencyCode",
  "clientReferenceNumber": 0,
  "cardRefNumber": "cardRefNumber",
  "mainCustomerNumber": 0,
  "trnDate": "2024-08-25T15:00:00Z",
  "channel": "002",
  "cashInstallmentUtid": "cashInstallmentUtid"
}

json

application/json

Example Responses

{
  "trnId": 0
}

json

application/json

getAllWaitingInstallments

POST

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

/IntegrationDigitalChannelCredit/credit/api/getAllWaitingInstallments

Retrieves all waiting (pending) credit card installments for a given shadow card number. Returns both summary and detailed installment information grouped by statement date.

Part of:

Journey 03 · Enabling additional capabilities — step 3, Track waiting installments

getAllWaitingInstallments › 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

getAllWaitingInstallments › Request Body

GetAllWaitingInstallmentsRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

getAllWaitingInstallments › Responses

Success

GetAllWaitingInstallmentsResponse

array | null

Result

POST/IntegrationDigitalChannelCredit/credit/api/getAllWaitingInstallments

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getAllWaitingInstallments \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

json

application/json

Example Responses

{
  "result": [
    {
      "details": [
        {
          "utid": "utid",
          "recordId": 0,
          "trnCodeMatrixId": "trnCodeMatrixId",
          "statementDate": "2024-08-25T15:00:00Z",
          "installmentAmount": 0,
          "amount": 0,
          "trnAmount": 0,
          "shadowCardNumber": "shadowCardNumber",
          "cardRefNumber": "cardRefNumber",
          "mainCardRefNumber": "mainCardRefNumber",
          "maskedCardNumber": "maskedCardNumber",
          "creditCardStatementTransactionTypeIsBorrow": true,
          "creditCardStatementTransactionTypeIsLoan": true,
          "domesticAmount": 0,
          "installmentCurrencyCode": "installmentCurrencyCode",
          "currencyCode": "currencyCode",
          "trnCurrencyCode": "trnCurrencyCode",
          "totalPointEarned": 0,
          "installmentNumber": 0,
          "mCCCode": "mCCCode",
          "mCCDescription": "mCCDescription",
          "mCCGroupCode": "mCCGroupCode",
          "mCCGroupDescription": "mCCGroupDescription",
          "originalAmount": 0,
          "totalInstallmentCount": 0,
          "transactionCode": "transactionCode",
          "transactionDate": "2024-08-25T15:00:00Z",
          "transactionDescription": "transactionDescription",
          "productNumber": "productNumber",
          "cardProductVirtualFlag": true,
          "cardProductDigitalFlag": true,
          "capitalRewardIndicator": "capitalRewardIndicator",
          "trnEffect": "trnEffect",
          "channelType": "channelType",
          "remainInstallmentAmount": 0,
          "bkmUniqueMerchantId": "bkmUniqueMerchantId",
          "supplementaryCardFlag": true,
          "erOrderedFlag": true,
          "digitalSlipFlag": true,
          "digitalSlipValue": "digitalSlipValue",
          "rewardType": "rewardType",
          "rewardTypeDescription": "rewardTypeDescription",
          "authorizationNumber": "authorizationNumber",
          "bsmvAmount": 0,
          "kkdfAmount": 0,
          "installmentFeeAmount": 0,
          "installmentProfitAmount": 0,
          "panEntryMode": "panEntryMode",
          "panEntryModeDescription": "panEntryModeDescription",
          "merchantName": "merchantName",
          "merchantNumber": "merchantNumber"
        }
      ],
      "summary": {
        "statementDate": "2024-08-25T15:00:00Z",
        "totalInstallmentAmount": 0,
        "totalInstallmentBsmvAmount": 0,
        "totalInstallmentCapitalAmount": 0,
        "totalInstallmentFeeAmount": 0,
        "totalInstallmentKkdfAmount": 0,
        "totalInstallmentProfitAmount": 0
      }
    }
  ]
}

json

application/json

getWaitingInstallmentDetail

POST

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

/IntegrationDigitalChannelCredit/credit/api/getWaitingInstallmentDetail

Retrieves the waiting (upcoming) installment details for a credit card. The service first validates the card using the shadow card number, then fetches the list of waiting installments, including transaction details, amounts, dates, MCC info, product info, reward info, and installment attributes. Supports both current and new repository methods for fetching waiting installment details. The response is mapped to CreditCardNextPeriodInstallmentModel, and transactions can also be mapped to CreditCardDetailTransactionItem for client consumption.

Part of:

Journey 03 · Enabling additional capabilities — step 3, Track waiting installments

getWaitingInstallmentDetail › 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

getWaitingInstallmentDetail › Request Body

GetWaitingInstallmentDetailRequest

shadowCardNumber

string · required

Shadow Card Number

getWaitingInstallmentDetail › Responses

Success

CreditCardNextPeriodInstallmentModel

totalAmount

number · double · required

Total Amount

array | null

List Of Next Period Installment - [Optional]

currencyCode

string | null

Currency Code - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getWaitingInstallmentDetail

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getWaitingInstallmentDetail \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

json

application/json

Example Responses

{
  "listOfNextPeriodInstallment": [
    {
      "statementDate": "2024-08-25T15:00:00Z",
      "totalAmount": 0,
      "listOfTransaction": [
        {
          "remainingInstallAmount": 0,
          "utid": "utid",
          "authorizationNumber": "authorizationNumber",
          "panEntryMode": "panEntryMode",
          "panEntryModeDescription": "panEntryModeDescription",
          "rrn": "rrn",
          "amount": 0,
          "currencyCode": "currencyCode",
          "trnAmount": 0,
          "trnCurrencyCode": "trnCurrencyCode",
          "date": "2024-08-25T15:00:00Z",
          "description": "description",
          "earnedPoint": {
            "amount": 0,
            "rewardType": "rewardType",
            "rewardTypeDescription": "rewardTypeDescription"
          },
          "isDeferrable": true,
          "isSplittableIntoInstallments": true,
          "totalInstallmentCount": 0,
          "currentInstallmentNumber": 0,
          "trnCodeMatrixId": "trnCodeMatrixId",
          "trnCodeMatrixDescription": "trnCodeMatrixDescription",
          "shadowCardNumber": "shadowCardNumber",
          "cardRefNumber": "cardRefNumber",
          "maskedCardNumber": "maskedCardNumber",
          "mainCardRefNumber": "mainCardRefNumber",
          "cardProductVirtualFlag": true,
          "cardProductDigitalFlag": true,
          "capitalRewardIndicator": "capitalRewardIndicator",
          "mcc": "mcc",
          "mccGroupCode": "mccGroupCode",
          "mCCGroupDescription": "mCCGroupDescription",
          "mccDescription": "mccDescription",
          "trnEffect": "trnEffect",
          "channelType": "channelType",
          "channelTypeDescription": "channelTypeDescription",
          "sourceNetwork": "sourceNetwork",
          "networkTypeDescription": "networkTypeDescription",
          "supplementaryCardFlag": true,
          "bkmUniqueMerchantId": "bkmUniqueMerchantId",
          "installOrderedFlag": true,
          "orderedInstallCount": 0,
          "orderedDeferCount": 0,
          "recordId": 0,
          "earlyReleaseOrderedFlag": true,
          "statementFlag": true,
          "digitalSlipFlag": true,
          "digitalSlipValue": "digitalSlipValue",
          "currentEodDate": "2024-08-25T15:00:00Z",
          "feeAmount": 0,
          "bsmvAmount": 0,
          "kkdfAmount": 0,
          "installmentFeeAmount": 0,
          "installmentProfitAmount": 0,
          "merchantName": "merchantName",
          "merchantNumber": "merchantNumber",
          "nextStatementDate": "2024-08-25T15:00:00Z",
          "nextDueDate": "2024-08-25T15:00:00Z"
        }
      ]
    }
  ],
  "totalAmount": 0,
  "currencyCode": "currencyCode"
}

json

application/json

getWaitingInstallmentSummary

POST

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

/IntegrationDigitalChannelCredit/credit/api/getWaitingInstallmentSummary

Retrieves a summary of waiting (upcoming) installments for a credit card. The service validates the card using the shadow card number, fetches the installment summary from the repository, and aggregates amounts by statement date, including total installment amount, fees, taxes (KKDF, BSMV), profit, and capital. The result is returned as a list of WaitingInstallmentSummaryInfo within GetWaitingInstallmentSummaryResponse.

Part of:

Journey 03 · Enabling additional capabilities — step 3, Track waiting installments

getWaitingInstallmentSummary › 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

getWaitingInstallmentSummary › Request Body

GetWaitingInstallmentSummaryRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

getWaitingInstallmentSummary › Responses

Success

GetWaitingInstallmentSummaryResponse

array | null

List Waiting Installment Summary Info - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getWaitingInstallmentSummary

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getWaitingInstallmentSummary \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

json

application/json

Example Responses

{
  "listWaitingInstallmentSummaryInfo": [
    {
      "statementDate": "2024-08-25T15:00:00Z",
      "totalInstallmentAmount": 0,
      "totalInstallmentBsmvAmount": 0,
      "totalInstallmentCapitalAmount": 0,
      "totalInstallmentFeeAmount": 0,
      "totalInstallmentKkdfAmount": 0,
      "totalInstallmentProfitAmount": 0
    }
  ]
}

json

application/json

manuelInstallmentOrder

POST

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

/IntegrationDigitalChannelCredit/credit/api/manuelInstallmentOrder

Places a manual installment order for a credit card transaction. It uses the transaction management service to create an installment order based on the shadow card number, transaction ID (UTID), installment count, and deferring month count. The response includes the InstallmentOrderRecordId for tracking.

Part of:

Journey 03 · Enabling additional capabilities — step 1, Purchase conversion (EPP)

manuelInstallmentOrder › 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

manuelInstallmentOrder › Request Body

ManuelInstallmentOrderRequest

installmentCount

integer · int32

Installment Count - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

utid

string | null

Utid - [Optional]

deferringMonthCount

integer · int32

Deferring Month Count - [Optional]

channelType

string | null

Channel Type - [Optional]

manuelInstallmentOrder › Responses

Success

ManuelInstallmentOrderResponse

installmentOrderRecordId

integer · int64 · required

Installment Order Record Id

manuelInstallmentOrderSimulate

POST

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

/IntegrationDigitalChannelCredit/credit/api/manuelInstallmentOrderSimulate

Simulates a manual installment order for a credit card transaction. Returns projected installment details including installment amount, total payment amount, profit rate, and a breakdown of total PFT (Profit, BSMV, KKDF, and fees). The response includes a list of simulated installment records with installment number, capital amount, installment date, and remaining total amount.

Part of:

Journey 03 · Enabling additional capabilities — step 1, Purchase conversion (EPP)

manuelInstallmentOrderSimulate › 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

manuelInstallmentOrderSimulate › Request Body

ManuelInstallmentOrderSimulateRequest

installmentCount

integer · int32

Installment Count - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

utid

string | null

Utid - [Optional]

deferringMonthCount

integer · int32

Deferring Month Count - [Optional]

manuelInstallmentOrderSimulate › Responses

Success

ManuelInstallmentOrderSimulateResponse

installmentAmount

number · double · required

Installment Amount

profitRate

number · double · required

Profit Rate

totalPaymentAmount

number · double · required

Total Payment Amount

totalPFTAmount

number · double · required

Total P F T Amount

installmentCount

integer · int32 · required

Installment Count

deferringMonthCount

integer · int32 · required

Deferring Month Count

array | null

List Of Installment Record - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/manuelInstallmentOrderSimulate

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/manuelInstallmentOrderSimulate \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "installmentCount": 0,
  "shadowCardNumber": "shadowCardNumber",
  "utid": "utid",
  "deferringMonthCount": 0
}'

Example Request Body

{
  "installmentCount": 0,
  "shadowCardNumber": "shadowCardNumber",
  "utid": "utid",
  "deferringMonthCount": 0
}

json

application/json

Example Responses

{
  "installmentAmount": 0,
  "profitRate": 0,
  "totalPaymentAmount": 0,
  "totalPFTAmount": 0,
  "installmentCount": 0,
  "deferringMonthCount": 0,
  "listOfInstallmentRecord": [
    {
      "installmentNumber": 0,
      "installmentAmount": 0,
      "installmentDate": "2024-08-25T15:00:00Z",
      "installmentCapitalAmount": 0,
      "remainingTotalAmount": 0
    }
  ]
}

json

application/json

getInstallmentCountsByUtidNew

POST

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

/IntegrationDigitalChannelCredit/credit/api/getInstallmentCountsByUtidNew

Retrieves the installment counts and limits for a credit card transaction identified by UTID using the new DCIC logic. Returns minimum and maximum installment counts, deferring month limits, MCC-based limits, profile-based limits, and transaction details (amount, date, description). Adjusts MaxInstallmentCount and MaxDeferringMonthCount if the transaction occurs in an emergency city. Unlike the previous version, this method fetches the installment info directly from the DCIC new repository without querying the full customer transaction details.

Part of:

Journey 03 · Enabling additional capabilities — step 1, Purchase conversion (EPP)

getInstallmentCountsByUtidNew › 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

getInstallmentCountsByUtidNew › Request Body

GetInstallmentCountsByUtidRequest

Utid

string | null

Utid - [Optional]

getInstallmentCountsByUtidNew › Responses

Success

GetInstallmentCountsByUtidResponse

Amount

number · double · required

Amount

Date

string · date-time · required

Date

MinInstallmentCount

integer | null · int32

Min Installment Count - [Optional]

MaxInstallmentCount

integer | null · int32

Max Installment Count - [Optional]

MinDeferringMonthCount

integer | null · int32

Min Deferring Month Count - [Optional]

MaxDeferringMonthCount

integer | null · int32

Max Deferring Month Count - [Optional]

InstallmentCountLimit

integer | null · int32

Installment Count Limit - [Optional]

InstallmentCountMccGroupLimit

integer | null · int32

Installment Count Mcc Group Limit - [Optional]

InstallmentCountMccLimit

integer | null · int32

Installment Count Mcc Limit - [Optional]

InstallmentProfileDeferringLimit

integer | null · int32

Installment Profile Deferring Limit - [Optional]

InstallmentProfileInstallmentLimit

integer | null · int32

Installment Profile Installment Limit - [Optional]

MccDefinitionInstallmentLimit

integer | null · int32

Mcc Definition Installment Limit - [Optional]

Description

string | null

Description - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getInstallmentCountsByUtidNew

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getInstallmentCountsByUtidNew \
  --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

{
  "MinInstallmentCount": 0,
  "MaxInstallmentCount": 0,
  "MinDeferringMonthCount": 0,
  "MaxDeferringMonthCount": 0,
  "InstallmentCountLimit": 0,
  "InstallmentCountMccGroupLimit": 0,
  "InstallmentCountMccLimit": 0,
  "InstallmentProfileDeferringLimit": 0,
  "InstallmentProfileInstallmentLimit": 0,
  "MccDefinitionInstallmentLimit": 0,
  "Amount": 0,
  "Date": "2024-08-25T15:00:00Z",
  "Description": "Description"
}

json

application/json

cancelInstallmentEarlyRelease

POST

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

/IntegrationDigitalChannelCredit/credit/api/cancelInstallmentEarlyRelease

Cancels an early release of an installment for a given card identified by ShadowCardNumber and UTID. Returns the number of affected rows as EffectedRowCount.

cancelInstallmentEarlyRelease › 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

cancelInstallmentEarlyRelease › Request Body

CancelInstallmentEarlyReleaseRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

utid

string | null

Utid - [Optional]

cancelInstallmentEarlyRelease › Responses

Success

CancelInstallmentEarlyReleaseResponse

effectedRowCount

integer · int32 · required

Effected Row Count

getManuelInstallmentCancelRecordsByCardRefNumber

POST

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

/IntegrationDigitalChannelCredit/credit/api/getManuelInstallmentCancelRecordsByCardRefNumber

Retrieves the manual installment cancellation records for a given card reference number or shadow card number. Returns details such as installment count, amount, deferring month, fee and profit amounts, transaction source, merchant, processing flags, and relevant dates. Throws an error if both CardRefNumber and ShadowCardNumber are null. This method helps track manually canceled installments for credit card transactions.

getManuelInstallmentCancelRecordsByCardRefNumber › 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

getManuelInstallmentCancelRecordsByCardRefNumber › Request Body

GetManuelInstallmentCancelRecordsByCardRefNumberRequest

cardRefNumber

string | null

Card Ref Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

getManuelInstallmentCancelRecordsByCardRefNumber › Responses

Success

GetManuelInstallmentCancelRecordsByCardRefNumberResponse

array | null

Manuel Installment Cancel Records - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getManuelInstallmentCancelRecordsByCardRefNumber

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getManuelInstallmentCancelRecordsByCardRefNumber \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "cardRefNumber": "cardRefNumber",
  "shadowCardNumber": "shadowCardNumber"
}'

Example Request Body

{
  "cardRefNumber": "cardRefNumber",
  "shadowCardNumber": "shadowCardNumber"
}

json

application/json

Example Responses

{
  "manuelInstallmentCancelRecords": [
    {
      "CardRefNumber": "CardRefNumber",
      "Channel": "002",
      "DeferringDate": "2024-08-25T15:00:00Z",
      "DeferringMonth": 0,
      "FeeRate": 0,
      "FixedFeeAmount": 0,
      "InsertUserId": "InsertUserId",
      "InstallmentAmount": 0,
      "InstallmentCode": "InstallmentCode",
      "InstallmentCount": 0,
      "InstallmentProfitRate": 0,
      "InstallmentPriority": 0,
      "InstallmentProfitAmount": 0,
      "MaskedCardNumber": "MaskedCardNumber",
      "MerchantName": "MerchantName",
      "ProcessedDate": "2024-08-25T15:00:00Z",
      "ProcessedFlag": true,
      "RecordId": 0,
      "InstallmentTaxAmount": 0,
      "TrnAmount": 0,
      "TrnDate": "2024-08-25T15:00:00Z",
      "TrnSource": 0,
      "ValidFlag": true,
      "Utid": "Utid",
      "InstallmentOrderDate": "2024-08-25T15:00:00Z",
      "ShadowCardNumber": "ShadowCardNumber",
      "SupplementaryCardFlag": true
    }
  ]
}

json

application/json

getEarlyReleaseAvailableInstallmentsByCriterias

POST

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

/IntegrationDigitalChannelCredit/credit/api/getEarlyReleaseAvailableInstallmentsByCriterias

Retrieves available installments for early release based on criteria such as CardRefNumber, MainCardRefNumber, or ShadowCardNumber. Returns detailed installment information including remaining principal, fees, profit, taxes, installment counts, transaction details, merchant information, and totals. Supports subsequent simulation and release of early installments.

Part of:

Journey 03 · Enabling additional capabilities — step 4, Early settlement

getEarlyReleaseAvailableInstallmentsByCriterias › 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

getEarlyReleaseAvailableInstallmentsByCriterias › Request Body

GetEarlyReleaseAvailableInstallmentsByCriteriasRequest

cardRefNumber

string | null

Card Ref Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

getEarlyReleaseAvailableInstallmentsByCriterias › Responses

Success

GetEarlyReleaseAvailableInstallmentsByCriteriasResponse

array | null

Installment Early Release Rows - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getEarlyReleaseAvailableInstallmentsByCriterias

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getEarlyReleaseAvailableInstallmentsByCriterias \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "cardRefNumber": "cardRefNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "shadowCardNumber": "shadowCardNumber"
}'

Example Request Body

{
  "cardRefNumber": "cardRefNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "shadowCardNumber": "shadowCardNumber"
}

json

application/json

Example Responses

{
  "InstallmentEarlyReleaseRows": [
    {
      "AuthorizationNumber": "AuthorizationNumber",
      "DeferringDay": 0,
      "DeferringFlag": true,
      "InstallmentCapitalAmount": 0,
      "InstallmentCount": 0,
      "InstallmentFeeAmount": 0,
      "InstallmentProfitAmount": 0,
      "InstallmentTax1Amount": 0,
      "InstallmentTax2Amount": 0,
      "MaskedCardNumber": "MaskedCardNumber",
      "MerchantName": "MerchantName",
      "RemainingCapitalAmount": 0,
      "RemainingFeeAmount": 0,
      "RemainingInstallmentAmount": 0,
      "RemainingInstallmentCount": 0,
      "RemainingInstallmentProfitAmount": 0,
      "RemainingInstallmentBsmvAmount": 0,
      "RemainingTax": 0,
      "Tax": 0,
      "RemainingInstallmentKkdfAmount": 0,
      "ShadowCardNumber": "ShadowCardNumber",
      "TotalCapitalAmount": 0,
      "TotalInstallmentAmount": 0,
      "TotalInstallmentProfitAmount": 0,
      "TotalInstallmentBsmvAmount": 0,
      "TotalInstallmentKkdfAmount": 0,
      "TotalFeeAmount": 0,
      "TrnDate": "2024-08-25T15:00:00Z",
      "TrnDescription": "TrnDescription",
      "TrnInstallmentType": "TrnInstallmentType",
      "Utid": "Utid",
      "RemainingTaxAndFeeAmount": 0,
      "TotalTaxAndFeeAmount": 0,
      "CurrentTaxAndFeeAmount": 0,
      "DeferringBsmvAmount": 0,
      "DeferringProfitAmount": 0,
      "DeferringKkdfAmount": 0,
      "TotalDeferringBsmvAmount": 0,
      "TotalDeferringProfitAmount": 0,
      "TotalDeferringKkdfAmount": 0,
      "RemainingDeferringBsmvAmount": 0,
      "RemainingDeferringProfitAmount": 0,
      "RemainingDeferringKkdfAmount": 0
    }
  ]
}

json

application/json

simulateInstallmentEarlyRelease

POST

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

/IntegrationDigitalChannelCredit/credit/api/simulateInstallmentEarlyRelease

Simulates the early release of an installment, providing details of the remaining balance, canceled fees and profit, early payment amount, and the total installment count.

Part of:

Journey 03 · Enabling additional capabilities — step 4, Early settlement

simulateInstallmentEarlyRelease › 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

simulateInstallmentEarlyRelease › Request Body

SimulateInstallmentEarlyReleaseRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

utid

string | null

Utid - [Optional]

simulateInstallmentEarlyRelease › Responses

Success

SimulateInstallmentEarlyReleaseResponse

CanceledFeeAndProfitAmount

number · double · required

Canceled Fee And Profit Amount

ProfitAmount

number · double · required

Profit Amount

FeeAmount

number · double · required

Fee Amount

EarlyReleaseDeferringAmount

number · double · required

Early Release Deferring Amount

TrnDate

string · date-time · required

Trn Date

EarlyPaymentAmount

number · double · required

Early Payment Amount

RemainingInstallmentCount

integer · int32 · required

Remaining Installment Count

TotalInstallmentCount

integer · int32 · required

Total Installment Count

AmountOfRemainingInstallment

number · double · required

Amount Of Remaining Installment

SummaryRecordId

integer · int64 · required

Summary Record Id

CanceledProfitAmount

number · double · required

Canceled Profit Amount

CanceledKkdfAmount

number · double · required

Canceled Kkdf Amount

CanceledBsmvAmount

number · double · required

Canceled Bsmv Amount

CanceledFeeAmount

number · double · required

Canceled Fee Amount

POST/IntegrationDigitalChannelCredit/credit/api/simulateInstallmentEarlyRelease

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/simulateInstallmentEarlyRelease \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "shadowCardNumber": "shadowCardNumber",
  "utid": "utid"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber",
  "utid": "utid"
}

json

application/json

Example Responses

{
  "CanceledFeeAndProfitAmount": 0,
  "ProfitAmount": 0,
  "FeeAmount": 0,
  "EarlyReleaseDeferringAmount": 0,
  "TrnDate": "2024-08-25T15:00:00Z",
  "EarlyPaymentAmount": 0,
  "RemainingInstallmentCount": 0,
  "TotalInstallmentCount": 0,
  "AmountOfRemainingInstallment": 0,
  "SummaryRecordId": 0,
  "CanceledProfitAmount": 0,
  "CanceledKkdfAmount": 0,
  "CanceledBsmvAmount": 0,
  "CanceledFeeAmount": 0
}

json

application/json

releasePendingInstallment

POST

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

/IntegrationDigitalChannelCredit/credit/api/releasePendingInstallment

Releases a pending installment for a credit card transaction. Accepts a UTID, early release type, and fee amount, and invokes the transaction management service to process the early release. Returns the ER log record ID and the associated ShadowCardNumber.

Part of:

Journey 03 · Enabling additional capabilities — step 4, Early settlement

releasePendingInstallment › 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

releasePendingInstallment › Request Body

ReleasePendingInstallmentRequest

utid

string | null

Utid - [Optional]

feeAmount

number · double

Fee Amount - [Optional]

earlyReleaseType

integer · int32

Early Release Type - [Optional]

releasePendingInstallment › Responses

Success

ReleasePendingInstallmentResponse

erLogRecordId

integer · int64 · required

Er Log Record Id

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cancelInstallmentTransactionOrder

POST

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

/IntegrationDigitalChannelCredit/credit/api/cancelInstallmentTransactionOrder

Cancels an existing installment transaction order identified by RecordId. Returns InstallmentOrderRecordId and Success flag indicating whether the cancellation succeeded.

Part of:

Journey 03 · Enabling additional capabilities — step 1, Purchase conversion (EPP)

cancelInstallmentTransactionOrder › 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

cancelInstallmentTransactionOrder › Request Body

CancelInstallmentTransactionOrderRequest

recordId

integer · int64

Record Id - [Optional]

cancelInstallmentTransactionOrder › Responses

Success

CancelInstallmentTransactionOrderResponse

installmentOrderRecordId

integer · int64 · required

Installment Order Record Id

success

boolean · required

Success

Permissions and restrictions Collections and legal follow-up