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
Service that generates the delivery file for use in distribution processes.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
createDeliveryFile › Responses
Success
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.
exceptionDetailgetCourierInformation
Service that retrieves the card’s courier delivery information using the barcode number.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCourierInformation › Request Body
barcodeThe delivery's barcode, which is how the courier and the platform name the same consignment.
getCourierInformation › Responses
Success
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.
exceptionDetailupdateAddressInformation
Service that allows updating the customer’s delivery address.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
updateAddressInformation › Request Body
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.
updateAddressInformation › Responses
Success
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.
updateMovementsWithBarcodeNumber
Service that updates delivery movements and status information based on the barcode number of the courier shipment.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
updateMovementsWithBarcodeNumber › Request Body
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.
updateMovementsWithBarcodeNumber › Responses
Success
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.
getBasicCourierInformation
Service that retrieves basic courier stage information based on the provided Shadow Card Number.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getBasicCourierInformation › Request Body
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.
getBasicCourierInformation › Responses
Success
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.
getCourierInformationIbmb
Service that returns detailed IBMB system information of the courier company used for card delivery.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCourierInformationIbmb › Request Body
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
getCourierInformationIbmb › Responses
Success
isHaveAnyDebitCardisHaveAnyCreditCardgetCourierInformationByMainCustomer
Service that returns detailed IBMB system information of the courier company used for card delivery, based on the provided customer number.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCourierInformationByMainCustomer › Request Body
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.
statusCodegetCourierInformationByMainCustomer › Responses
Success