Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Common Methods
  • 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

Schemas


BasicCourierInformation

maskedCardNumber
​string · optional

The card number with its middle digits masked, as the platform stores it. It is a display form, not a key.

shadowCardNumber
​string · optional

The platform's own handle for a card, and the identifier most operations take. It is returned by every operation that creates a card and by the card listings; a caller does not compose one.

barcode
​string · optional

The delivery's barcode, which is how the courier and the platform name the same consignment.

courierCompanyCode
​string · enum · optional

Values:

  • KURYENET — Kuryenet
operationDateStr
​string · optional

The date the courier recorded the movement, as the courier writes it rather than as a timestamp.

operationTimeStr
​string · optional

The time of that movement, in the same form.

courierStateDescription
​string · optional

The description of courierState, carried alongside it for display. It is not a key: match on the code.

courierState
​string · enum · optional

Values:

  • Teslim — delivered
  • İade — returned
  • Dağıtımda — out for delivery

CardCourierInformation

customerNumber
​integer · int64 · required
mainCustomerNumber
​integer · int64 · required

The main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.

digitalCardFlag
​boolean · required
cardMasterRecordId
​integer · int64 · required
barcode
​string · optional

The delivery's barcode, which is how the courier and the platform name the same consignment.

shadowCardNumber
​string · optional

The platform's own handle for a card, and the identifier most operations take. It is returned by every operation that creates a card and by the card listings; a caller does not compose one.

maskedCardNumber
​string · optional

The card number with its middle digits masked, as the platform stores it. It is a display form, not a key.

productTypeCode
​string · enum · optional

Values:

  • C — credit
  • D — debit
  • P — prepaid
productNumber
​string · optional
productName
​string · optional

The card product's full name.

statusCode
​string · optional
statusDescription
​string · optional

The description of statusCode, carried alongside it for display. It is not a key: match on the code.

cardRefNumber
​string · optional
mainCardRefNumber
​string · optional

CourierInformation

operationDateTime
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
barcode
​string · optional

The delivery's barcode, which is how the courier and the platform name the same consignment.

operationDateStr
​string · optional

The date the courier recorded the movement, as the courier writes it rather than as a timestamp.

operationTimeStr
​string · optional

The time of that movement, in the same form.

operationStatus
​string · enum · optional

Values:

  • 7 — agency
  • 500 — delivered
  • 501 — delivered to a first-degree relative
  • 502 — delivered to the secretary
  • 503 — delivered to a sibling
  • 504 — delivered to the manager
  • 505 — delivered to the bank
  • 506 — delivered to someone else
  • 507 — other delivery
  • 600 — returned
operationDescription
​string · optional
callOnNumber
​string · optional

CourierInformationIntegrationRequest

barcode
​string · maxLength: 13 · optional

The delivery's barcode, which is how the courier and the platform name the same consignment.

CourierInformationIntegrationResponse

​array · optional
responseCode
​string · optional

The downstream system's own result code, passed through. 00 and 0 are success; anything else is its refusal, and responseReasonCode or the description says which.

responseDescription
​string · optional

The description of responseCode, carried alongside it for display. It is not a key: match on the code.

exceptionDetail
​string · optional

CreateDeliveryFileResponse

responseCode
​integer · int32 · required

The downstream system's own result code, passed through. 00 and 0 are success; anything else is its refusal, and responseReasonCode or the description says which.

responseDescription
​string · optional

The description of responseCode, carried alongside it for display. It is not a key: match on the code.

exceptionDetail
​string · optional

Error

transactionId
​string · optional

The platform's identifier for this call, for tracing it in the logs.

errorCode
​string · optional

The platform's own code for the error, and what to match on.

description
​string · optional

The error in words. errorCode is the part to match on; this is for a log or a screen.

message
​string · optional

The error in words. errorCode is the part to match on.

messageFormat
​string · optional

The message before its arguments were substituted in, which is what groups two errors that differ only by their values.

arguments
​array · optional

The values substituted into messageFormat.

propertyName
​string · optional

Which field of the request the error is about.

detail
​string · optional

More about the error than message carries, where there is more.

​array · optional

The individual problems, where one error stands for several.

isTechnicalError
​boolean · optional

Whether the failure is the platform's rather than the request's. A technical error is worth retrying; a business one is not.

exceptionType
​string · optional

The platform's internal exception class. Useful in a support conversation and not something to match on.

GetBasicCourierInformationRequest

shadowCardNumber
​string · maxLength: 19 · optional

The platform's own handle for a card, and the identifier most operations take. It is returned by every operation that creates a card and by the card listings; a caller does not compose one.

GetBasicCourierInformationResponse

​array · optional
​object · optional
responseCode
​string · optional

The downstream system's own result code, passed through. 00 and 0 are success; anything else is its refusal, and responseReasonCode or the description says which.

responseDescription
​string · optional

The description of responseCode, carried alongside it for display. It is not a key: match on the code.

GetCourierInformationByMainCustomerRequest

channel
​string · maxLength: 3 · required

Three-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.

mainCustomerNumber
​integer · int64 · optional

The main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.

productType
​string · maxLength: 1 · optional

Which kind of card the consignment carries, as a one-letter code.

statusCode
​string · maxLength: 3 · optional

GetCourierInformationByMainCustomerResponse

​array · optional

GetCourierInformationIbmbRequest

customerNumber
​string · optional

Customer Number

Checked against the barcode rather than stored by this operation, so no column stands behind it here.

barcode
​string · maxLength: 13 · optional

The delivery's barcode, which is how the courier and the platform name the same consignment.

productSegment
​string · enum · maxLength: 1 · optional

Values:

  • B — retail
  • T — commercial

GetCourierInformationIbmbResponse

isHaveAnyDebitCard
​boolean · required
isHaveAnyCreditCard
​boolean · required
​array · optional
​array · optional

HealthCheckResponse

date
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
result
​string · optional

The outcome, as the downstream system words it.

IbmbCourierInformation

supplementaryCardFlag
​boolean · required

Whether this is a supplementary card rather than a main one.

maskedCardNumber
​string · optional

The card number with its middle digits masked, as the platform stores it. It is a display form, not a key.

courierCompanyCode
​string · enum · optional

Values:

  • KURYENET — Kuryenet
barcode
​string · optional

The delivery's barcode, which is how the courier and the platform name the same consignment.

lastProcessStatusDate
​string · optional
courierStateDescription
​string · optional

The description of courierStateCode, carried alongside it for display. It is not a key: match on the code.

productType
​string · optional

Which kind of card the consignment carries, as a one-letter code.

deliveryType
​string · optional
deliveryTypeDescription
​string · optional

The description of deliveryType, carried alongside it for display. It is not a key: match on the code.

sendingAdress
​string · optional
sendingBranchName
​string · optional
applicationDate
​string · optional
renewDate
​string · optional
receiveNameSurname
​string · optional
embossName
​string · optional

The name embossed on the card.

returnReason
​string · optional
cardStatusCode
​string · optional
cardStatusDescription
​string · optional

The description of cardStatusCode, carried alongside it for display. It is not a key: match on the code.

cardStatusReasonCode
​string · optional
cardStatusReasonDescription
​string · optional

The description of cardStatusReasonCode, carried alongside it for display. It is not a key: match on the code.

embossCompanyOperationStatus
​string · enum · optional

Values:

  • C — print file created
  • E — printed
embossReasonCode
​string · enum · optional

Values:

  • N — new card
  • Y — renewal
embossReasonDescription
​string · optional

The description of embossReasonCode, carried alongside it for display. It is not a key: match on the code.

embossReasonSubCode
​string · enum · optional

Values:

  • BRK — broken card
  • CHF — faulty chip
  • EXO — bulk renewal on expiry
  • EXP — renewal on expiry
  • FRD — fraud
  • LST — lost
  • MGF — magnetic stripe failure
  • NSU — name and surname change
  • OTH — other
  • PIN — PIN print
  • STL — stolen
embossReasonSubDescription
​string · optional

The description of embossReasonSubCode, carried alongside it for display. It is not a key: match on the code.

cardEmbossDate
​string · optional
courierStateCode
​string · optional
cardType
​string · enum · optional

Values:

  • Kredi Kartı — credit card
  • Banka Kartı — debit card
productNumber
​string · optional

LatestBarcodeStateInformation

numberOfDaysOnTheCourier
​integer · int32 · required
maskedCardNumber
​string · optional

The card number with its middle digits masked, as the platform stores it. It is a display form, not a key.

latestBarcodeNumber
​string · optional
latestCourierState
​string · enum · optional

Values:

  • Teslim — delivered
  • İade — returned
  • Dağıtımda — out for delivery
callOnNumber
​string · optional

UpdateAddressInformationIntegrationRequest

barcode
​string · maxLength: 13 · optional

The delivery's barcode, which is how the courier and the platform name the same consignment.

deliveryType
​string · maxLength: 10 · optional
addressText
​string · maxLength: 250 · optional

The address the consignment is being sent to, as written.

additionalInfo
​string · maxLength: 120 · optional

Anything else the courier needs for the delivery.

agentId
​string · maxLength: 100 · optional

The courier agent handling the consignment.

UpdateAddressInformationIntegrationResponse

responseCode
​string · optional

The downstream system's own result code, passed through. 00 and 0 are success; anything else is its refusal, and responseReasonCode or the description says which.

responseDescription
​string · optional

The description of responseCode, carried alongside it for display. It is not a key: match on the code.

UpdateMovementsWithBarcodeNumberIntegrationRequest

barcode
​string · maxLength: 13 · optional

The delivery's barcode, which is how the courier and the platform name the same consignment.

operationDateStr
​string · maxLength: 20 · optional

The date the courier recorded the movement, as the courier writes it rather than as a timestamp.

operationTimeStr
​string · maxLength: 20 · optional

The time of that movement, in the same form.

operationStatus
​string · enum · maxLength: 3 · optional

Values:

  • 7 — agency
  • 500 — delivered
  • 501 — delivered to a first-degree relative
  • 502 — delivered to the secretary
  • 503 — delivered to a sibling
  • 504 — delivered to the manager
  • 505 — delivered to the bank
  • 506 — delivered to someone else
  • 507 — other delivery
  • 600 — returned
receivedByWhomNameSurname
​string · maxLength: 50 · optional

Who took delivery, as the courier recorded it.

UpdateMovementsWithBarcodeNumberIntegrationResponse

responseCode
​string · optional

The downstream system's own result code, passed through. 00 and 0 are success; anything else is its refusal, and responseReasonCode or the description says which.

responseDescription
​string · optional

The description of responseCode, carried alongside it for display. It is not a key: match on the code.

On this page
  • BasicCourierInformation
  • CardCourierInformation
  • CourierInformation
  • CourierInformationIntegrationRequest
  • CourierInformationIntegrationResponse
  • CreateDeliveryFileResponse
  • Error
  • GetBasicCourierInformationRequest
  • GetBasicCourierInformationResponse
  • GetCourierInformationByMainCustomerRequest
  • GetCourierInformationByMainCustomerResponse
  • GetCourierInformationIbmbRequest
  • GetCourierInformationIbmbResponse
  • HealthCheckResponse
  • IbmbCourierInformation
  • LatestBarcodeStateInformation
  • UpdateAddressInformationIntegrationRequest
  • UpdateAddressInformationIntegrationResponse
  • UpdateMovementsWithBarcodeNumberIntegrationRequest
  • UpdateMovementsWithBarcodeNumberIntegrationResponse