Debt payment

Take a payment against card debt, check a card is eligible to be paid down, and cancel a payment that should not have run.

Service that checks the existence of a credit card for debt payment

POST

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

/credit/api/checkCreditCardForDebtPayment

Checks whether a credit card is eligible for debt payment. Validates PAN, card type, domestic BIN, and supplementary status. Returns masked card info, processor BIN, bank code, bank name, and flags indicating if the card is supplementary or Ripper.

Part of:

Journey 02 · Managing a card product — step 2, Take a payment

Service that checks the existence of a credit card for debt payment › Request Body

CheckCreditCardForDebtPaymentRequest

pan

string | null

Pan - [Optional]

channelCode

string | null

Channel Code - [Optional]

Service that checks the existence of a credit card for debt payment › Responses

Success

CheckCreditCardForDebtPaymentResponse

isRipper

boolean · required

Is Ripper - [Optional]

result

string | null

Result - [Optional]

errorCode

string | null

Error Code - [Optional]

errorMessage

string | null

Error Message - [Optional]

errorService

string | null

Error Service - [Optional]

processorBin

string | null

Processor Bin - [Optional]

bankCode

string | null

Bank Code - [Optional]

bankName

string | null

Bank Name - [Optional]

isSuplemantary

boolean | null

Is Suplemantary - [Optional]

object

Card Info - [Optional]

POST/credit/api/checkCreditCardForDebtPayment

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

Example Request Body

{
  "pan": "pan",
  "channelCode": "channelCode"
}

json

Example Responses

{
  "result": "result",
  "errorCode": "errorCode",
  "errorMessage": "errorMessage",
  "errorService": "errorService",
  "processorBin": "processorBin",
  "bankCode": "bankCode",
  "bankName": "bankName",
  "isSuplemantary": true,
  "isRipper": true,
  "cardInfo": {
    "maskedCustomerName": "maskedCustomerName",
    "shadowCardNumber": "shadowCardNumber",
    "tenantId": "tenantId"
  }
}

json

application/json

Card payment service

POST

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

/credit/api/doCreditCardDebtPayment

Performs a credit card debt payment. Determines transaction code based on channel and resource code. Returns UTID, transaction ID, authorization number, and RRN.

Part of:

Journey 02 · Managing a card product — step 2, Take a payment

Card payment service › Request Body

DoCreditCardDebtPaymentRequest

accountNumber

integer · int32 · required

Account Number - [Optional]

amount

number · double · required

Amount - [Optional]

clientReferenceNumber

integer · int64 · required

Client Reference Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

clearCardNumber

string | null

Clear Card Number - [Optional]

description

string | null

Description - [Optional]

resourceCode

string | null

Resource Code - [Optional]

channel

string | null

Channel - [Optional]

currencyCode

string | null

Currency Code - [Optional]

earlyReleaseLogFlag

boolean | null

Early Release Log Flag - [Optional]

Card payment service › Responses

Success

DoCreditCardDebtPaymentResponse

trnId

integer · int64 · required

Trn Id - [Optional]

utid

string | null

Utid - [Optional]

rrn

string | null

Rrn - [Optional]

authorizationNumber

string | null

Authorization Number - [Optional]

POST/credit/api/doCreditCardDebtPayment

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/doCreditCardDebtPayment \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "accountNumber": 0,
  "amount": 0,
  "clientReferenceNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "clearCardNumber": "clearCardNumber",
  "description": "description",
  "resourceCode": "resourceCode",
  "channel": "channel",
  "currencyCode": "currencyCode",
  "earlyReleaseLogFlag": true
}'

Example Request Body

{
  "accountNumber": 0,
  "amount": 0,
  "clientReferenceNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "clearCardNumber": "clearCardNumber",
  "description": "description",
  "resourceCode": "resourceCode",
  "channel": "channel",
  "currencyCode": "currencyCode",
  "earlyReleaseLogFlag": true
}

json

Example Responses

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

json

application/json

Credit card payment reversal service

POST

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

/credit/api/cancelCreditCardDebtPayment

Cancels a credit card debt payment by calling the transaction management service with transaction ID, amount, currency, card reference, and related identifiers. Also includes methods to retrieve cancelable credit card payments for a shadow card and cancel early release of installment payments.

Part of:

Journey 02 · Managing a card product — step 2, Take a payment

Credit card payment reversal service › Request Body

CancelCreditCardDebtPaymentRequest

clientReferenceNumber

integer · int64 · required

Client Reference Number - [Optional]

trnId

integer | null · int64

Trn Id - [Optional]

amount

number | null · double

Amount - [Optional]

currencyCode

string | null

Currency Code - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

mainCustomerNumber

integer | null · int64

Main Customer Number - [Optional]

trnDate

string | null · date-time

Trn Date - [Optional]

channel

string | null

Channel - [Optional]

Credit card payment reversal service › Responses

Success

CancelCreditCardDebtPaymentResponse

trnId

integer · int64 · required

Trn Id - [Optional]

POST/credit/api/cancelCreditCardDebtPayment

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/cancelCreditCardDebtPayment \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "trnId": 0,
  "amount": 0,
  "currencyCode": "currencyCode",
  "clientReferenceNumber": 0,
  "cardRefNumber": "cardRefNumber",
  "mainCustomerNumber": 0,
  "trnDate": "2024-08-25T15:00:00Z",
  "channel": "channel"
}'

Example Request Body

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

json

Example Responses

{
  "trnId": 0
}

json

application/json

Service that lists payments eligible for reversal

POST

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

/credit/api/getCancelableCreditCardDebtPaymentList

Retrieves a list of cancellable credit card debt payments for a given shadow card number, including transaction details and related card/customer information.

Service that lists payments eligible for reversal › Request Body

GetCancelableCreditCardDebtPaymentListRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

Service that lists payments eligible for reversal › Responses

Success

GetCancelableCreditCardDebtPaymentListResponse

array | null

List Of Payment - [Optional]

POST/credit/api/getCancelableCreditCardDebtPaymentList

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

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

json

Example Responses

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

json

application/json

Service that captures Automatic Payment Instructions for credit cards

POST

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

/credit/api/saveCreditCardAutoPaymentOrder

Saves the credit card auto-payment order with specified payment type, account number, and account owner name.

Service that captures Automatic Payment Instructions for credit cards › Request Body

SaveCreditCardAutoPaymentOrderRequest

accountNumber

integer · int32 · required

Account Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

accountOwnerName

string | null

Account Owner Name - [Optional]

paymentType

string | null

Payment Type - [Optional]

Service that captures Automatic Payment Instructions for credit cards › Responses

Success

SaveCreditCardAutoPaymentOrderResponse

Service that displays auto-payment account information for a given card

POST

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

/credit/api/getCreditCardAutoPaymentOrder

Retrieves the auto-payment order details for a credit card. The method accepts MainCustomerNumber, MainCardRefNumber, or ShadowCardNumber. Returns a list of auto-payment orders including payment account, owner name, payment type, and associated card information.

Service that displays auto-payment account information for a given card › Request Body

GetCreditCardAutoPaymentOrderRequest

mainCustomerNumber

integer · int64 · required

Main Customer Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

Service that displays auto-payment account information for a given card › Responses

Success

GetCreditCardAutoPaymentOrderResponse

array | null

List Of Records - [Optional]

POST/credit/api/getCreditCardAutoPaymentOrder

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

Example Request Body

{
  "mainCustomerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "shadowCardNumber": "shadowCardNumber"
}

json

Example Responses

{
  "listOfRecords": [
    {
      "paymentAccountNumber": 0,
      "paymentAccountOwnerName": "paymentAccountOwnerName",
      "mainCardRefNumber": "mainCardRefNumber",
      "shadowCardNumber": "shadowCardNumber",
      "paymentType": "paymentType",
      "mainCustomerNumber": 0,
      "maskedCardNumber": "maskedCardNumber"
    }
  ]
}

json

application/json

Collections and legal follow-up Statements and billing

Credit Digital Channels Integration

Debt payment

Take a payment against card debt, check a card is eligible to be paid down, and cancel a payment that should not have run.

Service that checks the existence of a credit card for debt payment

POST

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

/credit/api/checkCreditCardForDebtPayment

Part of:

Journey 02 · Managing a card product — step 2, Take a payment

Service that checks the existence of a credit card for debt payment › Request Body

CheckCreditCardForDebtPaymentRequest

pan

string | null

Pan - [Optional]

channelCode

string | null

Channel Code - [Optional]

Service that checks the existence of a credit card for debt payment › Responses

Success

CheckCreditCardForDebtPaymentResponse

isRipper

boolean · required

Is Ripper - [Optional]

result

string | null

Result - [Optional]

errorCode

string | null

Error Code - [Optional]

errorMessage

string | null

Error Message - [Optional]

errorService

string | null

Error Service - [Optional]

processorBin

string | null

Processor Bin - [Optional]

bankCode

string | null

Bank Code - [Optional]

bankName

string | null

Bank Name - [Optional]

isSuplemantary

boolean | null

Is Suplemantary - [Optional]

object

Card Info - [Optional]

POST/credit/api/checkCreditCardForDebtPayment

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

Example Request Body

{
  "pan": "pan",
  "channelCode": "channelCode"
}

json

Example Responses

{
  "result": "result",
  "errorCode": "errorCode",
  "errorMessage": "errorMessage",
  "errorService": "errorService",
  "processorBin": "processorBin",
  "bankCode": "bankCode",
  "bankName": "bankName",
  "isSuplemantary": true,
  "isRipper": true,
  "cardInfo": {
    "maskedCustomerName": "maskedCustomerName",
    "shadowCardNumber": "shadowCardNumber",
    "tenantId": "tenantId"
  }
}

json

application/json

Card payment service

POST

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

/credit/api/doCreditCardDebtPayment

Performs a credit card debt payment. Determines transaction code based on channel and resource code. Returns UTID, transaction ID, authorization number, and RRN.

Part of:

Journey 02 · Managing a card product — step 2, Take a payment

Card payment service › Request Body

DoCreditCardDebtPaymentRequest

accountNumber

integer · int32 · required

Account Number - [Optional]

amount

number · double · required

Amount - [Optional]

clientReferenceNumber

integer · int64 · required

Client Reference Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

clearCardNumber

string | null

Clear Card Number - [Optional]

description

string | null

Description - [Optional]

resourceCode

string | null

Resource Code - [Optional]

channel

string | null

Channel - [Optional]

currencyCode

string | null

Currency Code - [Optional]

earlyReleaseLogFlag

boolean | null

Early Release Log Flag - [Optional]

Card payment service › Responses

Success

DoCreditCardDebtPaymentResponse

trnId

integer · int64 · required

Trn Id - [Optional]

utid

string | null

Utid - [Optional]

rrn

string | null

Rrn - [Optional]

authorizationNumber

string | null

Authorization Number - [Optional]

POST/credit/api/doCreditCardDebtPayment

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/doCreditCardDebtPayment \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "accountNumber": 0,
  "amount": 0,
  "clientReferenceNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "clearCardNumber": "clearCardNumber",
  "description": "description",
  "resourceCode": "resourceCode",
  "channel": "channel",
  "currencyCode": "currencyCode",
  "earlyReleaseLogFlag": true
}'

Example Request Body

{
  "accountNumber": 0,
  "amount": 0,
  "clientReferenceNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "clearCardNumber": "clearCardNumber",
  "description": "description",
  "resourceCode": "resourceCode",
  "channel": "channel",
  "currencyCode": "currencyCode",
  "earlyReleaseLogFlag": true
}

json

Example Responses

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

json

application/json

Credit card payment reversal service

POST

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

/credit/api/cancelCreditCardDebtPayment

Part of:

Journey 02 · Managing a card product — step 2, Take a payment

Credit card payment reversal service › Request Body

CancelCreditCardDebtPaymentRequest

clientReferenceNumber

integer · int64 · required

Client Reference Number - [Optional]

trnId

integer | null · int64

Trn Id - [Optional]

amount

number | null · double

Amount - [Optional]

currencyCode

string | null

Currency Code - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

mainCustomerNumber

integer | null · int64

Main Customer Number - [Optional]

trnDate

string | null · date-time

Trn Date - [Optional]

channel

string | null

Channel - [Optional]

Credit card payment reversal service › Responses

Success

CancelCreditCardDebtPaymentResponse

trnId

integer · int64 · required

Trn Id - [Optional]

POST/credit/api/cancelCreditCardDebtPayment

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/cancelCreditCardDebtPayment \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "trnId": 0,
  "amount": 0,
  "currencyCode": "currencyCode",
  "clientReferenceNumber": 0,
  "cardRefNumber": "cardRefNumber",
  "mainCustomerNumber": 0,
  "trnDate": "2024-08-25T15:00:00Z",
  "channel": "channel"
}'

Example Request Body

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

json

Example Responses

{
  "trnId": 0
}

json

application/json

Service that lists payments eligible for reversal

POST

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

/credit/api/getCancelableCreditCardDebtPaymentList

Retrieves a list of cancellable credit card debt payments for a given shadow card number, including transaction details and related card/customer information.

Service that lists payments eligible for reversal › Request Body

GetCancelableCreditCardDebtPaymentListRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

Service that lists payments eligible for reversal › Responses

Success

GetCancelableCreditCardDebtPaymentListResponse

array | null

List Of Payment - [Optional]

POST/credit/api/getCancelableCreditCardDebtPaymentList

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

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

json

Example Responses

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

json

application/json

Service that captures Automatic Payment Instructions for credit cards

POST

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

/credit/api/saveCreditCardAutoPaymentOrder

Saves the credit card auto-payment order with specified payment type, account number, and account owner name.

Service that captures Automatic Payment Instructions for credit cards › Request Body

SaveCreditCardAutoPaymentOrderRequest

accountNumber

integer · int32 · required

Account Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

accountOwnerName

string | null

Account Owner Name - [Optional]

paymentType

string | null

Payment Type - [Optional]

Service that captures Automatic Payment Instructions for credit cards › Responses

Success

SaveCreditCardAutoPaymentOrderResponse

Service that displays auto-payment account information for a given card

POST

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

/credit/api/getCreditCardAutoPaymentOrder

Service that displays auto-payment account information for a given card › Request Body

GetCreditCardAutoPaymentOrderRequest

mainCustomerNumber

integer · int64 · required

Main Customer Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

Service that displays auto-payment account information for a given card › Responses

Success

GetCreditCardAutoPaymentOrderResponse

array | null

List Of Records - [Optional]

POST/credit/api/getCreditCardAutoPaymentOrder

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

Example Request Body

{
  "mainCustomerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "shadowCardNumber": "shadowCardNumber"
}

json

Example Responses

{
  "listOfRecords": [
    {
      "paymentAccountNumber": 0,
      "paymentAccountOwnerName": "paymentAccountOwnerName",
      "mainCardRefNumber": "mainCardRefNumber",
      "shadowCardNumber": "shadowCardNumber",
      "paymentType": "paymentType",
      "mainCustomerNumber": 0,
      "maskedCardNumber": "maskedCardNumber"
    }
  ]
}

json

application/json

Collections and legal follow-up Statements and billing