---
title: "List links by ID"
method: GET
path: "/v1.2/links/linkid/{linkId}"
tags: ["Link"]
---

# List links by ID

`GET /v1.2/links/linkid/{linkId}`

## Request

- Base URL: `https://qa2-partners.greendotcorp.com/Disbursements/API`
- URL: `https://qa2-partners.greendotcorp.com/Disbursements/API/v1.2/links/linkid/{linkId}`
- Auth: none declared. Required headers: `requestid`, `enduserip`, `Authorization`

Retrieves customer and Cash Pickup links by Link ID.

## Path parameters

- `linkId` string, required

## Headers

- `requestid` string, required
- `endusersecurityid` string
- `enduserip` string, required
- `partneridentifier` string
- `Authorization` string, required
- `apikey` string

## Response `200`

OK

- LinksResponseV11: LinksResponse (V1.1)
  - `partnerprogramidentifier` string: partner program Identifier
  - `customerlinks` BaseLinkInfoV11[]: CustomerLinks
    - `customerid` string: CustomerId
    - `linkid` string: DisbursementProfileToken
    - `linkuri` string: DisbursementProfileLinkUri
    - `status` string: Status
    - `fundsavailability` string: Expected availability of funds: IMMEDIATE/NEXT_BUSINESS_DAY/TWO_TO_FIVE_BUSINESS_DAYS
  - `cardlinks` LinkCardInfoV11[]: CardLinks
    - `accounttoken` string
    - `isgdn` boolean: IsGdn, use by Card Profile
    - `accountnumberlast4digits` string: LastFour, use by Card Profile
    - `accountnickname` string: NickName, use by card profile
    - `cardassociationtype` string: CardType
    - `accountstatus` string: Account Status
    - `customerid` string: CustomerId
    - `linkid` string: DisbursementProfileToken
    - `linkuri` string: DisbursementProfileLinkUri
    - `status` string: Status
    - `fundsavailability` string: Expected availability of funds: IMMEDIATE/NEXT_BUSINESS_DAY/TWO_TO_FIVE_BUSINESS_DAYS
  - `bankcardlinks` LinkBankCardInfoV11[]: BankCardLinks
    - `lastfour` string: LastFour, use by bank card Profile
    - `accounttoken` string: AccountToken, used for debit card with keystore encryption
    - `nickname` string: NickName, use by bank card profile
    - `cardtype` string: CardType
    - `firstname` string: FirstName
    - `middlename` string: MiddleName
    - `lastname` string: LastName
    - `expirymonth` string: ExpiryMonth
    - `expiryyear` string: ExpiryYear
    - `address1` string: Address1
    - `address2` string: Address1
    - `city` string: Address1
    - `state` string: Address1
    - `country` string: Address1
    - `postalcode` string: Address1
    - `accountstatus` string: Status
    - `customerid` string: CustomerId
    - `linkid` string: DisbursementProfileToken
    - `linkuri` string: DisbursementProfileLinkUri
    - `status` string: Status
    - `fundsavailability` string: Expected availability of funds: IMMEDIATE/NEXT_BUSINESS_DAY/TWO_TO_FIVE_BUSINESS_DAYS
  - `cashlinks` LinkCashInfoV11[]: CashLinks
    - `recipientfirstname` string: RecipientFirstName, use by cash profile
    - `recipientlastname` string: RecipientLastName, use by cash profile
    - `recipientemail` string: RecipientEmail, use by cash profile
    - `recipientphone` string: RecipientPhone, use by cash profile
    - `recipientidentificationid` string: RecipientIdentificationId, use by cash profile
    - `recipientidentificationtype` string: RecipientIdentificationType, use by cash profile
    - `recipientidentificationissuedby` string: RecipientIdentificationIssuedBy, use by cash profile
    - `recipientidentificationexpirationdate` string, date-time: RecipientIdentificationExpirationDate, use by cash profile
    - `recipientaddress` string: RecipientAddress, use by cash profile
    - `recipientcity` string: RecipientCity, use by cash profile
    - `recipientstate` string: RecipientState, use by cash profile
    - `recipientzipcode` string: RecipientZipCode, use by cash profile
    - `recipientdateofbirth` string, date-time: RecipientDateOfBirth, use by cash profile
    - `recipientsocialsecuritynumber` string: RecipientSocialSecurityNumber, use by cash profile
    - `customerid` string: CustomerId
    - `linkid` string: DisbursementProfileToken
    - `linkuri` string: DisbursementProfileLinkUri
    - `status` string: Status
    - `fundsavailability` string: Expected availability of funds: IMMEDIATE/NEXT_BUSINESS_DAY/TWO_TO_FIVE_BUSINESS_DAYS
  - `gdaccountlinks` LinkGdAccountInfoV11[]: GdAccountLinks
    - `accounttoken` string
    - `customerid` string: CustomerId
    - `linkid` string: DisbursementProfileToken
    - `linkuri` string: DisbursementProfileLinkUri
    - `status` string: Status
    - `fundsavailability` string: Expected availability of funds: IMMEDIATE/NEXT_BUSINESS_DAY/TWO_TO_FIVE_BUSINESS_DAYS
  - `moneypaklinks` LinkMoneyPakInfoV11[]: MoneyPakLinks
    - `pin` string: PinExternId, use by MoneyPak profile
    - `pinreference` string: PinReference
    - `customerid` string: CustomerId
    - `linkid` string: DisbursementProfileToken
    - `linkuri` string: DisbursementProfileLinkUri
    - `status` string: Status
    - `fundsavailability` string: Expected availability of funds: IMMEDIATE/NEXT_BUSINESS_DAY/TWO_TO_FIVE_BUSINESS_DAYS
  - `achlinks` LinkACHInfo[]: ACHLinks
    - `recipientfirstname` string: RecipientFirstName, use by ACH profile
    - `recipientlastname` string: RecipientLastName, use by ACH profile
    - `recipientaddress` string: RecipientAddress, use by ACH profile
    - `recipientcity` string: RecipientCity, use by ACH profile
    - `recipientstate` string: RecipientState, use by ACH profile
    - `recipientzipcode` string: RecipientZipCode, use by ACH profile
    - `routingnumber` string: RoutingMember, use by ACH profile
    - `accountnumber` string: AccountNumber, use by ACH profile
    - `accounttype` integer: Bank AccountType Key, 1: Checking 2: Saving
    - `customerid` string: CustomerId
    - `linkid` string: DisbursementProfileToken
    - `linkuri` string: DisbursementProfileLinkUri
    - `status` string: Status
    - `fundsavailability` string: Expected availability of funds: IMMEDIATE/NEXT_BUSINESS_DAY/TWO_TO_FIVE_BUSINESS_DAYS
  - `responsecode` integer: Specifies the status of a Disbursement Core Service Service operation
  - `responsemessage` string: Specifies the descriptive text on the status of a Disbursement Core Service operation
  - `responsedate` string, date-time: RespnseDate
  - `responsedetail` TransferApiResponseDetail: TransferApiResponseDetail
    - `responsedetailcode` integer: ResponseDetailCode
    - `responsedetaildescription` string: ResponseDetailDescription

---

[API](https://skmtc.dev/greendot/apis/cash-pickup-apis-new.md) - [All operations](https://skmtc.dev/greendot/apis/cash-pickup-apis-new/llms.txt) - [OpenAPI document](https://skmtc.dev/greendot/apis/cash-pickup-apis-new/revisions/026e836b67c9?raw)