--- title: "Get Transfer by Token (Guest Checkout)" method: POST path: "/programs/{programCode}/transfers/{transferToken}/guestcheckout" tags: ["Transfers"] --- # Get Transfer by Token (Guest Checkout) `POST /programs/{programCode}/transfers/{transferToken}/guestcheckout` Retrieves transfer details using a guest checkout token. Allows partners to access transfer information for users without authentication. ## Path parameters - `programCode` string, required - `transferToken` string, required ## Headers - `X-GD-RequestId` string, required ## Request body - GetTransferByTokenRequest — Represents a request to retrieve transfer details using a unique transfer token. Used to securely look up a transfer by its token, typically for validation, status checks, or to display transfer information to the user. Includes device information for risk assessment, auditing, or fraud prevention. - `device` DeviceInfo — Represents device-specific information used when initiating a transfer or other sensitive operation. Contains details about the device and network, such as device ID, make, model, operating system, and IP addresses. Used for device identification, risk assessment, auditing, and fraud prevention. - `deviceId` string, nullable — The unique identifier assigned to the device (e.g., device UUID or hardware ID). Used to uniquely identify the device making the request. - `deviceMake` string, nullable — The make or manufacturer of the device (e.g., "Apple", "Samsung", "Dell"). - `deviceVersion` string, nullable — The model or version of the device (e.g., "iPhone 14", "Galaxy S22", "Latitude 7420"). - `deviceOS` string, nullable — The operating system running on the device (e.g., "iOS", "Android", "Windows"). - `deviceOSVersion` string, nullable — The version of the operating system running on the device (e.g., "16.4", "13", "11 Pro"). - `ipAddress` string, nullable — The IP address of the device as detected by the application or device itself. Used for geolocation, risk analysis, and fraud prevention. - `customerIP` string, nullable — The customer’s public IP address as seen by the server or network edge. May be used for additional risk analysis or logging. ## Response `200` OK - GetTransferByTokenResponse — Represents the response returned when retrieving transfer details using a unique transfer token. Provides comprehensive information about the transfer, including identifiers, status, type, amount, memo, source and target details, fees, and velocity limit status. Inherits standard response metadata from Gd.Bos.DataTransfer.Response.ResponseBase. - `transferIdentifier` string, nullable — The unique identifier assigned to the transfer. Used for tracking and reference. - `transferStatus` string, nullable — The current status of the transfer (e.g., "pending", "completed", "failed"). - `transferType` string, nullable — The type of transfer (e.g., "A2A", "ACH", "Wire"). - `transferStatusReason` string, nullable — The reason for the current transfer status, if applicable (e.g., "insufficient funds", "limit exceeded"). - `transactionAmount` number, double, nullable — The amount involved in the transfer. - `memo` string, nullable — An optional memo or note associated with the transfer. - `targetInformation` Consumer — Represents consumer information used as the source or target in a transfer operation. Contains account, purse, and personal details, as well as merchant and funding source information. Used to provide context about the sender or recipient in transfer-related APIs, including display and reporting. - `accountIdentifier` string, nullable — The unique identifier of the account associated with the consumer. - `purseIdentifier` string, nullable — The unique identifier of the purse (sub-account or balance container) associated with the consumer. - `purseNumber` string, nullable — The purse number, used for display or reference purposes. - `firstName` string, nullable — The first name of the consumer. - `lastName` string, nullable — The last name of the consumer. - `nickName` string, nullable — An optional nickname for the consumer, used for display or reference. - `handle` string, nullable — The handle or alias of the consumer, if applicable (e.g., username or unique handle). - `merchantName` string, nullable — The name of the merchant, if the consumer is a merchant or the transfer involves a merchant. - `storeNumber` string, nullable — The store number associated with the merchant, if applicable. - `city` string, nullable — The city associated with the consumer, merchant, or transfer. - `state` string, nullable — The state or province associated with the consumer, merchant, or transfer. - `last4Pan` string, nullable — The last four digits of the card number (PAN) associated with the consumer, if applicable. - `association` string, nullable — The association or relationship of the consumer to the transfer (e.g., "primary", "secondary", "joint"). - `fundingSource` string, nullable — The funding source type or description (e.g., "bank", "card", "cash"). - `accountNumber` string, nullable — The account number associated with the consumer, if applicable. - `bankName` string, nullable — The name of the bank associated with the consumer, if applicable. - `status` string, nullable — The current status of the consumer or associated account (e.g., "active", "inactive", "closed"). - `last4AccountNumber` string, nullable — The last four digits of the account number, if applicable. - `purseName` string, nullable — The name of the purse associated with the consumer, if applicable. - `sourceInformation` Consumer — Represents consumer information used as the source or target in a transfer operation. Contains account, purse, and personal details, as well as merchant and funding source information. Used to provide context about the sender or recipient in transfer-related APIs, including display and reporting. - `accountIdentifier` string, nullable — The unique identifier of the account associated with the consumer. - `purseIdentifier` string, nullable — The unique identifier of the purse (sub-account or balance container) associated with the consumer. - `purseNumber` string, nullable — The purse number, used for display or reference purposes. - `firstName` string, nullable — The first name of the consumer. - `lastName` string, nullable — The last name of the consumer. - `nickName` string, nullable — An optional nickname for the consumer, used for display or reference. - `handle` string, nullable — The handle or alias of the consumer, if applicable (e.g., username or unique handle). - `merchantName` string, nullable — The name of the merchant, if the consumer is a merchant or the transfer involves a merchant. - `storeNumber` string, nullable — The store number associated with the merchant, if applicable. - `city` string, nullable — The city associated with the consumer, merchant, or transfer. - `state` string, nullable — The state or province associated with the consumer, merchant, or transfer. - `last4Pan` string, nullable — The last four digits of the card number (PAN) associated with the consumer, if applicable. - `association` string, nullable — The association or relationship of the consumer to the transfer (e.g., "primary", "secondary", "joint"). - `fundingSource` string, nullable — The funding source type or description (e.g., "bank", "card", "cash"). - `accountNumber` string, nullable — The account number associated with the consumer, if applicable. - `bankName` string, nullable — The name of the bank associated with the consumer, if applicable. - `status` string, nullable — The current status of the consumer or associated account (e.g., "active", "inactive", "closed"). - `last4AccountNumber` string, nullable — The last four digits of the account number, if applicable. - `purseName` string, nullable — The name of the purse associated with the consumer, if applicable. - `fees` Fee[], nullable — A list of fees applied to the transfer, including type, amount, currency, and description. - `identifier` string, nullable — The unique identifier for the fee, used for tracking and reference. - `feeType` string, nullable — The type of fee (e.g., "transaction", "service", "maintenance"). - `description` string, nullable — A human-readable description of the fee, explaining its purpose or context. - `amount` number, double — The monetary amount of the fee. - `currency` string, nullable — The ISO 4217 currency code for the fee amount (e.g., "USD"). - `frequency` string, nullable — The frequency with which the fee is applied (e.g., "one-time", "monthly", "annual"). - `localizedDisplayName` string, nullable — The localized display name for the fee, used for UI presentation in different languages or regions. - `velocityLimitStatus` string, nullable — The velocity limit status for the transfer, indicating if any transfer frequency or amount limits have been reached. - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation. - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error). - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error. - `description` string, nullable — A human-readable description of the response, error, or status. - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code. ## Other responses - `401` — Unauthorized - `403` — Forbidden - `500` — Internal Server Error - `503` — Service Unavailable --- [API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/versions/666553766b78/schema)