v1

latestOpenAPI 3.0.12026-07-243407211.3 MB

PaymentInstrument

Get Payment Instrument Delivery Status

Get Delivery Status

get/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}/deliveryStatus

programCodestring required

The program code associated with the account.

accountIdentifierstring required

Unique identifier (UID or GUID) for the account.

paymentInstrumentIdentifierstring required

Unique identifier (UID or GUID) for the payment instrument.

X-GD-RequestIdstring required

A unique identifier for tracking the request, provided in the X-GD-RequestId header.

trackingNumberstring nullable

The tracking number provided by the shipping carrier for the mailed payment instrument.

deliveryMethodCodestring nullable

The code representing the delivery method (e.g., "STD" for standard, "EXP" for express).

deliveryMethodstring nullable

The human-readable name of the delivery method (e.g., "Standard Mail", "Express Delivery").

deliveryStatusCodestring nullable

The code representing the current delivery status (e.g., "IN_TRANSIT", "DELIVERED").

deliveryStatusstring nullable

The human-readable description of the current delivery status.

shippedDatestring date-time nullable

The date and time when the payment instrument was shipped, if available.

estimatedArrivalDatestring date-time nullable

The estimated date when the payment instrument is expected to arrive.

last4Panstring nullable

The last four digits of the payment instrument's PAN (Primary Account Number).

binstring nullable

The Bank Identification Number (BIN) associated with the payment instrument.

cardHolderNamestring nullable

The name of the cardholder as it appears on the payment instrument.

productMaterialTypestring nullable

The material type of the product (e.g., "plastic", "virtual").