PApayrails
Instruments

Get an instrument by ID

Get instrument by ID.

get/payment/instruments/{instrumentId}

Request

Path parameters

instrumentIdstring uuid required

Identifier of the resource in Payrails.

Query parameters

includeTokensboolean

Boolean indicating if token list should be included in the response.

includeHolderReferenceboolean

Boolean indicating if the holder reference should be included in the response.

Response

Success.

idstring uuid required

Id of the instrument.

createdAtstring date-time required

Date and time when the Instrument was created in Payrails.

updatedAtstring date-time required

When the Instrument was last updated.

holderIdstring uuid required

Unique identifier of the Holder in Payrails.

paymentMethod'alexBankMa7fazty' | 'applePay' | 'audi2pay' | 'bankAccount' | 'card' | 'cibSmartWallet' | 'easypaisa' | 'etisalatCash' | 'fawryMobileWallet' | 'fawryPay' | 'googlePay' | 'jazzCash' | 'nbePhoneCash' | 'orangeCash' | 'payPal' | 'qnbEWallet' | 'weCash' | 'genericRedirect' | 'alfa' | 'konnect' | 'eftPro' | 'netBanking' | 'upi' | 'cashFreeWallet' | 'paytmWallet' | 'phonePe' required

Represents the payment method type.

status'created' | 'deleted' | 'enabled' | 'disabled' | 'transient' required

Status of the instrument.

displayNamestring

Instrument name suitable for display.

descriptionstring

Description of the instrument.

defaultboolean nullable

True if this instrument is set as default for the holder.

merchantReferencestring

Merchant-provided reference for the instrument.

fingerprintstring

System-wide unique identifier of the Instrument. If two Holders have the same instrument stored, this value will be the same for both, but the instrument and token IDs will be different. Cannot be used for payments, should only be used for analytics and fraud prevention.

futureUsage'Subscription' | 'CardOnFile' | 'UnscheduledCardOnFile'

Represents the future usage to define the payment flows that the stored instrument will be used for.

networkTransactionReferencestring

Identifier of the initial payment made with this instrument on the Networks, e.g. Mastercard Trace ID or Visa Transaction ID.

Example response

{
  "data": {
    "bin": "416598",
    "binLookup": {
      "bin": "416598"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.