Cash advance

Draw cash against a credit line, and cancel an advance before it settles.

getCashAdvanceInfo

POST

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

/IntegrationDigitalChannelCredit/credit/api/getCashAdvanceInfo

Provides information about a cash advance request for a given account or shadow card. Returns the authorized code, success flag, response codes, requested cash advance amount, applicable fee, interest rate, total amount, and calculated cash profit and total amount based on the current period.

Part of:

Journey 02 · Managing a card product — step 2, Cash advance

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

getCashAdvanceInfo › Request Body

GetCashAdvanceInfoRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

accountNumber

string | null

Account Number - [Optional]

cashAdvanceAmount

number · double

Cash Advance 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

getCashAdvanceInfo › Responses

Success

GetCashAdvanceInfoResponse

isSuccess

boolean · required

Is Success

cashAdvanceFeeAmount

number · double · required

Cash Advance Fee Amount

cashAdvanceInterestRate

number · double · required

Cash Advance Interest Rate

cashAdvanceAmount

number · double · required

Cash Advance Amount

totalAmount

number · double · required

Total Amount

calculateCashProfit

number · double · required

Calculate Cash Profit

calculatedTotalAmount

number · double · required

Calculated Total Amount

authCode

string | null

Auth Code - [Optional]

responseCode

string | null

Response Code - [Optional]

responseReasonCode

string | null

Response Reason Code - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCashAdvanceInfo

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

Example Request Body

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

json

application/json

Example Responses

{
  "authCode": "authCode",
  "responseCode": "responseCode",
  "responseReasonCode": "responseReasonCode",
  "isSuccess": true,
  "cashAdvanceFeeAmount": 0,
  "cashAdvanceInterestRate": 0,
  "cashAdvanceAmount": 0,
  "totalAmount": 0,
  "calculateCashProfit": 0,
  "calculatedTotalAmount": 0
}

json

application/json

doCashAdvance

POST

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

/IntegrationDigitalChannelCredit/credit/api/doCashAdvance

Performs a cash advance for the given account and shadow card. Returns authorization code, response codes, transaction ID, fee, and RRN. Throws exception if the transaction fails.

Part of:

Journey 02 · Managing a card product — step 2, Cash advance

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

doCashAdvance › Request Body

DoCashAdvanceRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

accountNumber

string | null

Account Number - [Optional]

referenceNumber

string | null

Reference Number - [Optional]

cashAdvanceAmount

number · double

Cash Advance 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

doCashAdvance › Responses

Success

DoCashAdvanceResponse

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]

rrn

string | null

Rrn - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/doCashAdvance

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

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber",
  "accountNumber": "accountNumber",
  "referenceNumber": "referenceNumber",
  "cashAdvanceAmount": 0,
  "channelId": "002"
}

json

application/json

Example Responses

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

json

application/json

reverseCashAdvance

POST

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

/IntegrationDigitalChannelCredit/credit/api/reverseCashAdvance

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

Part of:

Journey 02 · Managing a card product — step 4, Reversals

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

reverseCashAdvance › Request Body

ReverseCashAdvanceRequest

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]

reverseCashAdvance › Responses

Success

ReverseCashAdvanceResponse

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]

getCancelableCashAdvanceList

POST

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

/IntegrationDigitalChannelCredit/credit/api/getCancelableCashAdvanceList

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

Part of:

Journey 02 · Managing a card product — step 2, Cash advance

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

getCancelableCashAdvanceList › Request Body

GetCancelableCashAdvanceListRequest

shadowCardNumber

string · required

Shadow Card Number

getCancelableCashAdvanceList › Responses

Success

GetCancelableCashAdvanceListResponse

array | null

List Of Cash Advance - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCancelableCashAdvanceList

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

{
  "listOfCashAdvance": [
    {
      "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

Account linking Transactions

Credit Digital Channels Integration

Cash advance

Draw cash against a credit line, and cancel an advance before it settles.

getCashAdvanceInfo

POST

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

/IntegrationDigitalChannelCredit/credit/api/getCashAdvanceInfo

Part of:

Journey 02 · Managing a card product — step 2, Cash advance

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

getCashAdvanceInfo › Request Body

GetCashAdvanceInfoRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

accountNumber

string | null

Account Number - [Optional]

cashAdvanceAmount

number · double

Cash Advance 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

getCashAdvanceInfo › Responses

Success

GetCashAdvanceInfoResponse

isSuccess

boolean · required

Is Success

cashAdvanceFeeAmount

number · double · required

Cash Advance Fee Amount

cashAdvanceInterestRate

number · double · required

Cash Advance Interest Rate

cashAdvanceAmount

number · double · required

Cash Advance Amount

totalAmount

number · double · required

Total Amount

calculateCashProfit

number · double · required

Calculate Cash Profit

calculatedTotalAmount

number · double · required

Calculated Total Amount

authCode

string | null

Auth Code - [Optional]

responseCode

string | null

Response Code - [Optional]

responseReasonCode

string | null

Response Reason Code - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCashAdvanceInfo

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

Example Request Body

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

json

application/json

Example Responses

{
  "authCode": "authCode",
  "responseCode": "responseCode",
  "responseReasonCode": "responseReasonCode",
  "isSuccess": true,
  "cashAdvanceFeeAmount": 0,
  "cashAdvanceInterestRate": 0,
  "cashAdvanceAmount": 0,
  "totalAmount": 0,
  "calculateCashProfit": 0,
  "calculatedTotalAmount": 0
}

json

application/json

doCashAdvance

POST

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

/IntegrationDigitalChannelCredit/credit/api/doCashAdvance

Performs a cash advance for the given account and shadow card. Returns authorization code, response codes, transaction ID, fee, and RRN. Throws exception if the transaction fails.

Part of:

Journey 02 · Managing a card product — step 2, Cash advance

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

doCashAdvance › Request Body

DoCashAdvanceRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

accountNumber

string | null

Account Number - [Optional]

referenceNumber

string | null

Reference Number - [Optional]

cashAdvanceAmount

number · double

Cash Advance 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

doCashAdvance › Responses

Success

DoCashAdvanceResponse

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]

rrn

string | null

Rrn - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/doCashAdvance

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

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber",
  "accountNumber": "accountNumber",
  "referenceNumber": "referenceNumber",
  "cashAdvanceAmount": 0,
  "channelId": "002"
}

json

application/json

Example Responses

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

json

application/json

reverseCashAdvance

POST

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

/IntegrationDigitalChannelCredit/credit/api/reverseCashAdvance

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

Part of:

Journey 02 · Managing a card product — step 4, Reversals

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

reverseCashAdvance › Request Body

ReverseCashAdvanceRequest

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]

reverseCashAdvance › Responses

Success

ReverseCashAdvanceResponse

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]

getCancelableCashAdvanceList

POST

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

/IntegrationDigitalChannelCredit/credit/api/getCancelableCashAdvanceList

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

Part of:

Journey 02 · Managing a card product — step 2, Cash advance

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

getCancelableCashAdvanceList › Request Body

GetCancelableCashAdvanceListRequest

shadowCardNumber

string · required

Shadow Card Number

getCancelableCashAdvanceList › Responses

Success

GetCancelableCashAdvanceListResponse

array | null

List Of Cash Advance - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCancelableCashAdvanceList

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

{
  "listOfCashAdvance": [
    {
      "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

Account linking Transactions