Cash advance

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

Cash advance calculation service

POST

https://devcard.sim-ant.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

Cash advance calculation service › Request Body

GetCashAdvanceInfoRequest

cashAdvanceAmount

number · double · required

Cash Advance Amount - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

accountNumber

string | null

Account Number - [Optional]

channelId

string | null

Channel Id - [Optional]

Cash advance calculation service › Responses

Success

GetCashAdvanceInfoResponse

isSuccess

boolean · required

Is Success - [Optional]

cashAdvanceFeeAmount

number · double · required

Cash Advance Fee Amount - [Optional]

cashAdvanceInterestRate

number · double · required

Cash Advance Interest Rate - [Optional]

cashAdvanceAmount

number · double · required

Cash Advance Amount - [Optional]

totalAmount

number · double · required

Total Amount - [Optional]

calculateCashProfit

number · double · required

Calculate Cash Profit - [Optional]

calculatedTotalAmount

number · double · required

Calculated Total Amount - [Optional]

authCode

string | null

Auth Code - [Optional]

responseCode

string | null

Response Code - [Optional]

responseReasonCode

string | null

Response Reason Code - [Optional]

POST/credit/api/getCashAdvanceInfo

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCashAdvanceInfo \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "shadowCardNumber": "shadowCardNumber",
  "accountNumber": "accountNumber",
  "cashAdvanceAmount": 0,
  "channelId": "channelId"
}'

Example Request Body

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

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

Cash advance service

POST

https://devcard.sim-ant.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

Cash advance service › Request Body

DoCashAdvanceRequest

cashAdvanceAmount

number · double · required

Cash Advance Amount - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

accountNumber

string | null

Account Number - [Optional]

referenceNumber

string | null

Reference Number - [Optional]

channelId

string | null

Channel Id - [Optional]

Cash advance service › Responses

Success

DoCashAdvanceResponse

isSuccess

boolean · required

Is Success - [Optional]

feeAmount

number · double · required

Fee Amount - [Optional]

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/credit/api/doCashAdvance

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/doCashAdvance \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "shadowCardNumber": "shadowCardNumber",
  "accountNumber": "accountNumber",
  "referenceNumber": "referenceNumber",
  "cashAdvanceAmount": 0,
  "channelId": "channelId"
}'

Example Request Body

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

json

Example Responses

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

json

application/json

Service that cancels a cash-advance transaction

POST

https://devcard.sim-ant.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

Service that cancels a cash-advance transaction › Request Body

ReverseCashAdvanceRequest

amount

number · double · required

Amount - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

uTID

string | null

U T I D - [Optional]

referenceNumber

string | null

Reference Number - [Optional]

Service that cancels a cash-advance transaction › Responses

Success

ReverseCashAdvanceResponse

isSuccess

boolean · required

Is Success - [Optional]

uTID

string | null

U T I D - [Optional]

authCode

string | null

Auth Code - [Optional]

responseReasonCode

string | null

Response Reason Code - [Optional]

Service that lists cash advances eligible for cancellation

POST

https://devcard.sim-ant.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

Service that lists cash advances eligible for cancellation › Request Body

GetCancelableCashAdvanceListRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

Service that lists cash advances eligible for cancellation › Responses

Success

GetCancelableCashAdvanceListResponse

array | null

List Of Cash Advance - [Optional]

POST/credit/api/getCancelableCashAdvanceList

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCancelableCashAdvanceList \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "shadowCardNumber": "shadowCardNumber"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

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.

Cash advance calculation service

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/getCashAdvanceInfo

Part of:

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

Cash advance calculation service › Request Body

GetCashAdvanceInfoRequest

cashAdvanceAmount

number · double · required

Cash Advance Amount - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

accountNumber

string | null

Account Number - [Optional]

channelId

string | null

Channel Id - [Optional]

Cash advance calculation service › Responses

Success

GetCashAdvanceInfoResponse

isSuccess

boolean · required

Is Success - [Optional]

cashAdvanceFeeAmount

number · double · required

Cash Advance Fee Amount - [Optional]

cashAdvanceInterestRate

number · double · required

Cash Advance Interest Rate - [Optional]

cashAdvanceAmount

number · double · required

Cash Advance Amount - [Optional]

totalAmount

number · double · required

Total Amount - [Optional]

calculateCashProfit

number · double · required

Calculate Cash Profit - [Optional]

calculatedTotalAmount

number · double · required

Calculated Total Amount - [Optional]

authCode

string | null

Auth Code - [Optional]

responseCode

string | null

Response Code - [Optional]

responseReasonCode

string | null

Response Reason Code - [Optional]

POST/credit/api/getCashAdvanceInfo

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCashAdvanceInfo \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "shadowCardNumber": "shadowCardNumber",
  "accountNumber": "accountNumber",
  "cashAdvanceAmount": 0,
  "channelId": "channelId"
}'

Example Request Body

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

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

Cash advance service

POST

https://devcard.sim-ant.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

Cash advance service › Request Body

DoCashAdvanceRequest

cashAdvanceAmount

number · double · required

Cash Advance Amount - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

accountNumber

string | null

Account Number - [Optional]

referenceNumber

string | null

Reference Number - [Optional]

channelId

string | null

Channel Id - [Optional]

Cash advance service › Responses

Success

DoCashAdvanceResponse

isSuccess

boolean · required

Is Success - [Optional]

feeAmount

number · double · required

Fee Amount - [Optional]

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/credit/api/doCashAdvance

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/doCashAdvance \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "shadowCardNumber": "shadowCardNumber",
  "accountNumber": "accountNumber",
  "referenceNumber": "referenceNumber",
  "cashAdvanceAmount": 0,
  "channelId": "channelId"
}'

Example Request Body

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

json

Example Responses

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

json

application/json

Service that cancels a cash-advance transaction

POST

https://devcard.sim-ant.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

Service that cancels a cash-advance transaction › Request Body

ReverseCashAdvanceRequest

amount

number · double · required

Amount - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

uTID

string | null

U T I D - [Optional]

referenceNumber

string | null

Reference Number - [Optional]

Service that cancels a cash-advance transaction › Responses

Success

ReverseCashAdvanceResponse

isSuccess

boolean · required

Is Success - [Optional]

uTID

string | null

U T I D - [Optional]

authCode

string | null

Auth Code - [Optional]

responseReasonCode

string | null

Response Reason Code - [Optional]

Service that lists cash advances eligible for cancellation

POST

https://devcard.sim-ant.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

Service that lists cash advances eligible for cancellation › Request Body

GetCancelableCashAdvanceListRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

Service that lists cash advances eligible for cancellation › Responses

Success

GetCancelableCashAdvanceListResponse

array | null

List Of Cash Advance - [Optional]

POST/credit/api/getCancelableCashAdvanceList

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCancelableCashAdvanceList \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "shadowCardNumber": "shadowCardNumber"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

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