Card delivery and courier tracking

Get a produced card to the cardholder — generate the distribution file, track the courier by barcode, and correct the delivery address while the card is in transit.

Service that generates the delivery file for use in distribution processes

POST

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

/delivery-integration-indoor-service/api/createDeliveryFile

Service that generates the delivery file for use in distribution processes.

Service that generates the delivery file for use in distribution processes › Responses

Success

CreateDeliveryFileResponse

responseCode

integer · int32 · required

Response Code

responseDescription

string | null

Response Description

exceptionDetail

string | null

Exception Detail

POST

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

/delivery-integration-indoor-service/api/getCourierInformation

Service that retrieves the card’s courier delivery information using the barcode number.

Request Body

CourierInformationIntegrationRequest

barcode

string | null

Barcode

Responses

Success

CourierInformationIntegrationResponse

array | null

Information List

responseCode

string | null

Response Code

responseDescription

string | null

Response Description

exceptionDetail

string | null

Exception Detail

POST/delivery-integration-indoor-service/api/getCourierInformation

curl https://devcard.sim-ant.com/SandBox/IntegrationDelivery/delivery-integration-indoor-service/api/getCourierInformation \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "barcode": "barcode"
}'

Example Request Body

{
  "barcode": "barcode"
}

json

Example Responses

{
  "informationList": [
    {
      "barcode": "barcode",
      "operationDateStr": "operationDateStr",
      "operationTimeStr": "operationTimeStr",
      "operationStatus": "operationStatus",
      "operationDescription": "operationDescription",
      "operationDateTime": "2024-08-25T15:00:00Z",
      "callOnNumber": "callOnNumber"
    }
  ],
  "responseCode": "responseCode",
  "responseDescription": "responseDescription",
  "exceptionDetail": "exceptionDetail"
}

json

application/json

POST

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

/delivery-integration-indoor-service/api/updateAddressInformation

Service that allows updating the customer’s delivery address.

Request Body

UpdateAddressInformationIntegrationRequest

barcode

string | null

Barcode

deliveryType

string | null

Delivery Type

addressText

string | null

Address Text

additionalInfo

string | null

Additional Info

agentId

string | null

Agent Id

Responses

Success

UpdateAddressInformationIntegrationResponse

responseCode

string | null

Response Code

responseDescription

string | null

Response Description

POST

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

/delivery-integration-indoor-service/api/updateMovementsWithBarcodeNumber

Service that updates delivery movements and status information based on the barcode number of the courier shipment.

Request Body

UpdateMovementsWithBarcodeNumberIntegrationRequest

barcode

string | null

Barcode

operationDateStr

string | null

Operation Date Str

operationTimeStr

string | null

Operation Time Str

operationStatus

string | null

Operation Status

operationDescription

string | null

Operation Description

receivedByWhomNameSurname

string | null

Received By Whom Name Surname

Responses

Success

UpdateMovementsWithBarcodeNumberIntegrationResponse

responseCode

string | null

Response Code

responseDescription

string | null

Response Description

POST/delivery-integration-indoor-service/api/updateMovementsWithBarcodeNumber

curl https://devcard.sim-ant.com/SandBox/IntegrationDelivery/delivery-integration-indoor-service/api/updateMovementsWithBarcodeNumber \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "barcode": "barcode",
  "operationDateStr": "operationDateStr",
  "operationTimeStr": "operationTimeStr",
  "operationStatus": "operationStatus",
  "operationDescription": "operationDescription",
  "receivedByWhomNameSurname": "receivedByWhomNameSurname"
}'

Example Request Body

{
  "barcode": "barcode",
  "operationDateStr": "operationDateStr",
  "operationTimeStr": "operationTimeStr",
  "operationStatus": "operationStatus",
  "operationDescription": "operationDescription",
  "receivedByWhomNameSurname": "receivedByWhomNameSurname"
}

json

Example Responses

{
  "responseCode": "responseCode",
  "responseDescription": "responseDescription"
}

json

application/json

POST

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

/delivery-integration-indoor-service/api/getBasicCourierInformation

Service that retrieves basic courier stage information based on the provided Shadow Card Number.

Request Body

GetBasicCourierInformationRequest

shadowCardNumber

string | null

Shadow Card Number

Responses

Success

GetBasicCourierInformationResponse

array | null

Information List

object

Latest Barcode State Information

responseCode

string | null

Response Code

responseDescription

string | null

Response Description

POST/delivery-integration-indoor-service/api/getBasicCourierInformation

curl https://devcard.sim-ant.com/SandBox/IntegrationDelivery/delivery-integration-indoor-service/api/getBasicCourierInformation \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "shadowCardNumber": "shadowCardNumber"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

json

Example Responses

{
  "informationList": [
    {
      "maskedCardNumber": "maskedCardNumber",
      "shadowCardNumber": "shadowCardNumber",
      "barcode": "barcode",
      "courierCompanyCode": "courierCompanyCode",
      "operationDateStr": "operationDateStr",
      "operationTimeStr": "operationTimeStr",
      "courierStateDescription": "courierStateDescription",
      "courierState": "courierState"
    }
  ],
  "latestBarcodeStateInformation": {
    "maskedCardNumber": "maskedCardNumber",
    "latestBarcodeNumber": "latestBarcodeNumber",
    "latestCourierState": "latestCourierState",
    "numberOfDaysOnTheCourier": 0,
    "callOnNumber": "callOnNumber"
  },
  "responseCode": "responseCode",
  "responseDescription": "responseDescription"
}

json

application/json

POST

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

/delivery-integration-indoor-service/api/getCourierInformationIbmb

Service that returns detailed IBMB system information of the courier company used for card delivery.

Request Body

GetCourierInformationIbmbRequest

customerNumber

string | null

Customer Number

barcode

string | null

Barcode

productSegment

string | null

Product Segment

Responses

Success

GetCourierInformationIbmbResponse

isHaveAnyDebitCard

boolean · required

Is Have Any Debit Card

isHaveAnyCreditCard

boolean · required

Is Have Any Credit Card

array | null

List Of Debit Card

array | null

List Of Credit Card

POST/delivery-integration-indoor-service/api/getCourierInformationIbmb

curl https://devcard.sim-ant.com/SandBox/IntegrationDelivery/delivery-integration-indoor-service/api/getCourierInformationIbmb \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "customerNumber": "customerNumber",
  "barcode": "barcode",
  "productSegment": "productSegment"
}'

Example Request Body

{
  "customerNumber": "customerNumber",
  "barcode": "barcode",
  "productSegment": "productSegment"
}

json

Example Responses

{
  "listOfDebitCard": [
    {
      "maskedCardNumber": "maskedCardNumber",
      "courierCompanyCode": "courierCompanyCode",
      "barcode": "barcode",
      "lastProcessStatusDate": "lastProcessStatusDate",
      "courierStateDescription": "courierStateDescription",
      "productType": "productType",
      "deliveryType": "deliveryType",
      "deliveryTypeDescription": "deliveryTypeDescription",
      "sendingAdress": "sendingAdress",
      "sendingBranchName": "sendingBranchName",
      "applicationDate": "applicationDate",
      "renewDate": "renewDate",
      "receiveNameSurname": "receiveNameSurname",
      "embossName": "embossName",
      "returnReason": "returnReason",
      "cardStatusCode": "cardStatusCode",
      "cardStatusDescription": "cardStatusDescription",
      "cardStatusReasonCode": "cardStatusReasonCode",
      "cardStatusReasonDescription": "cardStatusReasonDescription",
      "embossCompanyOperationStatus": "embossCompanyOperationStatus",
      "embossReasonCode": "embossReasonCode",
      "embossReasonDescription": "embossReasonDescription",
      "embossReasonSubCode": "embossReasonSubCode",
      "embossReasonSubDescription": "embossReasonSubDescription",
      "cardEmbossDate": "cardEmbossDate",
      "courierStateCode": "courierStateCode",
      "cardType": "cardType",
      "productNumber": "productNumber",
      "supplementaryCardFlag": true
    }
  ],
  "listOfCreditCard": [
    {
      "maskedCardNumber": "maskedCardNumber",
      "courierCompanyCode": "courierCompanyCode",
      "barcode": "barcode",
      "lastProcessStatusDate": "lastProcessStatusDate",
      "courierStateDescription": "courierStateDescription",
      "productType": "productType",
      "deliveryType": "deliveryType",
      "deliveryTypeDescription": "deliveryTypeDescription",
      "sendingAdress": "sendingAdress",
      "sendingBranchName": "sendingBranchName",
      "applicationDate": "applicationDate",
      "renewDate": "renewDate",
      "receiveNameSurname": "receiveNameSurname",
      "embossName": "embossName",
      "returnReason": "returnReason",
      "cardStatusCode": "cardStatusCode",
      "cardStatusDescription": "cardStatusDescription",
      "cardStatusReasonCode": "cardStatusReasonCode",
      "cardStatusReasonDescription": "cardStatusReasonDescription",
      "embossCompanyOperationStatus": "embossCompanyOperationStatus",
      "embossReasonCode": "embossReasonCode",
      "embossReasonDescription": "embossReasonDescription",
      "embossReasonSubCode": "embossReasonSubCode",
      "embossReasonSubDescription": "embossReasonSubDescription",
      "cardEmbossDate": "cardEmbossDate",
      "courierStateCode": "courierStateCode",
      "cardType": "cardType",
      "productNumber": "productNumber",
      "supplementaryCardFlag": true
    }
  ],
  "isHaveAnyDebitCard": true,
  "isHaveAnyCreditCard": true
}

json

application/json

POST

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

/delivery-integration-indoor-service/api/getCourierInformationByMainCustomer

Service that returns detailed IBMB system information of the courier company used for card delivery, based on the provided customer number.

Request Body

GetCourierInformationByMainCustomerRequest

channel

string | null

Channel

mainCustomerNumber

integer | null · int64

Main Customer Number

productType

string | null

Product Type

statusCode

string | null

Status Code

Responses

Success

GetCourierInformationByMainCustomerResponse

array | null

Card List

POST/delivery-integration-indoor-service/api/getCourierInformationByMainCustomer

curl https://devcard.sim-ant.com/SandBox/IntegrationDelivery/delivery-integration-indoor-service/api/getCourierInformationByMainCustomer \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "mainCustomerNumber": 0,
  "productType": "productType",
  "statusCode": "statusCode"
}'

Example Request Body

{
  "channel": "channel",
  "mainCustomerNumber": 0,
  "productType": "productType",
  "statusCode": "statusCode"
}

json

Example Responses

{
  "cardList": [
    {
      "barcode": "barcode",
      "shadowCardNumber": "shadowCardNumber",
      "maskedCardNumber": "maskedCardNumber",
      "customerNumber": 0,
      "mainCustomerNumber": 0,
      "productTypeCode": "productTypeCode",
      "productNumber": "productNumber",
      "productName": "productName",
      "statusCode": "statusCode",
      "statusDescription": "statusDescription",
      "digitalCardFlag": true,
      "cardRefNumber": "cardRefNumber",
      "mainCardRefNumber": "mainCardRefNumber",
      "cardMasterRecordId": 0
    }
  ]
}

json

application/json

Platform operations

Service that generates the delivery file for use in distribution processes

POST

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

/delivery-integration-indoor-service/api/createDeliveryFile

Service that generates the delivery file for use in distribution processes.

Service that generates the delivery file for use in distribution processes › Responses

Success

CreateDeliveryFileResponse

responseCode

integer · int32 · required

Response Code

responseDescription

string | null

Response Description

exceptionDetail

string | null

Exception Detail