v1

latestOpenAPI 3.0.12026-07-243407211.3 MB

PaymentInstrument

Get Payment Instrument Details

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

programCodestring required

The program code associated with the account.

accountIdentifierstring required

Unique identifier (UID or GUID) for the account whose payment instrument is being retrieved.

paymentInstrumentIdentifierstring required

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

extendstring

Optional. If set to "privatePaymentInstrumentData", includes sensitive payment instrument data in the response.

usagestring

Optional. Specifies the intended usage context for the payment instrument. Expected values: "cardholder" or "partner".

pciDatastring

Optional. Comma-separated list of PCI data fields to include in the response. Supported values: "pan", "cvv", "exp".

ipAddressstring

Optional. The IPv4 or IPv6 address of the client making the request.

X-GD-RequestIdstring required

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

BaaS-Versionstring

The BaaS API version to use for the request. Supported values: "1.0" or "2.0".