Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Corebanking
  • OAuth2
  • Delivery
Information
Cards
    Card delivery and courier tracking
      createDeliveryFilepostgetCourierInformationpostupdateAddressInformationpostupdateMovementsWithBarcodeNumberpostgetBasicCourierInformationpostgetCourierInformationIbmbpostgetCourierInformationByMainCustomerpost
Platform
    Platform operations
      healthCheckpost
SchemasError codesChannels
powered by Zudoku
Delivery Integration Indoor Service
Delivery Integration Indoor Service

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.


createDeliveryFile

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDelivery/delivery-integration-indoor-service/api/createDeliveryFile

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

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

createDeliveryFile › Responses

Success

CreateDeliveryFileResponse
responseCode
​integer · int32 · required

Response Code

responseDescription
​string | null

Response Description

exceptionDetail
​string | null

Exception Detail

POST/IntegrationDelivery/delivery-integration-indoor-service/api/createDeliveryFile
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDelivery/delivery-integration-indoor-service/api/createDeliveryFile \ --request POST \ --header 'evrst-ptrnid: x_request_id'
Example Responses
{ "responseCode": 0, "responseDescription": "responseDescription", "exceptionDetail": "exceptionDetail" }
json
application/json

getCourierInformation

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDelivery/delivery-integration-indoor-service/api/getCourierInformation

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

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

getCourierInformation › Request Body

CourierInformationIntegrationRequest
barcode
​string | null

Barcode

getCourierInformation › Responses

Success

CourierInformationIntegrationResponse
​array | null

Information List

responseCode
​string | null

Response Code

responseDescription
​string | null

Response Description

exceptionDetail
​string | null

Exception Detail

POST/IntegrationDelivery/delivery-integration-indoor-service/api/getCourierInformation
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDelivery/delivery-integration-indoor-service/api/getCourierInformation \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "barcode": "barcode" }'
Example Request Body
{ "barcode": "barcode" }
json
application/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

updateAddressInformation

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDelivery/delivery-integration-indoor-service/api/updateAddressInformation

Service that allows updating the customer’s delivery address.

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

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

updateAddressInformation › Responses

Success

UpdateAddressInformationIntegrationResponse
responseCode
​string | null

Response Code

responseDescription
​string | null

Response Description

POST/IntegrationDelivery/delivery-integration-indoor-service/api/updateAddressInformation
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDelivery/delivery-integration-indoor-service/api/updateAddressInformation \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "barcode": "barcode", "deliveryType": "deliveryType", "addressText": "addressText", "additionalInfo": "additionalInfo", "agentId": "agentId" }'
Example Request Body
{ "barcode": "barcode", "deliveryType": "deliveryType", "addressText": "addressText", "additionalInfo": "additionalInfo", "agentId": "agentId" }
json
application/json
Example Responses
{ "responseCode": "responseCode", "responseDescription": "responseDescription" }
json
application/json

updateMovementsWithBarcodeNumber

POST
https://everest-sandboxapi.dgpays.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.

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

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

updateMovementsWithBarcodeNumber › Responses

Success

UpdateMovementsWithBarcodeNumberIntegrationResponse
responseCode
​string | null

Response Code

responseDescription
​string | null

Response Description

POST/IntegrationDelivery/delivery-integration-indoor-service/api/updateMovementsWithBarcodeNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDelivery/delivery-integration-indoor-service/api/updateMovementsWithBarcodeNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --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
application/json
Example Responses
{ "responseCode": "responseCode", "responseDescription": "responseDescription" }
json
application/json

getBasicCourierInformation

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDelivery/delivery-integration-indoor-service/api/getBasicCourierInformation

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

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

getBasicCourierInformation › Request Body

GetBasicCourierInformationRequest
shadowCardNumber
​string | null

Shadow Card Number

getBasicCourierInformation › Responses

Success

GetBasicCourierInformationResponse
​array | null

Information List

​object

Latest Barcode State Information

responseCode
​string | null

Response Code

responseDescription
​string | null

Response Description

POST/IntegrationDelivery/delivery-integration-indoor-service/api/getBasicCourierInformation
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDelivery/delivery-integration-indoor-service/api/getBasicCourierInformation \ --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
{ "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

getCourierInformationIbmb

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDelivery/delivery-integration-indoor-service/api/getCourierInformationIbmb

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

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

getCourierInformationIbmb › Request Body

GetCourierInformationIbmbRequest
customerNumber
​string | null

Customer Number

barcode
​string | null

Barcode

productSegment
​string | null

Product Segment

getCourierInformationIbmb › 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/IntegrationDelivery/delivery-integration-indoor-service/api/getCourierInformationIbmb
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDelivery/delivery-integration-indoor-service/api/getCourierInformationIbmb \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "customerNumber": "customerNumber", "barcode": "barcode", "productSegment": "productSegment" }'
Example Request Body
{ "customerNumber": "customerNumber", "barcode": "barcode", "productSegment": "productSegment" }
json
application/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

getCourierInformationByMainCustomer

POST
https://everest-sandboxapi.dgpays.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.

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

getCourierInformationByMainCustomer › Request Body

GetCourierInformationByMainCustomerRequest
channel
​string | null

Channel

mainCustomerNumber
​integer | null · int64

Main Customer Number

productType
​string | null

Product Type

statusCode
​string | null

Status Code

getCourierInformationByMainCustomer › Responses

Success

GetCourierInformationByMainCustomerResponse
​array | null

Card List

POST/IntegrationDelivery/delivery-integration-indoor-service/api/getCourierInformationByMainCustomer
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDelivery/delivery-integration-indoor-service/api/getCourierInformationByMainCustomer \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "mainCustomerNumber": 0, "productType": "productType", "statusCode": "statusCode" }'
Example Request Body
{ "channel": "channel", "mainCustomerNumber": 0, "productType": "productType", "statusCode": "statusCode" }
json
application/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