BasicCourierInformation
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key.
shadowCardNumberThe 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.
barcodeThe delivery's barcode, which is how the courier and the platform name the same consignment.
courierCompanyCodeValues:
KURYENET— Kuryenet
operationDateStrThe date the courier recorded the movement, as the courier writes it rather than as a timestamp.
operationTimeStrThe time of that movement, in the same form.
courierStateDescriptionThe description of courierState, carried alongside it for display. It is not a key: match on the code.
courierStateValues:
Teslim— deliveredİade— returnedDağıtımda— out for delivery
CardCourierInformation
customerNumbermainCustomerNumberThe main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.
digitalCardFlagcardMasterRecordIdbarcodeThe delivery's barcode, which is how the courier and the platform name the same consignment.
shadowCardNumberThe 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.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key.
productTypeCodeValues:
C— creditD— debitP— prepaid
productNumberproductNameThe card product's full name.
statusCodestatusDescriptionThe description of statusCode, carried alongside it for display. It is not a key: match on the code.
cardRefNumbermainCardRefNumberCourierInformation
operationDateTimeA 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.
barcodeThe delivery's barcode, which is how the courier and the platform name the same consignment.
operationDateStrThe date the courier recorded the movement, as the courier writes it rather than as a timestamp.
operationTimeStrThe time of that movement, in the same form.
operationStatusValues:
7— agency500— delivered501— delivered to a first-degree relative502— delivered to the secretary503— delivered to a sibling504— delivered to the manager505— delivered to the bank506— delivered to someone else507— other delivery600— returned
operationDescriptioncallOnNumberCourierInformationIntegrationRequest
barcodeThe delivery's barcode, which is how the courier and the platform name the same consignment.
CourierInformationIntegrationResponse
responseCodeThe 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.
responseDescriptionThe description of responseCode, carried alongside it for display. It is not a key: match on the code.
exceptionDetailCreateDeliveryFileResponse
responseCodeThe 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.
responseDescriptionThe description of responseCode, carried alongside it for display. It is not a key: match on the code.
exceptionDetailError
transactionIdThe platform's identifier for this call, for tracing it in the logs.
errorCodeThe platform's own code for the error, and what to match on.
descriptionThe error in words. errorCode is the part to match on; this is for a log or a screen.
messageThe error in words. errorCode is the part to match on.
messageFormatThe message before its arguments were substituted in, which is what groups two errors that differ only by their values.
argumentsThe values substituted into messageFormat.
propertyNameWhich field of the request the error is about.
detailMore about the error than message carries, where there is more.
The individual problems, where one error stands for several.
isTechnicalErrorWhether the failure is the platform's rather than the request's. A technical error is worth retrying; a business one is not.
exceptionTypeThe platform's internal exception class. Useful in a support conversation and not something to match on.
GetBasicCourierInformationRequest
shadowCardNumberThe 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
responseCodeThe 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.
responseDescriptionThe description of responseCode, carried alongside it for display. It is not a key: match on the code.
GetCourierInformationByMainCustomerRequest
channelThree-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.
mainCustomerNumberThe main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.
productTypeWhich kind of card the consignment carries, as a one-letter code.
statusCodeGetCourierInformationIbmbRequest
customerNumberCustomer Number
Checked against the barcode rather than stored by this operation, so no column stands behind it here.
barcodeThe delivery's barcode, which is how the courier and the platform name the same consignment.
productSegmentValues:
B— retailT— commercial
GetCourierInformationIbmbResponse
isHaveAnyDebitCardisHaveAnyCreditCardHealthCheckResponse
dateA 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.
resultThe outcome, as the downstream system words it.
IbmbCourierInformation
supplementaryCardFlagWhether this is a supplementary card rather than a main one.
maskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key.
courierCompanyCodeValues:
KURYENET— Kuryenet
barcodeThe delivery's barcode, which is how the courier and the platform name the same consignment.
lastProcessStatusDatecourierStateDescriptionThe description of courierStateCode, carried alongside it for display. It is not a key: match on the code.
productTypeWhich kind of card the consignment carries, as a one-letter code.
deliveryTypedeliveryTypeDescriptionThe description of deliveryType, carried alongside it for display. It is not a key: match on the code.
sendingAdresssendingBranchNameapplicationDaterenewDatereceiveNameSurnameembossNameThe name embossed on the card.
returnReasoncardStatusCodecardStatusDescriptionThe description of cardStatusCode, carried alongside it for display. It is not a key: match on the code.
cardStatusReasonCodecardStatusReasonDescriptionThe description of cardStatusReasonCode, carried alongside it for display. It is not a key: match on the code.
embossCompanyOperationStatusValues:
C— print file createdE— printed
embossReasonCodeValues:
N— new cardY— renewal
embossReasonDescriptionThe description of embossReasonCode, carried alongside it for display. It is not a key: match on the code.
embossReasonSubCodeValues:
BRK— broken cardCHF— faulty chipEXO— bulk renewal on expiryEXP— renewal on expiryFRD— fraudLST— lostMGF— magnetic stripe failureNSU— name and surname changeOTH— otherPIN— PIN printSTL— stolen
embossReasonSubDescriptionThe description of embossReasonSubCode, carried alongside it for display. It is not a key: match on the code.
cardEmbossDatecourierStateCodecardTypeValues:
Kredi Kartı— credit cardBanka Kartı— debit card
productNumberLatestBarcodeStateInformation
numberOfDaysOnTheCouriermaskedCardNumberThe card number with its middle digits masked, as the platform stores it. It is a display form, not a key.
latestBarcodeNumberlatestCourierStateValues:
Teslim— deliveredİade— returnedDağıtımda— out for delivery
callOnNumberUpdateAddressInformationIntegrationRequest
barcodeThe delivery's barcode, which is how the courier and the platform name the same consignment.
deliveryTypeaddressTextThe address the consignment is being sent to, as written.
additionalInfoAnything else the courier needs for the delivery.
agentIdThe courier agent handling the consignment.
UpdateAddressInformationIntegrationResponse
responseCodeThe 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.
responseDescriptionThe description of responseCode, carried alongside it for display. It is not a key: match on the code.
UpdateMovementsWithBarcodeNumberIntegrationRequest
barcodeThe delivery's barcode, which is how the courier and the platform name the same consignment.
operationDateStrThe date the courier recorded the movement, as the courier writes it rather than as a timestamp.
operationTimeStrThe time of that movement, in the same form.
operationStatusValues:
7— agency500— delivered501— delivered to a first-degree relative502— delivered to the secretary503— delivered to a sibling504— delivered to the manager505— delivered to the bank506— delivered to someone else507— other delivery600— returned
receivedByWhomNameSurnameWho took delivery, as the courier recorded it.
UpdateMovementsWithBarcodeNumberIntegrationResponse
responseCodeThe 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.
responseDescriptionThe description of responseCode, carried alongside it for display. It is not a key: match on the code.