# Green Dot API Developer Portal Documentation ## Guides - [Account & User Management Overview](https://developer.greendot.com/embedded-finance/docs/account-user-management-overview.md) - [Accounts](https://developer.greendot.com/embedded-finance/docs/accounts.md): Accounts APIs can be used for account management and account insights related functions. - [External Accounts](https://developer.greendot.com/embedded-finance/docs/external-accounts.md) - [Error Codes & Valid Characters](https://developer.greendot.com/embedded-finance/docs/error-codes-valid-characters.md) - [Joint Accounts API](https://developer.greendot.com/embedded-finance/docs/joint-accounts-api.md) - [Purses](https://developer.greendot.com/embedded-finance/docs/purses.md) - [Statements & Documents](https://developer.greendot.com/embedded-finance/docs/statements-and-documents.md): These APIs can be used to retrieve eStatements and tax forms. - [Transaction History](https://developer.greendot.com/embedded-finance/docs/transaction-history.md) - [Users](https://developer.greendot.com/embedded-finance/docs/users-1.md) - [eWallet Tokens](https://developer.greendot.com/embedded-finance/docs/ewallet-tokens.md) - [Inventory Order Management](https://developer.greendot.com/embedded-finance/docs/inventory-order-management.md): Inventory Order Management APIs can be used for retrieving inventory order information. - [Payment Instruments](https://developer.greendot.com/embedded-finance/docs/payment-instruments.md): Payment Instruments APIs can be used for managing cashback rewards. - [DEPRECATED pciConfig API](https://developer.greendot.com/embedded-finance/docs/deprecated-pciconfig-api.md): This pciConfig API has been deprecated and is only provided for some existing partners as reference. - [Hosted UX API](https://developer.greendot.com/embedded-finance/docs/hosted-ux-api.md) - [BaaS API Authentication](https://developer.greendot.com/embedded-finance/docs/baas-api-authentication.md) - [Encryption in BaaS API](https://developer.greendot.com/embedded-finance/docs/encryption-in-baas-api.md): This document provides a comprehensive overview of the encryption mechanisms employed in the Banking-as-a-Service (BaaS) API to ensure the confidentiality and security of sensitive data during transmission. It details the encryption setup, workflow for encrypting and decrypting data, the structure of encrypted payloads, and practical examples with code snippets primarily in C# using the BouncyCastle library. - [Healthcheck APIs](https://developer.greendot.com/embedded-finance/docs/healthcheck-apis.md): Healthcheck APIs are used to check if the downstream service is available, or if Green Dot servers are reachable. - [Idempotency](https://developer.greendot.com/embedded-finance/docs/idempotency.md) - [Business Rule Response Codes](https://developer.greendot.com/embedded-finance/docs/business-rule-response-codes.md) - [Enumeration Definitions](https://developer.greendot.com/embedded-finance/docs/enumeration-defitions.md) - [Full PCI Data Access V2](https://developer.greendot.com/embedded-finance/docs/full-pci-data-access-v2.md) - [Mitigating Fraud](https://developer.greendot.com/embedded-finance/docs/mitigating-fraud.md) - [API Call Structure Field Definitions](https://developer.greendot.com/embedded-finance/docs/structure-of-api-calls-field-definitions.md) - [eCash APIs](https://developer.greendot.com/embedded-finance/docs/ecash-1.md) - [Account Creation Overview](https://developer.greendot.com/embedded-finance/docs/enrollments-1.md): Account Creation involves enrollment APIs that can be used to enroll into the many API services hosted by <>. - [Enrollment APIs](https://developer.greendot.com/embedded-finance/docs/enrollments-api-endpoints.md): This guide explains how to enroll end users using the Enrollments APIs, including identity requirements, validation rules, and common enrollment scenarios. - [KYB (Know Your Business)](https://developer.greendot.com/embedded-finance/docs/kyb.md): KYB (Know Your Business) flow can be used for enrolling customers who own small businesses. - [KYC (Know Your Customer)](https://developer.greendot.com/embedded-finance/docs/kyc-1.md): This guide explains how Know Your Customer (KYC) verification works in Green Dot Embedded Finance, how to interpret KYC/OFAC results, and what actions partners should take next. For full request/response schemas for KYC endpoints, use the API Reference for each endpoint. - [Android Socure SDK](https://developer.greendot.com/embedded-finance/docs/android-socure-sdk.md) - [Callback Methods](https://developer.greendot.com/embedded-finance/docs/callback-methods.md) - [iOS Socure SDK](https://developer.greendot.com/embedded-finance/docs/ios-socure-sdk.md) - [Socure SDK Integration](https://developer.greendot.com/embedded-finance/docs/socure-sdk-integration-1.md) - [Web Socure SDK](https://developer.greendot.com/embedded-finance/docs/web-socure-sdk.md) - [External Card Management APIs](https://developer.greendot.com/embedded-finance/docs/external-card-management.md) - [BaaS APIs Overview](https://developer.greendot.com/embedded-finance/docs/baas-apis-overview.md) - [Example Enrollment & Integration Flow](https://developer.greendot.com/embedded-finance/docs/non-kyc.md) - [Sandbox Environment](https://developer.greendot.com/embedded-finance/docs/sandbox-environment.md) - [Testing](https://developer.greendot.com/embedded-finance/docs/testing.md) - [Adjustments](https://developer.greendot.com/embedded-finance/docs/adjustment.md) - [Instant Transfer Service](https://developer.greendot.com/embedded-finance/docs/instant-transfer-service.md) - [Transfers](https://developer.greendot.com/embedded-finance/docs/transfers-1.md): Transfers APIs can be used to enable customers to move funds to and from internal accounts, purses, and external bank accounts. - [ACH](https://developer.greendot.com/embedded-finance/docs/ach.md): ACH APIs can be used for ACH transfers. - [BillPay](https://developer.greendot.com/embedded-finance/docs/billpay-1.md) - [MRDC Funding](https://developer.greendot.com/embedded-finance/docs/mrdc-funding.md): MRDC Funding APIs can be used for funding MRDC transactions, as well as general MRDC transfers information. - [MRDC](https://developer.greendot.com/embedded-finance/docs/mrdc.md): MRDC APIs can be used to manage MRDC transfers. - [Paper Checks](https://developer.greendot.com/embedded-finance/docs/paper-checks.md): Paper Checks APIs can be used for paper check related functions. - [Closed Loop P2P](https://developer.greendot.com/embedded-finance/docs/p2p.md): P2P (Peer to Peer) APIs can be used to obtain P2P Transfer details, or reverse a disbursement. - [PNT APIs](https://developer.greendot.com/embedded-finance/docs/pnt-api-methods.md) - [Auto Money Movement](https://developer.greendot.com/embedded-finance/docs/auto-money-movement.md): Auto Money Movement APIs can be used for managing Auto Money Movement rules. - [Cashback Rewards](https://developer.greendot.com/embedded-finance/docs/cashback-rewards.md): Cashback Rewards APIs can be used for managing cashback rewards. - [Customer Care](https://developer.greendot.com/embedded-finance/docs/customer-care.md): Customer Care APIs can be used for creating customer support cases, customizing UI for customer support, and enabling customers to create support cases. - [Direct Deposit Switch](https://developer.greendot.com/embedded-finance/docs/direct-deposit-switch.md) - [Interest Rate](https://developer.greendot.com/embedded-finance/docs/interest-rate.md): Interest Rate APIs can be used for any functions related to adding and managing interest rates to primary and savings purses. - [Optional API Add-Ons](https://developer.greendot.com/embedded-finance/docs/optional-api-add-ons.md) - [Overdraft Protection (ODP)](https://developer.greendot.com/embedded-finance/docs/overdraft-protection-odp.md) - [ATM & Retail Locators](https://developer.greendot.com/embedded-finance/docs/retail-atm-locators.md): ATM & Retail Locator APIs can be used for locating ATM and retail locations. - [Transaction Webhook Samples](https://developer.greendot.com/embedded-finance/docs/transaction-webhooks.md): Transaction webhhoks are used to provide event notifications for various transaction types. - [Webhook Samples](https://developer.greendot.com/embedded-finance/docs/webhook-samples.md): Webhooks can be used to provide event notifications. - [Webhooks Overview](https://developer.greendot.com/embedded-finance/docs/webhooks-overview.md) - [Authentication](https://developer.greendot.com/embedded-finance/docs/authentication-8.md) - [Barcode Generation](https://developer.greendot.com/embedded-finance/docs/barcode-generation-2.md) - [Overview](https://developer.greendot.com/embedded-finance/docs/overview-5.md) - [Response Codes](https://developer.greendot.com/embedded-finance/docs/response-codes-4.md) - [UX Examples](https://developer.greendot.com/embedded-finance/docs/ux-examples.md) - [Barcode Generation](https://developer.greendot.com/embedded-finance/docs/barcode-generation-1.md) - [Barcode Lookup](https://developer.greendot.com/embedded-finance/docs/barcode-lookup.md) - [Ping](https://developer.greendot.com/embedded-finance/docs/ping-6.md) - [Retailers](https://developer.greendot.com/embedded-finance/docs/retailers.md) - [Stores](https://developer.greendot.com/embedded-finance/docs/stores.md) - [Authentication](https://developer.greendot.com/embedded-finance/docs/authentication-5.md) - [Environments](https://developer.greendot.com/embedded-finance/docs/environments-1.md) - [Headers & Common Fields](https://developer.greendot.com/embedded-finance/docs/headers-1.md) - [Overview](https://developer.greendot.com/embedded-finance/docs/overview-2.md) - [Response Codes](https://developer.greendot.com/embedded-finance/docs/response-codes-1.md) - [Cash Deposits and Payments Overview](https://developer.greendot.com/embedded-finance/docs/cash-deposits-and-payments-overview.md) - [Cash Deposits and Payments Methods](https://developer.greendot.com/embedded-finance/docs/cash-deposits-and-payments.md) - [Customer Lookup](https://developer.greendot.com/embedded-finance/docs/customer-lookup.md) - [Stores](https://developer.greendot.com/embedded-finance/docs/stores-1.md) - [Authentication](https://developer.greendot.com/embedded-finance/docs/authentication-7.md) - [Environments](https://developer.greendot.com/embedded-finance/docs/environments.md) - [Overview](https://developer.greendot.com/embedded-finance/docs/overview-4.md) - [Auth](https://developer.greendot.com/embedded-finance/docs/auth.md) - [AuthCommit](https://developer.greendot.com/embedded-finance/docs/authcommit-1.md) - [AuthVoid](https://developer.greendot.com/embedded-finance/docs/authvoid.md) - [Ping](https://developer.greendot.com/embedded-finance/docs/ping-7.md) - [Authentication](https://developer.greendot.com/embedded-finance/docs/authentication-6.md) - [Environment Settings](https://developer.greendot.com/embedded-finance/docs/environment-settings.md) - [Overview](https://developer.greendot.com/embedded-finance/docs/overview-3.md) - [Response Codes](https://developer.greendot.com/embedded-finance/docs/response-codes-2.md) - [Troubleshooting](https://developer.greendot.com/embedded-finance/docs/troubleshooting.md) - [AccessToken](https://developer.greendot.com/embedded-finance/docs/access-token.md) - [AuthCommit](https://developer.greendot.com/embedded-finance/docs/authcommit.md) - [API Methods](https://developer.greendot.com/embedded-finance/docs/api-methods.md) - [Notification](https://developer.greendot.com/embedded-finance/docs/notification-1.md) - [Transaction Status](https://developer.greendot.com/embedded-finance/docs/transaction-status.md) - [Void](https://developer.greendot.com/embedded-finance/docs/void.md) - [Authentication](https://developer.greendot.com/embedded-finance/docs/authentication-3.md) - [Common Entities](https://developer.greendot.com/embedded-finance/docs/common-entities.md) - [Barcode Consumption](https://developer.greendot.com/embedded-finance/docs/barcode-consumption.md) - [Response & Error Codes](https://developer.greendot.com/embedded-finance/docs/response-error-codes-1.md) - [Customer Links](https://developer.greendot.com/embedded-finance/docs/customer-links.md) - [Customer Profile](https://developer.greendot.com/embedded-finance/docs/customers.md) - [API Methods](https://developer.greendot.com/embedded-finance/docs/api-calls.md) - [Transfers](https://developer.greendot.com/embedded-finance/docs/transfers-3.md) - [Authentication](https://developer.greendot.com/embedded-finance/docs/authentication.md) - [Headers](https://developer.greendot.com/embedded-finance/docs/headers.md) - [Barcode Generation](https://developer.greendot.com/embedded-finance/docs/barcode-generation.md) - [Response & Error Codes](https://developer.greendot.com/embedded-finance/docs/response-error-codes.md) - [Cash Pickup Overview](https://developer.greendot.com/embedded-finance/docs/cashpickup-overview.md) - [ACH Transfers Methods](https://developer.greendot.com/embedded-finance/docs/existing-ach-transfers-methods.md) - [Disbursements Overview](https://developer.greendot.com/embedded-finance/docs/disbursements-overview.md) - [Create Recipients](https://developer.greendot.com/embedded-finance/docs/create-recipients.md) - [Executing Transfers](https://developer.greendot.com/embedded-finance/docs/executing-transfers.md) - [Linking Payee Accounts](https://developer.greendot.com/embedded-finance/docs/linking-payee-accounts.md) - [Maintenance & Status](https://developer.greendot.com/embedded-finance/docs/maintenance-status.md) - [Single Phase Transfer with Webhooks](https://developer.greendot.com/embedded-finance/docs/single-phase-transfer-with-webhooks.md) - [Green Dot API Platform Overview](https://developer.greendot.com/embedded-finance/docs/apis-overview.md) - [Release Notes](https://developer.greendot.com/embedded-finance/docs/release-notes.md) - [Terms of Use](https://developer.greendot.com/embedded-finance/docs/terms-of-use.md) - [Direct Deposit Form](https://developer.greendot.com/embedded-finance/docs/direct-deposit-form.md) - [Get Customer Info](https://developer.greendot.com/embedded-finance/docs/get-customer-info.md) - [Get Direct Deposit Info](https://developer.greendot.com/embedded-finance/docs/get-direct-deposit-info.md) - [Idv Document Url Request](https://developer.greendot.com/embedded-finance/docs/idv-document-url-request.md) - [Idv Upload Result](https://developer.greendot.com/embedded-finance/docs/idv-upload-result.md) - [Idv Upload](https://developer.greendot.com/embedded-finance/docs/idv-upload.md) - [Sale Card](https://developer.greendot.com/embedded-finance/docs/sale-card.md) - [Validate Registration](https://developer.greendot.com/embedded-finance/docs/validate-registration.md) - [Replace Card](https://developer.greendot.com/embedded-finance/docs/replace-card.md) - [Search](https://developer.greendot.com/embedded-finance/docs/search-2.md) - [Cash PickUp Auth](https://developer.greendot.com/embedded-finance/docs/cash-pickup-auth.md) - [Cash PickUp Commit](https://developer.greendot.com/embedded-finance/docs/cash-pickup-commit.md) - [Cash PickUp Details](https://developer.greendot.com/embedded-finance/docs/cash-pickup-details.md) - [Get Card Info](https://developer.greendot.com/embedded-finance/docs/get-card-info.md) - [Reload](https://developer.greendot.com/embedded-finance/docs/reload-1.md) - [Return](https://developer.greendot.com/embedded-finance/docs/return-1.md) - [Unload](https://developer.greendot.com/embedded-finance/docs/unload-1.md) - [Validate Card For Unload](https://developer.greendot.com/embedded-finance/docs/validate-card-for-unload.md) - [Validate Unload Eligibility](https://developer.greendot.com/embedded-finance/docs/validate-unload-eligibility.md) - [Void](https://developer.greendot.com/embedded-finance/docs/void-2.md) - [Ping](https://developer.greendot.com/embedded-finance/docs/ping-check.md) - [Associate Retail Chain User With Card](https://developer.greendot.com/embedded-finance/docs/associate-retail-chain-user-with-card.md) - [Create Retail Chain User](https://developer.greendot.com/embedded-finance/docs/create-retail-chain-user.md) - [Get Retail Chain User Info](https://developer.greendot.com/embedded-finance/docs/get-retail-chain-user-info.md) - [Get EStatement List](https://developer.greendot.com/embedded-finance/docs/get-estatement-list.md) - [Get Transaction History](https://developer.greendot.com/embedded-finance/docs/get-transaction-history.md) - [Get Transaction Info](https://developer.greendot.com/embedded-finance/docs/get-transaction-info.md) - [Get EStatement Files](https://developer.greendot.com/embedded-finance/docs/getestatementfiles-1.md) - [Authentication](https://developer.greendot.com/embedded-finance/docs/authentication-4.md) - [Financial Service Centers (FSC) Overview](https://developer.greendot.com/embedded-finance/docs/overview-1.md) - [Response Codes](https://developer.greendot.com/embedded-finance/docs/response-codes.md) - [Retailers Overview](https://developer.greendot.com/embedded-finance/docs/retail-overview.md) - [Standard Metadata](https://developer.greendot.com/embedded-finance/docs/standard-metadata.md) - [Get Package Details](https://developer.greendot.com/embedded-finance/docs/get-package-details.md) - [Package Sale](https://developer.greendot.com/embedded-finance/docs/package-sale.md) - [Barcode Payment](https://developer.greendot.com/embedded-finance/docs/barcode-payment.md) - [Get Barcode Details](https://developer.greendot.com/embedded-finance/docs/get-barcode-details.md) - [Get Card Details](https://developer.greendot.com/embedded-finance/docs/get-card-details.md) - [Point of Banking Payment](https://developer.greendot.com/embedded-finance/docs/point-of-banking-payment.md) - [Reload](https://developer.greendot.com/embedded-finance/docs/reload-2.md) - [Void](https://developer.greendot.com/embedded-finance/docs/void-3.md) - [Ping](https://developer.greendot.com/embedded-finance/docs/ping-2.md) ## API Reference - [Delete External Card](https://developer.greendot.com/embedded-finance/reference/account_delete_deleteexternalcard.md): This endpoint allows a specific external card to be deleted from an account. Simply call DELETE /externalCards/{cardIdentifier} and include the accountIdentifier and cardIdentifier - [Get Account IDs by Partner Consumer ID](https://developer.greendot.com/embedded-finance/reference/account_get_accountlookuppartnerconsumeridentifier.md): This endpoint allows partners to get a list of BaaS Account IDs based on external consumer IDs provided during Enrollment (Account.PartnerConsumerId). - [Get Account Details](https://developer.greendot.com/embedded-finance/reference/account_get_getaccount.md): This endpoint allows the retrieval of detailed information about a specific account. If the GET request is successful, the following response message will be returned along with a 200 HTTP status code. Note:UpgradeKycStateData will be return when customer upgrade their account to DDA - [Get Account Fee Summary](https://developer.greendot.com/embedded-finance/reference/account_get_getaccountfees.md): This endpoint allows to retrieve the fee summary of certian account. It returns the prior month fees and the year-to-date fees in this fee summary. **Http Status Codes**
Status CodeCodeSub CodeDescription
20000API operation was successful.
401Unauthorized: authorization prefix none bearer
401Unauthorized: invalid authorization format
401Unauthorized: invalid authorization token
401Unauthorized: expired authorization token
401Unauthorized: out of credential scopes
401Unauthorized: invalid program code
404100Account Not Found.
40010000The program code in the API path is unknown.
50346104611PRODUCT_NOT_SUPPORT_FEE
- [Get Account Details for Showcase](https://developer.greendot.com/embedded-finance/reference/account_get_getaccountforshowcase.md): Retrieves account information for display in showcase scenarios. Used for limited or demo account views. - [Get Account Type](https://developer.greendot.com/embedded-finance/reference/account_get_getaccounttype.md): Retrieves the type of the specified account, such as checking, savings, or other supported types. Useful for partners to determine account capabilities. - [Get ACH Transfers](https://developer.greendot.com/embedded-finance/reference/account_get_getachtransfer.md): This endpoint allows the retrieval of a list of transfers for an account. Note: The maximum number of transfers in a list is 180 per request. If the GET request is successful, the following response message will be returned along with a 200 HTTP status code. Filtering ACH Transfers ACH transfers can be filtered based on the following ACH Transfer Statuses, so specific ACH transfers can be viewed by the Partner. If GET /achTransfers is called and the status provided is one or more of the valid ACH Transfer Statuses (listed above), then the response will contain the ACH transfers within the selected (or defaulted) date range that have an ACH Transfer Status that matches one of the statuses that was provided in the call. - [Get All External Cards](https://developer.greendot.com/embedded-finance/reference/account_get_getallexternalcards.md): Retrieves all external debit or credit cards linked to the specified account. Returns card details and status for each linked card. - [Get All P2P Transfers](https://developer.greendot.com/embedded-finance/reference/account_get_getallp2ptransfer.md): - Retrieves a list of P2P transfers This API is used to retrieve information about P2P requests between two different account holders within a program. It should be used to retrieve a list of P2Ps that could still be: - Accepted by the recipient - Cancelled by the sender - Rejected by the recipient - Expired by the system - [Get Auth Customer Enrollment](https://developer.greendot.com/embedded-finance/reference/account_get_getauthcustomerenrollment.md): Retrieves the enrollment information for the specified user on the account. - [Get Auth Customer SSO Token](https://developer.greendot.com/embedded-finance/reference/account_get_getauthcustomerssotoken.md): Retrieves a Single Sign-On (SSO) token for the specified user on the account. - [Get Check Images](https://developer.greendot.com/embedded-finance/reference/account_get_getcheckimages.md): Retrieves a full color or grayscale image of a check for a specific MRDC transfer. - [Get eStatement PDF](https://developer.greendot.com/embedded-finance/reference/account_get_getestatement.md): This endpoint allows the retrieval of a PDF statement for an account and for a given period. The PDF will be base64 coded and it will return the transaction details on all transaction types. If the GET request is successful, the following response message will be returned along with a 200 HTTP status code Programs configured for the Interest Rate feature only: - The following changes will be made to the eStatement interest details section: - Interest Paid this Period changed to Interest Earned this Period - Interest Paid Year to Date – Will reflect the posted YTD interest total amount - [Get Fund Fulfillment MRDC Transfer](https://developer.greendot.com/embedded-finance/reference/account_get_getfundfulfillmentmrdctransfer.md): Get Fund Fulfillment MRDC Transfer - [Get Fund Fulfillment MRDC Transfer List](https://developer.greendot.com/embedded-finance/reference/account_get_getfundfulfillmentmrdctransferlist.md): Retrieves a paginated list of fund fulfillment MRDC transfers for the specified account, filtered by date range. Returns transfer details and status. - [Get Linked Account](https://developer.greendot.com/embedded-finance/reference/account_get_getlinkedaccount.md): Retrieves all linked accounts for the specified account, including account link type and status. - [Get Linked Accounts Info](https://developer.greendot.com/embedded-finance/reference/account_get_getlinkedaccountsinfo.md): Retrieves detailed information about accounts linked to the specified account. Optionally includes sensitive payment instrument data and additional details. - [Get eStatements List](https://developer.greendot.com/embedded-finance/reference/account_get_getlistestatement.md): Structure of API Call: GET /programs/{programCode}/accounts/{accountIdentifier}/statements - List Available Statements for an Account This endpoint allows a list of available statements to be retrieved If the GET request is successful, the following response message will be returned along with a 200 HTTP status code. Note: If a statement is not available, and the accountIdentifier exists, then an empty list will be returned along with the 200 HTTP status code. If the accountIdentifier does not exist, a 404 HTTP status code will be returned. **eStatements List** All available eStatements will be included in the accountholder’s online Statements list. The Statements list may become long over time, so it is recommended that Partners: - Limit the list to 2 years or less - Implement a hide/unhide tab for accountholders to view eStatements older than 2 years - [Get Tax Document List (by Type)](https://developer.greendot.com/embedded-finance/reference/account_get_getlisttaxdocument.md): - Retrieve tax documents for the account by type Note: Contact your Green Dot liaison for assistance with configuration. - [Get Tax Document List (INT-1099)](https://developer.greendot.com/embedded-finance/reference/account_get_getlisttaxdocumentnodoctype.md): - Retrieve an INT-1099 form This endpoint allows the retrieval of an INT-1099 form. INT-1099 forms are only available for interest-bearing accounts that earn $10 USD or more in interest per year. Note: Contact your Green Dot liaison for assistance with configuration. - [Get MRDC Transfer](https://developer.greendot.com/embedded-finance/reference/account_get_getmrdctransfer.md): This endpoint allows retrieval of MRDC related transfers, one at a time, for an account. - Allows retrieval of MRDC related transfers - [Get MRDC Transfer List](https://developer.greendot.com/embedded-finance/reference/account_get_getmrdctransferlist.md): After a check is submitted and the checkDepositStatus is either pending or in review, this endpoint forces the customer to either accept or cancel the check deposit request. - Accept or Cancel Check Deposit Request - [Get MRDC Transfers On Hold](https://developer.greendot.com/embedded-finance/reference/account_get_getonholdtransfers.md): Retrieves a list of MRDC (Mobile Remote Deposit Capture) transfers that are currently on hold for the specified account. Returns transfer details and status. - [Get P2P Transfer](https://developer.greendot.com/embedded-finance/reference/account_get_getp2ptransfer.md): Retrieves details for a specific P2P (peer-to-peer) transfer by transfer identifier for the given account. Returns transfer status, amount, and participant information. - [Get Tax Document (by Type)](https://developer.greendot.com/embedded-finance/reference/account_get_gettaxdocument.md): - Retrieve different type form for a specific year This endpoint allows the retrieval of different type form for a specific year. Like INT-1099,S-1042 forms,etc. Note: Contact your Green Dot liaison for assistance with configuration. - [Get Tax Document (INT-1099)](https://developer.greendot.com/embedded-finance/reference/account_get_gettaxdocumentnodoctype.md): - Retrieve an INT-1099 form for a specific year This endpoint allows the retrieval of an INT-1099 form for a specific year. INT-1099 forms are only available for interest-bearing accounts that earn $10 USD or more in interest per year. Note: Contact your Green Dot liaison for assistance with configuration. - [Get Users](https://developer.greendot.com/embedded-finance/reference/account_get_getusers.md): This endpoint allows the retrieval of the users’ profile information, associated with a specific account. Request Parameters - Retrieve profile information for all associated users See Structure of API Calls for details. Response Message - If the GET request is successful, the following response message will be returned along with a 200 HTTP status code. - [OD Eligibility Check](https://developer.greendot.com/embedded-finance/reference/account_get_odeligibilitycheck.md): Performs an overdraft eligibility check for the specified account based on the inquiry date. - [Add Account Holder](https://developer.greendot.com/embedded-finance/reference/account_post_addaccountholder.md): This endpoint allows an account holder to be added to an existing account.Account must have the ability to be a joint account and not be a corp account.Account holder must first pass a validation check if validation check is successful, the account holder will be created and the request will returned the account holders linked to the account. - [Execute KYC](https://developer.greendot.com/embedded-finance/reference/account_post_executekyc.md): Performs Know Your Customer (KYC) verification for a user on the account. Requires encrypted KYC details in the request body. - [Search Account](https://developer.greendot.com/embedded-finance/reference/account_post_searchaccount.md): Searches for accounts based on encrypted search criteria. Requires a valid program code and search details in the request body. Returns a list of accounts matching the search parameters. - [Update ITIN](https://developer.greendot.com/embedded-finance/reference/account_post_updateitin.md): Structure of API Call: POST /accounts/{accountIdentifier}/users/{userIdentifier}/identity This endpoint allows an Individual Taxpayer Identification Number (ITIN) to be added to a customer’s account that originally enrolled using a Mexican Matricula ID only. This is primarily for U.S. tax purposes. ITIN Limits: - Up to 1 active account with the same ITIN per consumer program is allowed - Up to 3 lifetime accounts with the same ITIN per consumer program are allowed - [Update Account Status to Restricted](https://developer.greendot.com/embedded-finance/reference/account_put_closeaccount.md): This endpoint provides the ability to close accounts without the assistance of the Green Dot Care team. - Close an Account - To set an account to restricted customer initiated spend down: - Submit a request to close the account by calling PUT /programs/{programCode}/accounts/{accountIdentifier}/close - Once the request is processed by the system, the partner will receive a response containing the following account status information: - The account status will be changed to restricted - The account status reason will be customerInitiatedSpendDown - There will not be a kycPendingGate (cure) (i.e. kycPendingGate: none) - All funds currently in the spend purses will be moved back to the primary purse automatically. - Note: For an account to be closed, it must be set to a restricted customer initiated spend down state. - The current status of the account must be normal. - An account with a negative balance cannot be closed using the API - [Update Account Status and Reason](https://developer.greendot.com/embedded-finance/reference/account_put_setpartneraccountstatus.md): Structure of API Call: PUT /programs/{programCode}/accounts/{accountIdentifier}/status - Update account status and status reason This endpoint allows Partners to update account statuses, account status reasons, and cures under certain conditions. When a valid request is submitted and completed successfully, the updated status, status reason, and kycPendingGate will be returned in GET /accounts/{accountIdentifier} and GET /enrollments/accounts/{accountIdentifier} responses. An Account Updated Webhook will also be published. Note: This endpoint can only be used if the Partner is configured to change statuses. - [Update Account Terms Acceptances](https://developer.greendot.com/embedded-finance/reference/account_put_updateaccount.md): This endpoint can be used to assign account identifiers to customer accounts or to opt in or out of any terms or agreements that were agreed to or declined during enrollment - [Update Check](https://developer.greendot.com/embedded-finance/reference/account_put_updatecheck.md): After a check is submitted and the checkDepositStatus is either pending or in review, this endpoint forces the customer to either accept or cancel the check deposit request. - Accept or Cancel Check Deposit Request - [Update User](https://developer.greendot.com/embedded-finance/reference/account_put_updateuser.md): Structure of API Call: PUT /programs/{programCode}/accounts/{accountIdentifier}/users/{userIdentifier} - Updates Select Properties of a User This endpoint gives the partner the ability to update an existing user’s information. - [Process Accrued Interest – Processes accrued interest calculations for a program.](https://developer.greendot.com/embedded-finance/reference/accruedinterest_post_processaccruedinterest.md): Processes accrued interest calculations for accounts within a program. Allows specifying a date range and override flag. Returns the processing status, progress, and interest accrued. - [Retrieves the status of a previously submitted balance adjustment request.](https://developer.greendot.com/embedded-finance/reference/adjustment_get_getadjustbalancestatus.md): Check the Status of Adjustments to BaaS Account Balances - [Creates a balance adjustment for the specified account. Supports adjustment types such as promo, instructionCredit, disbursement, achOut, and their reversals.](https://developer.greendot.com/embedded-finance/reference/adjustment_post_adjustbalance.md): The following adjustment types must be specifically configured for a program code in order to be used by a partner. - promo and promoReversal - instructionCredit and instructionDebit - disbursement, disbursementReversal - anyDebitOut, anyDebitOutReversal - achOut, achOutReversal If an adjustmentType has not been configured for a program code, then the request will be rejected. If you have any further questions, please contact your Green Dot Product liaisons. Request Parameters. - [Delete Affiliate](https://developer.greendot.com/embedded-finance/reference/affiliate_delete_deleteaffiliate.md): Deletes a specific affiliate for the specified program. - [Delete Affiliate Settlement](https://developer.greendot.com/embedded-finance/reference/affiliate_delete_deleteaffiliatesettlement.md): Deletes a specific affiliate settlement for the specified program. - [Get Affiliate](https://developer.greendot.com/embedded-finance/reference/affiliate_get_getaffiliate.md): Retrieves the details of a specific affiliate for the specified program. - [Get Affiliate Settlement](https://developer.greendot.com/embedded-finance/reference/affiliate_get_getaffiliatesettlement.md): Retrieves the details of a specific affiliate settlement for the specified program. - [Get Affiliates List](https://developer.greendot.com/embedded-finance/reference/affiliate_get_getaffiliateslist.md): Retrieves the list of affiliates for the specified program. - [Create Affiliate](https://developer.greendot.com/embedded-finance/reference/affiliate_post_createaffiliate.md): Creates a new affiliate for the specified program. - [Create Affiliate Settlement](https://developer.greendot.com/embedded-finance/reference/affiliate_post_createaffiliatesettlement.md): Creates a new affiliate settlement for the specified program. - [Update Affiliate](https://developer.greendot.com/embedded-finance/reference/affiliate_put_updateaffiliate.md): Updates an existing affiliate for the specified program. - [Update Affiliate Settlement](https://developer.greendot.com/embedded-finance/reference/affiliate_put_updateaffiliatesettlement.md): Updates an existing affiliate settlement for the specified program. - [Delete an AMM rule](https://developer.greendot.com/embedded-finance/reference/ammrule_delete_deleterule.md): Deletes an Auto Money Movement (AMM) rule for the specified account and rule ID. - [Get AMM rules for a given account identifier](https://developer.greendot.com/embedded-finance/reference/ammrule_get_getrulesbyaccountid.md): Retrieves the Auto Money Movement (AMM) rules for the specified account and rule status. - [Get AMM rules by target account identifier](https://developer.greendot.com/embedded-finance/reference/ammrule_get_getrulesbytargetaccountid.md): Retrieves the Auto Money Movement (AMM) rules for the specified target account, with optional filters for rule status, transfer type, and rule IDs. - [Create a new AMM rule for an account](https://developer.greendot.com/embedded-finance/reference/ammrule_post_createrule.md): Adds a new Auto Money Movement (AMM) rule to the specified account. Once applied, money can be automatically moved based on the rule parameters. - [Update an existing AMM rule](https://developer.greendot.com/embedded-finance/reference/ammrule_put_updaterule.md): Updates the details of an existing Auto Money Movement (AMM) rule for the specified account and rule ID. - [Bulk update AMM rule priorities](https://developer.greendot.com/embedded-finance/reference/ammrule_put_updaterulepriority.md): Updates the priorities of multiple Auto Money Movement (AMM) rules for the specified account. - [Update the status of an AMM rule](https://developer.greendot.com/embedded-finance/reference/ammrule_put_updaterulestatus.md): Updates the status, name, maximum cap amount, or fixed transfer amount for a specific Auto Money Movement (AMM) rule based on rule ID. - [Delete Payee](https://developer.greendot.com/embedded-finance/reference/billpay_delete_deletepayee.md): Deletes an existing payee from a user’s account using the payeeIdentifier. Once the payee is deleted, all associated scheduled bill payments will be canceled as well. - [Delete Scheduled Bill Payment](https://developer.greendot.com/embedded-finance/reference/billpay_delete_deletepayment.md): Deletes or cancels a scheduled bill payment using the paymentIdentifier. Both one-time and recurring scheduled bill payments can be deleted. Once deleted, the payment will no longer be processed or available for future operations. - [Get Payee by Payee Identifier](https://developer.greendot.com/embedded-finance/reference/billpay_get_getpayee.md):
•Retrieves payee information for a given payee identifier.
•If a customer has been enrolled in BillPay and has added at least one Payee,
•call the endpoint and include the payeeID.
•The API will use the payeeID provided to retrieve and return the associated Payee information in the response. - [Get Payee List](https://developer.greendot.com/embedded-finance/reference/billpay_get_getpayeelist.md): Retrieves all active payees for a given account. This endpoint allows a list of all active payees to be retrieved according to their accountIdentifier. - [Get Payment](https://developer.greendot.com/embedded-finance/reference/billpay_get_getpayment.md): Retrieves the details of a scheduled bill payment for the specified account and payment identifier.
• This endpoint returns payment information such as payee, status, amount, schedule, delivery, memo, and confirmation details. - [Get Payment List](https://developer.greendot.com/embedded-finance/reference/billpay_get_getpaymentlist.md): Retrieves a list of payments for an account, with optional filtering and pagination.
• This endpoint allows you to view payments associated with the specified account.
• You can filter results by starting and ending payment dates, as well as by payment status.
• Pagination options are available via the offset and pageSize query parameters.
• The response includes payment details such as payee, amount, status, and payment dates. - [Create New Payee](https://developer.greendot.com/embedded-finance/reference/billpay_post_createpayee.md): Create a new payee for a customer’s account.
• A payee can be a merchant or a person.
• A Person payee is a custom individual not listed in Green Dot’s vendor payee directory, so the full address information must be provided in order to send the bill payment.
• This endpoint allows the creation of a new payee for a customer’s account.
• The payee can be used for future bill payments.
• The response includes the new payee identifier and status.
• The payeeType must be either 'Merchant' or 'Person'.
• For merchant payees, merchantId should be provided.
• For person payees, full address and contact information must be provided.
• The accountIdentifier must be a valid GUID.
• The requestId must be provided in the X-GD-RequestId header for idempotency and tracking.
- [Schedule Bill Payment](https://developer.greendot.com/embedded-finance/reference/billpay_post_createpayment.md): Schedule a Bill Payment.
• This endpoint allows the scheduling of a one-time or recurring future bill payment to the selected payee, using their payeeIdentifier.
• Recurring future bill payments: The payee needs to be added using POST /billpayPayees to obtain a payeeIdentifier.The frequencyType is required. If the recurring billPay schedule has an ending date, then the paymentEndDate should be the same date.If the recurring billPay schedule is unknown, the paymentEndDate can be set to null.
• The send date set at the time when the original recurring bill payment was scheduled will be revised automatically when the deliver by date lands on either a weekend or federal holiday to ensure there is enough time (5 business days) for the check to arrive by the original expected date.Once the payee is added, the paymentIdentifier will be assigned for the recurring future bill payment.
• The confirmation number will also be returned to the user for schedule confirmation. The scheduled bill payment will be debited from the user’s account on the payment date.After the first scheduled bill payment is processed, future recurring bill payments will be automatically scheduled for the next payment due date, based on frequencyType. Note: If there are issues with debiting a payment, it can be retried up to two times the same morning.
• If the payment still fails, the paymentStatus will show as failed and it will not be tried again. Terms and Conditions Enforcement Depending on the terms and conditions included in the daa that is accepted during account registration, some features may need to be explicitly accepted via the PUT /accounts endpoint.Initially, all programs will be configured to not enforce terms acceptance.Once the system is configured to enforce terms acceptance for a feature, any customer that does not accept the terms for that feature will not be allowed to use the feature.
• For any programs, where customers are already using features that may require explicit terms acceptance, a data backfill will be required for those customers prior to enforcement being enabled.Please work with your Green Dot Account Manager and/or Product Manager to understand the impact and transition plan for your program and features. Bill Pay Transaction Limits Programs configured for Bill Pay will have a $7,500 limit per Bill Pay transaction. Note: Some programs may have custom limits configured for Bill Pay transactions. - [Search Payee by Name](https://developer.greendot.com/embedded-finance/reference/billpay_post_searchpayee.md): This endpoint allows you to search for a payee in the payee directory by name.
• To search the payee directory, you must enter a minimum of 3 characters and a maximum of 32 characters from the payee’s name.
• Once the search is completed, a list of payee names that match the searched payee name will be returned.
• This endpoint applies to merchant payees only. To add a payee, you must first use the search payee API to locate the payee and their merchantId in the directory.
• The payee name search is a full text search, so the payee’s full name must be provided.
• This endpoint is not designed for rapid asynchronous calls, because it pulls not only the payee’s names, but also the payee’s complete profile information. Requests may be denied if too many are called in a short period of time.
• Therefore, a two second wait is required between each search.
• Partners should submit payee search requests after the customer stops typing or after the response to the initial payee search request is received. - [Update Payee](https://developer.greendot.com/embedded-finance/reference/billpay_put_updatepayee.md): Update existing payee information. This endpoint allows an existing payee’s information to be updated using the payeeIdentifier. The payee can be a merchant or a person. You must provide the payeeIdentifier, accountIdentifier, and the updated payee details in the request body. The response contains the result of the update operation. - [Update Scheduled Bill Payment](https://developer.greendot.com/embedded-finance/reference/billpay_put_updatepayment.md): Update Scheduled Bill Payment. This endpoint allows the scheduled bill payment to be updated, using the paymentIdentifier.
• A one-time Bill Pay schedule cannot be changed to a recurring schedule by changing the frequencyType, because one time and recurring bill pay are under different model schema.
• To change Bill Pay schedules, the customer must delete the one-time bill Pay schedule and create a new recurring bill Pay schedule.
• The frequencyType for recurring bill Pay schedules cannot be changed to oneTime or the frequencyType that was previously set for the bill Pay schedule.
• The frequencyType of 'oneTime' cannot be updated to another frequencyType. Recurring frequencyType can be updated to another recurring frequencyType (i.e. weekly or every2weeks, etc.), except oneTime. - [Delete Business Profile Owner](https://developer.greendot.com/embedded-finance/reference/businessprofile_delete_deleteowner.md): Deletes the owner from the specified business profile. - [Get Business Lookup Data](https://developer.greendot.com/embedded-finance/reference/businessprofile_get_getbusinesslookupdata.md): Retrieves business lookup data for the specified program. - [Get Business Metadata](https://developer.greendot.com/embedded-finance/reference/businessprofile_get_getbusinessmetadata.md): Retrieves business metadata for the specified business account. - [Get Business Profile](https://developer.greendot.com/embedded-finance/reference/businessprofile_get_getbusinessprofile.md): Retrieves the business profile data associated with a business account. - [Get Business Profile (Unencrypted)](https://developer.greendot.com/embedded-finance/reference/businessprofile_get_getbusinessprofileunencrypted.md): Retrieves the business profile data associated with a business account. This endpoint returns unencrypted data and is intended for internal use only. - [Set Business Profile Owner](https://developer.greendot.com/embedded-finance/reference/businessprofile_post_createowner.md): Sets the owner for the specified business profile. - [Save Business Application](https://developer.greendot.com/embedded-finance/reference/businessprofile_post_savebusinessapplication.md): Saves a business application for the specified business account. - [Save Business Address](https://developer.greendot.com/embedded-finance/reference/businessprofile_put_savebusinessaddress.md): Saves the business address for the specified business account. - [Save Business Info](https://developer.greendot.com/embedded-finance/reference/businessprofile_put_savebusinessinfo.md): Saves business information for the specified business account. - [Update Business Profile Owner](https://developer.greendot.com/embedded-finance/reference/businessprofile_put_updatebusinessowner.md): Updates the owner information for the specified business profile. - [Update Business Profile](https://developer.greendot.com/embedded-finance/reference/businessprofile_put_updatebusinessprofile.md): This endpoint allows partners to update the business data associated with a business account. It supports the following business types: - ConsumerProfileType - Individual - SoleProp - LLC - Corp - Partnership - Nonprofit - SingleLLC - ProCorp Note: If the business name on the account is updated, the next card replacement request will use the updated business name. Currently, both plaintext and encrypted data are supported. If both plaintext and encrypted data are provided, the encrypted data is processed first, and the plaintext is ignored. - [Get Card Replacement Options](https://developer.greendot.com/embedded-finance/reference/cardoption_get_getreplacementcards.md): Retrieves all available card replacement options for the specified account and program. Use this endpoint to determine which card types or options can be issued as replacements for a given account. - [Add Customer Care Case](https://developer.greendot.com/embedded-finance/reference/carecase_post_createcarecase.md): Create customer support cases. How it works: - The partner’s customer creates a case using their mobile app by calling POST programs/{programCode}/customerCare/cases. - A new case for the customer is created in Salesforce for Green Dot’s agents, allowing them to handle the case. - The partner receives the case number in their response details. The case number can also be displayed to the customer. - [Get Cashback Reward Business Process Rules](https://developer.greendot.com/embedded-finance/reference/cashbackreward_get_getcashbackrewardbusinessprocessrules.md): Retrieve a list of process rules to determine customer cashback percentage incentives for which accountholders are eligible. - [Get Cashback Reward Inquiry](https://developer.greendot.com/embedded-finance/reference/cashbackreward_get_getcashbackrewardinquiry.md): Provides accountholders the following: - Eligibility for redemption - List of redeemable items - Redeemable amount - Account identifier - Finished period amount - Unfinished period amount - Total redeemed amount - Period in months - Yearly capable amount - Next redemption generation date - Remaining capable amount - Accrued cycle months - [Get Cashback Reward Summary](https://developer.greendot.com/embedded-finance/reference/cashbackreward_get_getcashbackrewardsummary.md): Provides accountholders the following: - A summary of how much cashback rewards they’ve earned based off their tier level within specific time frames - Cashback rewards in their statements - Categorized cashback rewards earned for different merchants - [Get Cashback Reward OBS Inquiry](https://developer.greendot.com/embedded-finance/reference/cashbackreward_get_obsinquiry.md): Provides accountholders with details about cashback rewards inquiry for OBS (Online Banking System). - [Redeem Cashback Rewards via OBS](https://developer.greendot.com/embedded-finance/reference/cashbackreward_post_obsredeem.md): Redeems eligible cashback rewards for the specified account using OBS (Online Banking System). Returns the account identifier and the redeemed cashback amount. - [Redeem Cashback Rewards](https://developer.greendot.com/embedded-finance/reference/cashbackreward_post_redeem.md): Redeems eligible cashback rewards for the specified account. Returns the account identifier and the redeemed cashback amount. - [Get categorized transactions for a user](https://developer.greendot.com/embedded-finance/reference/categorizetransaction_get_getcategoriedtransaction.md): Retrieves the user's categorized transactions within the specified date range. - [Get a summary of categorized transactions for a user](https://developer.greendot.com/embedded-finance/reference/categorizetransaction_get_getusercategorysummary.md): Retrieves a summary of the user's categorized transactions within the specified date range. - [Set a category for a transaction](https://developer.greendot.com/embedded-finance/reference/categorizetransaction_put_setusercategory.md): Sets a user-defined category for a specific transaction. - [Get Program Public Certificates for ECC Encryption](https://developer.greendot.com/embedded-finance/reference/certificates_get_getpubliccertificatesforprogram_ecc.md): Retrieves the ECC public certificates for the specified program. - [Get Contact Verification Status](https://developer.greendot.com/embedded-finance/reference/contactverification_get_getcontactverificationstatus.md): Retrieves the contact verification status for a given session identifier and program. - [Validate Address and Return Suggestions](https://developer.greendot.com/embedded-finance/reference/contactverification_post_addressverifications.md): Validates the provided address for a given program and returns a list of suggested addresses and address validity indicators. This endpoint may be called to mitigate returned mail issues. - [Generate Contact Verifications](https://developer.greendot.com/embedded-finance/reference/contactverification_post_generateverifications.md): Generates contact verifications for a given program and request. Returns the generated contact verification identifier. - [Check Contact Verifications](https://developer.greendot.com/embedded-finance/reference/contactverification_put_checkverifications.md): Checks the contact verifications for a given program and contact verification identifier. Returns the result of the verification check. - [Credit Builder Enroll](https://developer.greendot.com/embedded-finance/reference/creditbuilder_post_enroll.md): Enroll a user in the Credit Builder program - [Get Custom Card](https://developer.greendot.com/embedded-finance/reference/customcard_get_getcustomcard.md): Retrieve and use the Custom Card ID to request a custom card. How it works: - Call GET /programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier} - If a custom card is available, your response will contain the customCardImageIdentifier field, which is a unique identifier for the custom card. - Call GET /programs/{programCode}/userIdentifiers/{userIdentifier}/getCustomCard?customCardImageIdentifier=GUID - Search for the custom card you are looking for using the customCardImageIdentifier. - If the custom card is found, you will receive a response containing the custom card information. - If the custom card is not found, you will receive the following: - Code: 4 - Subcode: 1024 - Description: customCardImageIdentifier not found or not supplied. Note: GET customCard can be called with or without the customCardImageIdentifier. Sample response: GET paymentInstrument element. - [Cancel Custom Card](https://developer.greendot.com/embedded-finance/reference/customcard_post_cancelcustomcard.md): Cancels a custom card for a user using the provided user identifier. - [Create Custom Card](https://developer.greendot.com/embedded-finance/reference/customcard_post_createcustomcard.md): Creates a custom card for a user using the provided image data and user identifier. - [Verify a device for a user account](https://developer.greendot.com/embedded-finance/reference/deviceverification_post_verifydevice.md): Verifies a device for a user account using device fingerprint, event type, and other metadata. - [Update device verification status for a user account](https://developer.greendot.com/embedded-finance/reference/deviceverification_put_updatedevice.md): Updates the device verification status for a user account. - [Get All Direct Deposit Switch Attempts](https://developer.greendot.com/embedded-finance/reference/directdeposit_get_getallswitchattempts.md): Retrieves all direct deposit switch attempts for the specified account. The response includes a list of switch attempts with status and vendor information. - [Get Latest Direct Deposit Switch Attempt](https://developer.greendot.com/embedded-finance/reference/directdeposit_get_getlatestswitchattempt.md): Retrieves the latest direct deposit switch attempt for the specified account. The response includes switch status and vendor information. - [Update Direct Deposit Switch Attempt](https://developer.greendot.com/embedded-finance/reference/directdeposit_patch_updateswitchattempt.md): Updates an existing direct deposit switch attempt for the specified account and switch ID. The request payload must include the patch object with the fields to update. - [Add Direct Deposit Manual Form](https://developer.greendot.com/embedded-finance/reference/directdeposit_post_createmanualform.md): Creates a manual form for a direct deposit switch, allowing users to manually initiate a direct deposit setup. The request payload must include account and bank details. - [Add Direct Deposit Switch Attempt](https://developer.greendot.com/embedded-finance/reference/directdeposit_post_createswitchattempt.md): Creates a new direct deposit switch attempt for the specified account, initiating the process to switch direct deposit to a new account. The response includes vendor and switch details. - [Get Transfer Status](https://developer.greendot.com/embedded-finance/reference/disbursement_get_gettransferstatus.md): Retrieves the status and details of a specific disbursement transfer for the given account and program. - [Create ACH Link](https://developer.greendot.com/embedded-finance/reference/disbursement_post_createachlink.md): Creates a new disbursement link to an ACH (bank account) for the specified account and program. - [Create Bank Card Link](https://developer.greendot.com/embedded-finance/reference/disbursement_post_createbankcardlink.md): Creates a new disbursement link to a bank card for the specified account and program. - [Create Cash Link](https://developer.greendot.com/embedded-finance/reference/disbursement_post_createcashlink.md): Creates a new disbursement link for cash pickup for the specified account and program. - [Create Disbursement Transfer](https://developer.greendot.com/embedded-finance/reference/disbursement_post_transfer.md): Performs a generic disbursement transfer for the specified account and program. Use for sending funds to a destination. - [Update Disbursement Transfer](https://developer.greendot.com/embedded-finance/reference/disbursement_put_updatetransfer.md): Updates an existing disbursement transfer, such as canceling a claim code, for the specified account and program. - [Get Tokenized Dispute URL](https://developer.greendot.com/embedded-finance/reference/disputeautomation_post_gettokenizedurl.md): Generates a tokenized URL for dispute workflows, allowing secure access to dispute resolution pages for the specified account. - [Create OAuth Token for Dispute Workflow](https://developer.greendot.com/embedded-finance/reference/disputeautomation_post_oauthtoken.md): Creates an OAuth token for dispute workflows, enabling secure authentication for dispute resolution operations. - [Retrieves details of a specific barcode associated with a user’s account.](https://developer.greendot.com/embedded-finance/reference/ecash_get_getbarcodedetails.md): Retrieves specific barcode details. This endpoint allows you to retrieve the details about a specific barcode associated with a user’s account, based on the accountIdentifier. - [Gets the active barcodes associated with an account identifier.](https://developer.greendot.com/embedded-finance/reference/ecash_get_getbarcodes.md): Gets Active Barcodes Associated with Account Identifier - [Lists participating eCash partners associated with a program.](https://developer.greendot.com/embedded-finance/reference/ecash_get_getecashpartners.md): Lists participating eCash partners for the specified program code. - [Retrieves eCash partners by geographic location for a specific account.](https://developer.greendot.com/embedded-finance/reference/ecash_get_getecashpartnersbylocation.md): Returns a list of participating eCash partners (retailers) near a specified location for the given account. You can search by latitude, longitude, ZIP code, city, state, and radius. This endpoint is useful for finding nearby eCash partners where users can perform cash transactions. All location parameters are optional, but at least one should be provided to filter results. The response includes partner details that match the specified criteria. - [Generates a new barcode for a given eCash partner (retailer).](https://developer.greendot.com/embedded-finance/reference/ecash_post_generatebarcode.md): Generates a new barcode for an eCash Partner (retailer). Barcodes are retailer specific and can only be used once. Expiration date and time will be returned in the response. - [Delete an eGift by ID](https://developer.greendot.com/embedded-finance/reference/egift_delete_deleteegift.md): Delete a specific eGift for the given account and program. - [Get eGift Lifetime Rewards](https://developer.greendot.com/embedded-finance/reference/egift_get_egiftgetlifetimerewards.md): Retrieve the lifetime rewards for the specified account and program. - [Get eGift by ID](https://developer.greendot.com/embedded-finance/reference/egift_get_getegift.md): Retrieve the details of a specific eGift for the given account and program, optionally including deleted eGifts. - [Get eGift Balance](https://developer.greendot.com/embedded-finance/reference/egift_get_getegiftbalance.md): Retrieve the balance details of a specific eGift for the given account and program, optionally including deleted eGifts. - [Get eGift Catalog](https://developer.greendot.com/embedded-finance/reference/egift_get_getegiftcatalog.md): Get the eGift catalog for the specified account and program. - [Get eGift Wallet](https://developer.greendot.com/embedded-finance/reference/egift_get_getegiftwallet.md): Get the eGift wallet for the specified account and program, optionally including deleted eGifts. - [Purchase an eGift](https://developer.greendot.com/embedded-finance/reference/egift_post_purchaseegift.md): Purchase an eGift for the specified account. - [Update eGift Balance](https://developer.greendot.com/embedded-finance/reference/egift_put_updateegiftbalance.md): Update the balance of a specific eGift for the given account and program. - [Gets Enrollment Details (Encrypted)](https://developer.greendot.com/embedded-finance/reference/enrollments_get_getenrollment.md): Retrieves enrollment details for an account. The response is encrypted. - [Add Enrollment for User and Create Account/Card (Encrypted)](https://developer.greendot.com/embedded-finance/reference/enrollments_post_createenrollment.md): Creates a new enrollment for a user, including account and card creation. Supports instant issue scenarios and account upgrades (for example, from GPG to DDA if the "upgradeFlag" parameter is true). This endpoint is also used for the card-in-hand use case to support instant issue enrollment. Key operations performed: - Create new user - Create account - Create payment instrument - Support instant issue enrollment - Support account upgrade Note: If POST /enrollments is called with a valid request and enrollment fails during processing, the request will be automatically completed if the customer clears OFAC.
NameComment
200Success
400Bad request, such as unsupported operation
401Unauthorized
GroupPropertyRequiredConstraint/ScenarioHttpStatusCodeSub CodeDescription
PACKAGE_LOOKUP_EXCEPTION40050205021Connection issue looking up package info
PACKAGE_NOT_FOUND40050205022No package is associated with the provided identifier
PACKAGEID_IN_USE40050205023The package associated with the identifier is already being used
INSTANT_ISSUE_NOT_SUPPORTED40050305031Product does not support instant issue enrollment
INSTANT_ISSUE_REQUEST_PHYSICAL_CARD_NOT_SUPPORTED40050305032Product does not support requesting a physical card during instant issue enrollment
instantIssuetypeY ONLY if enrollment is instantIssueINSTANT_ISSUE_TYPE400600Required: 6181, Invalid: 6182If instantIssue object is provided, then type must be provided. Must be CBS
instantIssuemappingIdentifierY ONLY if enrollment is instantIssueINSTANT_ISSUE_MAPPING_IDENTIFIER400600Required: 6183, Invalid: 6184If instantIssue object is provided, then mappingIdentifier must be provided
accountIdentifierNmissing/invalid accountIdentifier4003500accountIdentifier is invalid
change user profile40045020User profile cannot be changed
account status not normal40045030Account status is not healthy
target product code same as current product code40045040Account already upgraded successfully
same requestId, accountIdentifier is different40045050Account not matched
target product code not allowed for upgrade40045060Account already upgraded successfully
account not found400100Account, account holder, or user not found
[CPM] upgrade service returned error40050300A downstream provider did not return success for Upgrade Account
- [Receive and validate Event Webhook Loopback (RCV) for testing integrations](https://developer.greendot.com/embedded-finance/reference/event_post_testeventwebhook_rcv.md): Receives a webhook event payload, validates its JSON schema and signature, simulates a configurable delay, and can return custom HTTP responses for testing webhook integrations.This endpoint is intended for use in integration and end-to-end testing scenarios where webhook consumers need to validate their handling of event payloads, delays, and custom responses.
The endpoint performs the following:
· Validates the incoming JSON payload against the expected schema for EventWebHookPocRequest.
· Validates the x-gd-signature header if present, using the program-specific signing key.
· Simulates a configurable delay if set via the configuration endpoint.
· Returns a custom HTTP response if configured, otherwise returns a standard response with event identifiers.
- [Simulate Event Webhook Loopback for Testing](https://developer.greendot.com/embedded-finance/reference/event_post_testeventwebhook.md): ·Receives an event webhook request, processes the event and account data, and posts the data back to the specified URL.
·This endpoint is intended for testing webhook integrations, simulating event delivery, and validating downstream system behavior.
·It supports custom postback headers and provides detailed diagnostic information in the response.
- [Configure Test Event Webhook Loopback Response](https://developer.greendot.com/embedded-finance/reference/event_post_testeventwebhooksetconfig.md): Sets the minimum and maximum delay, HTTP status code, response body, and content type for the test event webhook loopback endpoint. - [Get Experian Opt-In Status](https://developer.greendot.com/embedded-finance/reference/experian_get_optin.md): Retrieves the current Experian opt-in status for the specified account. This endpoint allows clients to check whether an account is currently opted in to Experian services. - [Get Experian Redirect URL](https://developer.greendot.com/embedded-finance/reference/experian_get_redirecturl.md): Retrieves the redirect URL for a specified Experian feature for the given account. This endpoint allows clients to obtain the appropriate redirect URL based on the feature, client session, and account context. - [Create Authorization Extension](https://developer.greendot.com/embedded-finance/reference/experian_post_createauthorizeextend.md): Creates an authorization extension for the specified account, allowing extended access or permissions as defined in the request body. - [Update Experian Opt-In Status](https://developer.greendot.com/embedded-finance/reference/experian_put_updateoptin.md): Updates the opt-in status for the specified account. This endpoint allows clients to set or update whether an account is opted in to Experian services. - [Delete a bank link from a customer profile.](https://developer.greendot.com/embedded-finance/reference/externalaccount_delete_deletebanklink.md): Delete a linked bank account from a customer profile. The bank link will be removed and cannot be used for future transfers. - [Delete a card link from a customer profile.](https://developer.greendot.com/embedded-finance/reference/externalaccount_delete_deletecardlink.md): Delete a linked card from a customer profile. The card link will be removed and cannot be used for future transfers. - [Retrieve card links for a source customer profile.](https://developer.greendot.com/embedded-finance/reference/externalaccount_get_getcardlinks.md): Retrieve all card links associated with a source customer profile. - [Retrieve links for a customer profile by token and link type.](https://developer.greendot.com/embedded-finance/reference/externalaccount_get_getcardlinksbycustomertoken.md): Retrieve all links (cards or banks) for a customer profile, optionally filtered by link type. - [Retrieve a customer profile.](https://developer.greendot.com/embedded-finance/reference/externalaccount_get_getcustomerprofile.md): Retrieve the details of a customer profile by customer token. Returns encrypted customer profile data. - [Retrieve a transfer by customer token and transfer ID.](https://developer.greendot.com/embedded-finance/reference/externalaccount_get_gettransfer.md): Retrieve the details of a specific transfer for a customer profile using the transfer ID. - [Get transfer limits and fee rates for a program.](https://developer.greendot.com/embedded-finance/reference/externalaccount_get_gettransferlimitsandfeerates.md): Retrieve the transfer limits and fee rates for a specific program and transfer type. - [Search transfers by date range for a customer profile.](https://developer.greendot.com/embedded-finance/reference/externalaccount_get_searchtransfers.md): Search for transfers associated with a customer profile within a specified date range and pagination. - [Assess/validate transfer limits for a customer profile.](https://developer.greendot.com/embedded-finance/reference/externalaccount_get_transferlimitassessment.md): Assess/validate transfer limits for a customer profile. - [Create a new customer profile in the Green Dot system.](https://developer.greendot.com/embedded-finance/reference/externalaccount_post_createcustomerprofile.md): This API creates a customer profile. Afterwards, the customer must go through Green Dot's verification process before initiating any further API calls. **Business Logic** **CustomerToken** -- Depending on the partner configuration, this field can be mandatory or optional. - When this field is mandatory, the partner must provide a unique value. - When this field is mandatory, the partner must provide a unique value. - When this field is optional and the request contains a **CustomerToken** value, the same value is used. Otherwise, the Instant Transfer Service generates a GUID as the **CustomerToken**. **Idempotent Check** -- This check is based on the CustomerToken. If the request contains a value that already exists in the database, it returns the Record already exists error. **DB Level Encryption** -- This encryption is based on DateOfBirth. **CustomerID in DB** -- As per Green Dot standards, the CustomerID is a GUID that the the Instant Transfer service generates. - [Link a card to a source customer profile by GFT.](https://developer.greendot.com/embedded-finance/reference/externalaccount_post_linkcardtosourceprofile.md): Link a card to a source customer profile for global fund transfer operations. - [Link a bank account to a customer profile.](https://developer.greendot.com/embedded-finance/reference/externalaccount_post_linkcustomerprofilebank.md): Link a bank account to a customer profile using encrypted data. The bank account will be associated with the customer for future transfers. - [Link a card to a customer profile.](https://developer.greendot.com/embedded-finance/reference/externalaccount_post_linkcustomerprofilecard.md): Link a card to a customer profile using encrypted data. The card will be associated with the customer for future transfers. - [Update a bank link for a customer profile.](https://developer.greendot.com/embedded-finance/reference/externalaccount_put_updatebanklink.md): Update the details of a linked bank account for a customer profile. - [Update a card link for a customer profile.](https://developer.greendot.com/embedded-finance/reference/externalaccount_put_updatecardlink.md): Update the details of a linked card for a customer profile. - [Update an existing customer profile.](https://developer.greendot.com/embedded-finance/reference/externalaccount_put_updatecustomerprofile.md): Update an existing customer profile with encrypted data. The customer profile must exist and the request must be authorized. - [Get External Card Profile](https://developer.greendot.com/embedded-finance/reference/externalcards_get_getexternalcardprofile.md): Retrieves the external card profile for a customer using the provided customer token. - [Add or Validate External Bank Card](https://developer.greendot.com/embedded-finance/reference/externalcards_post_addexternalcard.md): Adds or validates an external bank card for a customer using encrypted card data. This endpoint is intended for external and general use. - [Get All Feature Eligibility](https://developer.greendot.com/embedded-finance/reference/featureeligibility_get_getallfeatureeligibility.md) - [Set Feature Eligibility](https://developer.greendot.com/embedded-finance/reference/featureeligibility_put_setfeatureeligibility.md) - [Get fee information by product code and fee type key](https://developer.greendot.com/embedded-finance/reference/fee_post_getfeeinfobyproductcodeandfeetypekey.md): Retrieves fee information for a given product code and fee type key. - [Get fee waivers for a user within a date range](https://developer.greendot.com/embedded-finance/reference/fee_post_getfeewaivers.md): Retrieves the list of fees waived for a user between the specified start and end dates. - [Create New Payee](https://developer.greendot.com/embedded-finance/reference/guestverification_post_createguestverification.md): Creates a new payee (guest verification) using encrypted data. - [Reports the health status of the service.](https://developer.greendot.com/embedded-finance/reference/healthcheck_get_healthcheck.md): Checks the health of the service and returns a status response. - [Tests if Green Dot services are healthy](https://developer.greendot.com/embedded-finance/reference/healthcheck_get_ping.md): This endpoint checks if the Green Dot services are reachable and healthy. It returns a simple status response. - [Get Hosted User Experience Configuration](https://developer.greendot.com/embedded-finance/reference/hosteduserexperience_post_gethosteduserexperienceconfiguration.md): Retrieves a PCI widget configuration and a hosted user experience URL for the specified activity and program. Validates the activity, finds the product code, and returns a secure URL for embedding in client applications. - [Deletes an interest rate tier for a specified program, account, and purse.](https://developer.greendot.com/embedded-finance/reference/interestrate_delete_deleteinterestratetier.md): This endpoint allows Partners to delete interest rate tiers. - Delete Interest Rate Tier - [Retrieves a list of all Interest Rate Tiers and Annual Percentage Yields (APYs)](https://developer.greendot.com/embedded-finance/reference/interestrate_get_getinterestratetiers.md): Returns a list of all Interest Rate Tiers and Annual Percentage Yields based on purseIdentifier
This endpoint allows Partners to retrieve a list of all Interest Rate Tiers and Annual Percentage Yields (APYs) associated with a specific purseIdentifier.
Note: Interest Rate Tiers that are deleted will not be included in responses to this endpoint. - [Creates a new interest rate change request for a program.](https://developer.greendot.com/embedded-finance/reference/interestrate_post_addinterestratechangerequest.md): This endpoint allows Partners to create a new interest rate change request. - [Add a new interest rate tier to an existing purse.](https://developer.greendot.com/embedded-finance/reference/interestrate_post_addinterestratetier.md): This endpoint allows Partners to add Interest Rate Tiers to an existing primary and savings purses.

Notes:
• The interestYieldStartDate will be set to the current date, if you are adding an interestRateTier to the purse for the first time.
• If the interestYieldStartDate is not provided, the accountCycleDay will be on or after the current date of the request.
• If the purse already has an interestRateTier applied, then the interestYieldStartDate will be set to the next anniversary of the billing cycle.
• The next anniversary of the billing cycle will be returned as the accountCycleDay in the POST /enrollments, GET /accounts, and GET /enrollments endpoint responses.
• The interestYieldEndDate of the previous Interest Rate Tier on the purse is automatically set to the day before the new Interest Rate.
• If the purse has no Interest Rate Tiers applied yet, and autoAlignStartDate is False then the interestYieldStartDate is set to the current date of the request, otherwise it is set to the date provided in the request. On the new additional tiers, when the autoAlignStartDate is True, the interestYieldStartDate is set to start on the next accountCycleDay (Bill Cycle Date). - [Adds a new program-level interest rate tier.](https://developer.greendot.com/embedded-finance/reference/interestrate_post_addprograminterestratetier.md): This endpoint allows Partners to create a new interest rate tier. - [Update an existing interest rate tier for a specified purse and account.](https://developer.greendot.com/embedded-finance/reference/interestrate_put_updateinterestratetier.md): This endpoint allows Partners to: - Add an end date to an interest rate tier - Remove an end date from an interest rate tier - Update an interest rate tier end date - End an interest rate tier on a user’s account by adding an end date. - Remove an end date from an interest rate tier and return it to active on a user’s account. - Update an interest rate tier end date to the day before the next bill cycle date. How to add an end date to an interest rate tier: - An interestRateTier can be ended or closed by adding an end date to it. Simply call PUT /purses/{purseIdentifier}/interestRateTier/{interestRateTierIdentifier} with: - A valid interestRateTierIdentifier - A valid end date (must be in the future and the last day of a monthly cycle for the account) - Note: The interestRateTier that the end date is being applied to, cannot have an end date already and it must have the most recent start date if there are multiple tiers on the account. - An interestRateTier that is scheduled to start at a future date can be updated if it has a valid interestRateTierIdentifier and a valid interestRateTier enum. - Simply call PUT /purses/{purseIdentifier}/interestRateTier/{interestRateTierIdentifier} to update. - Note: Adding an end date to an interestRateTier and updating an interestRateTier that is scheduled to start at a future date can both be done in a single call. So, submitting a valid end date AND a new interestRateTier will update both fields. How to remove an end date from an interest rate tier: - Partner calls PUT …/purses/{purseIdentifier}/interestRateTier/{interestRateTierIdentifier} and the following is true: - Current interest rate tier has an end date that is today or in the future - No interest rate tier is scheduled to follow the current interest rate tier - removeEndDateFlag is true - Optional interestYieldEndDate is provided – Ignored if removeEndDateFlag is true - The end date is removed, and the interest rate tier remains active. How to update an end date on an interest rate tier: - Partner calls PUT …/purses/{purseIdentifier}/interestRateTier/{interestRateTierIdentifier} and the following is true: - Current interest rate tier has an end date that is today or in the future - Provided interest rate tier has an end date that is today or in the future - No interest rate tier is scheduled to follow the current interest rate tier - The interest rate tier end date is updated to: - The day before the next bill cycle on or after the new interestYieldEndDate - If no interestYieldEndDate is provided, the day before the very next bill cycle date occurs - The updated end date is included in the response. - [Updates an existing program-level interest rate tier.](https://developer.greendot.com/embedded-finance/reference/interestrate_put_updateprograminterestratetier.md): This endpoint allows Partners to update an existing interest rate tier. - [Add IDV Request – Submits identification verification information for a user.](https://developer.greendot.com/embedded-finance/reference/kyc_post_createidvvalidation.md): Submits identification verification information for a user. Supports account upgrade flow and sends PN webhook if cure is none. - [Create Legacy / Limited Verification KYC Request](https://developer.greendot.com/embedded-finance/reference/kyc_post_createkyc1.md): Creates a KYC1 gate request for a user, submitting SSN suffix for verification. Returns pending KYC gate and status. - [Create KYC Request](https://developer.greendot.com/embedded-finance/reference/kyc_post_createkyc2.md): Creates a KYC2 gate request for a user, submitting SSN for verification. Returns pending KYC gate, status, and attempts remaining. - [Submit OOW Answers – Submits out-of-wallet (OOW) answers for KYC verification.](https://developer.greendot.com/embedded-finance/reference/kyc_post_createoow.md): Submits out-of-wallet (OOW) answers for KYC verification. Returns pending KYC gate and status. - [Add ScanCapture Request – Submits Matricula Consular ID images for verification.](https://developer.greendot.com/embedded-finance/reference/kyc_post_createscancapturevalidation.md): Submits Matricula Consular ID images for verification. Returns onboarding ID and verification status. - [Generate DocV Document Request – Returns a DocVTransaction Token for Socure DocV SDK initialization.](https://developer.greendot.com/embedded-finance/reference/kyc_post_generatedocvdocumentrequest.md): Returns a DocVTransaction Token for Socure DocV SDK initialization and an optional upload URL for user identity documents. - [Add IDV Socure Result – Validates user’s identification documents uploaded via Doc V SDK.](https://developer.greendot.com/embedded-finance/reference/kyc_post_idvuuidvalidation.md): Validates user’s identification documents uploaded via Doc V SDK. Returns KYC state data. - [Get ATM Locations List](https://developer.greendot.com/embedded-finance/reference/locator_get_getatmlocations.md): This endpoint provides the user with the ability to locate a nearby ATM. If the GET request is successful, the following response message will be returned along with a 200 HTTP status code - [Get Retail Locations List](https://developer.greendot.com/embedded-finance/reference/locator_get_getretaillocations.md): The Retail Locator API allows you to search for retail locations (based on proximity) that allow swipeReload and eCash. Search participating retail locations - [Get Inbox Message Count – Retrieves the count of inbox messages for an account, optionally filtered by status.](https://developer.greendot.com/embedded-finance/reference/notification_get_getinboxmessagecount.md): Get Inbox Message Count - [Get Inbox Messages – Retrieves inbox messages for an account, with optional filtering and pagination.](https://developer.greendot.com/embedded-finance/reference/notification_get_getinboxmessages.md): Get Inbox Message - [Get Notification Enrollment – Retrieves the notification enrollment details for an account.](https://developer.greendot.com/embedded-finance/reference/notification_get_getnotificationenrollment.md): Retrieves the notification enrollment details for an account, including notification preferences and contact information. Requires account identifier and program code. Returns enrollment details and status. - [Add Notification Enrollment – Creates a notification enrollment for an account.](https://developer.greendot.com/embedded-finance/reference/notification_post_createnotificationenrollment.md): Creates a notification enrollment for an account, enabling notification delivery based on user preferences. Requires account identifier, program code, and enrollment details. Returns enrollment status and details. - [Mark Message As Read – Updates the status of an inbox message to 'read' for an account.](https://developer.greendot.com/embedded-finance/reference/notification_put_markmessageasread.md): Updates the status of an inbox message to 'read' for an account. Requires account identifier, program code, and message details. Returns the status and details of the update operation. - [OFAC2 Cure Gate for Enrollment](https://developer.greendot.com/embedded-finance/reference/ofac_post_createenrollmentofac2.md): Update Consumer Information and perform OFAC checks. - [Check the status of a card inventory order.](https://developer.greendot.com/embedded-finance/reference/order_get_getorder.md): This API is used to get inventory order information from partners. ****** ***Http Status Code***
NameComment
200success
400bad request, like unsupported operation
401Unauthorized
- [Submit a card inventory order request.](https://developer.greendot.com/embedded-finance/reference/order_post_postorderrequest.md): This API is used to get inventory order information from partners. ****** ***Http Status Code***
NameComment
200success
400bad request, like unsupported operation
401Unauthorized
****** ***Inventory Management***
GroupPropertyRequiredConstraint/ScenarioHttpStatusCodeSub CodeDescription
clientReferenceNumberY>= 2 characters and <= 40 characters400400Required: 6021,Invalid: 6022Unique string sent by partner to identify the request
emailYif provided valid email with max 255 char4004006003
phoneYif provided, 10 digits40010406004
companyNIf provided, >= 2 characters and <= 40 characters4004006030
companyIdNIs Required if company is provided, >= 2 characters and <= 40 characters4004006031
deliveryTypeY400600Required: 6001,Invalid: 6002Options: Reg, Onn, Pse, Rush
lineslineTypeYMust be "Plastic"400600Required: 6041,Invalid: 6042Options: Plastic, Blank
productCodeYMust be Ceridian GPR product code4001000Required: 6051, Invalid: 6052Invalid product code for program
inventoryCodeY>=2 and <=404006000Required: 6061,Invalid: 6062
quantityY>=10 and <=10000400400Required: 6081, Invalid: 6082
deliveryAddresscontactNameY>= 2 characters and <=35 characters400400Required: 6101,Invalid: 6102Contact receiving the shipment
addressLine1Y>= 2 characters and <= 30 characters400400Required: 6111,Invalid: 6112
addressLine2N<= 30 characters4004006121
cityY<= 25 characters400400Required: 6131, Invalid: 6132
stateYMust be two characters400400Required: 6141, Invalid: 6142
postalCodeYMust be 5 digits only400400Required: 6151, Invalid: 6152
countryYMust be 3 characters400600Required: 6161, Invalid: 6162must be USA
residentialYMust be 1 character400600Required: 6171, Invalid: 6172Must be Y or N
- [Get Check Payment Images](https://developer.greendot.com/embedded-finance/reference/papercheck_get_getcheckbookimages.md): Retrieves images of check payments for the specified account and check number, including the requested image face type. - [Get Check Book Orders](https://developer.greendot.com/embedded-finance/reference/papercheck_get_getcheckbookorders.md): Retrieves the list of check book orders for the specified account. Optionally filter by order confirmation token. - [Update Check Book Order Status](https://developer.greendot.com/embedded-finance/reference/papercheck_put_checkbookorder.md): Updates the status of a paper check book order, such as marking it as not received. - [Update Paper Check Payment Status](https://developer.greendot.com/embedded-finance/reference/papercheck_put_stoppapercheckpayment.md): Stops payment on a paper check. Partners can request a stop payment on checks by providing the check number and account identifier. - [Get Payment Details for an Account](https://developer.greendot.com/embedded-finance/reference/payment_get_getpayments.md): Retrieves the last calculated minimum payment for a customer after scheduling a one-time SCC payment and choosing the minimum-amount option. - [Get status of a closed loop transaction](https://developer.greendot.com/embedded-finance/reference/payment_get_getpurchasestatus.md): Retrieves the status of a closed loop transaction using the payment instrument identifier and retrieval reference number. - [Authorize a closed loop transaction](https://developer.greendot.com/embedded-finance/reference/payment_post_authorizepayment.md): Authorizes a closed loop transaction for the specified payment instrument and amount. - [Get Payment Instrument Delivery Status](https://developer.greendot.com/embedded-finance/reference/paymentinstrument_get_getmailtrackinginfo.md): Get Delivery Status - [Get Payment Instrument Details](https://developer.greendot.com/embedded-finance/reference/paymentinstrument_get_getpaymentinstrument.md): Get Payment Instrument Details - [Get User Payment Instrument List](https://developer.greendot.com/embedded-finance/reference/paymentinstrument_get_getpaymentinstrumentlist.md): Retrieves a List of Payment Instruments for a Specific Account - [Get Replace Card Eligibility](https://developer.greendot.com/embedded-finance/reference/paymentinstrument_get_replacecardeligibility.md): Get Replace Card Eligibility - [Activate Card for Pre-Login](https://developer.greendot.com/embedded-finance/reference/paymentinstrument_post_activatecardforprelogin.md): Activate Card for Pre-Login - [Activate Card via Account Identifier](https://developer.greendot.com/embedded-finance/reference/paymentinstrument_post_activatecardviaaccountidentifier.md): Activate a Card This endpoint gives the partner the ability to activate a card, if the customer (user) has the PAN, Expiration Date, and CVV. Once activated, the payment instrument identifier is returned. Also, the pan must be exactly 16 digits for the card to be activated. Things to Remember: * There are no limits on activateCard attempts. * If there is more than one “notActivated” Payment Instrument, when a newer Payment Instrument is “activated”, all older “notActivated” Payment Instruments will be set to “deactivated”. * Partners who accept Matricula Identification will be allowed to use the last four digits of the ID to activate a customer’s payment instrument(s) (cards). This allows the successful activation of their payment instrument and validation of their card verification value (CVV). - [Activate Card via Account Identifier](https://developer.greendot.com/embedded-finance/reference/paymentinstrument_post_activatecardviapaymentinstrumentidentifier.md): Activate Card via Payment Instrument Identifier - [Complete Payment Instrument Registration](https://developer.greendot.com/embedded-finance/reference/paymentinstrument_post_completeregistration.md): Create a New Payment Instrument This endpoint may be called after an enrollment is cured using the kycGates/IDV endpoint. If the parameter "upgradeFlag" is true,it will be upgrade flow.It should insert new product terms, update the history data, send webhook and return upgrade success when upgrade success. - [/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}/pushProvisionData/onepay](https://developer.greendot.com/embedded-finance/reference/paymentinstrument_post_createwalletpushprovision.md): Create wallet OnePay - [Validate Card for Pre-Login](https://developer.greendot.com/embedded-finance/reference/paymentinstrument_post_getpreloginvalidation.md): Validate Card CVV - [Validate Card CVV](https://developer.greendot.com/embedded-finance/reference/paymentinstrument_post_validatecard.md): Validate Card CVV - [Verify ATM Pin for Payment Instrument](https://developer.greendot.com/embedded-finance/reference/paymentinstrument_post_verifypin.md): Verify ATM Pin for Payment Instrument - [Set ATM Pin for Payment Instrument](https://developer.greendot.com/embedded-finance/reference/paymentinstrument_put_setpin.md): Set and Reset an ATM Pin This endpoint gives the partner the ability to update the ATM pin data of a payment instrument. - [Update Payment Instrument Lifecycle Event](https://developer.greendot.com/embedded-finance/reference/paymentinstrument_put_updatepaymentinstrument.md): Update Lifecycle Event - [Retrieve a list of previously provisioned payment instrument tokens for a specific account.](https://developer.greendot.com/embedded-finance/reference/paymentinstrumenttoken_get_getpaymentinstrumenttokenlist.md): This endpoint allows the retrieval of all eWallet tokens previously provisioned into a digital wallet for a specific account based on the accountIdentifier provided in the request. Optionally, results can be filtered by user, device, or payment instrument. - [Retrieve a list of push provision configuration options for a specific account.](https://developer.greendot.com/embedded-finance/reference/paymentinstrumenttoken_get_getpushprovisionconfiglist.md): This endpoint allows Partners to retrieve a list of options that can be used to add payment instruments to a digital wallet for a specific account. - [Create Push Provisioning Data for App-Initiated Digital Wallet Operations](https://developer.greendot.com/embedded-finance/reference/paymentinstrumenttoken_post_createpushprovisiondata.md): Creates Push Provisioning Data for App-Initiated Digital Wallet Operations. This endpoint generates the data required to provision a payment instrument into a digital wallet (e.g., Apple Pay, Google Pay, Samsung Pay) for a specific account and payment instrument. The request must include device and wallet provider information. - [Create Push Provisioning Data for App-Initiated Digital Wallet Operations](https://developer.greendot.com/embedded-finance/reference/paymentinstrumenttoken_post_pushprovisiondata.md): Creates Push Provisioning Data for App-Initiated Digital Wallet Operations. This endpoint generates the data required to provision a payment instrument into a digital wallet (e.g., Apple Pay, Google Pay, Samsung Pay) for a specific account and payment instrument. The request must include device and wallet provider information. - [Get Payment Instrument Details applying partner access control (VGS)](https://developer.greendot.com/embedded-finance/reference/paymentinstrumentvgs_get_getpaymentinstrumentvgs.md): Get Payment Instrument Details - [Get product feature limits](https://developer.greendot.com/embedded-finance/reference/productfeaturelimits_get_getproductfeaturelimits.md): Retrieves the feature limits for a specific product feature within a program, based on the provided program code, product code, feature name, and optional product class and tier class. - [Get Interest Rate Tiers and APYs for a Product](https://developer.greendot.com/embedded-finance/reference/products_get_getproductinterestratetier.md): Returns a list of all Interest Rate Tiers and Annual Percentage Yields based on productCode. This endpoint allows Partners to retrieve a list of all Interest Rate Tiers and Annual Percentage Yields (APYs) associated with a specific productCode. - [Get Term By Id for a Product](https://developer.greendot.com/embedded-finance/reference/products_get_gettermbyid.md): Retrieves the specific term and condition for a product by its unique identifier. - [Get Terms and Conditions for a Product](https://developer.greendot.com/embedded-finance/reference/products_get_getterms.md): Retrieves the terms and conditions for a specific product within a program. - [Gets interest rate tiers and APY for a program.](https://developer.greendot.com/embedded-finance/reference/program_get_getinterestratetiers.md): Returns a list of interest rate tiers and APY for the specified program code and optional effective date. - [Retrieves program information for a given program code.](https://developer.greendot.com/embedded-finance/reference/program_get_getprograminfo.md): Returns detailed information about the specified program, including its name and code. - [Close Purse – Closes an empty, non-spending savings purse.](https://developer.greendot.com/embedded-finance/reference/purse_delete_closepurse.md): Closes an empty, non-spending savings purse for an account. Only allowed for purses with zero balance. Returns the status of the close operation. - [Calculate Interest – Calculates interest earned for a purse over a specified date range.](https://developer.greendot.com/embedded-finance/reference/purse_get_calculateinterest.md): Calculates interest earned for a purse over a specified date range. Dates must be in YYYY-MM-DD format and the end date must be in the past. Returns the calculated interest amount. - [Get Purses – Retrieves all purses and balances for an account.](https://developer.greendot.com/embedded-finance/reference/purse_get_getpurses.md): Retrieves all purses and balances for an account, including available and ledger balances. Returns purse details and transfer status. - [/programs/{programCode}/accounts/{accountIdentifier}/purses/{purseIdentifier}/CreditBuilder/payment](https://developer.greendot.com/embedded-finance/reference/purse_post_createcreditbuilderpurse.md): Processes a payment on an existing Credit Builder purse associated with an account. Only allowed if the account status is normal. Returns the payment result, including transfer identifier and status. - [Add Purse – Creates a new savings purse for an account.](https://developer.greendot.com/embedded-finance/reference/purse_post_createpurse.md): Creates a new savings purse for an account. Only allowed if the account status is normal. Interest Rate Tier information is included if provided. Returns the created purse details. - [Update Purse – Updates the details of a specific purse.](https://developer.greendot.com/embedded-finance/reference/purse_put_updatepurse.md): Updates the details of a specific purse, such as description, goal amount, icon, and round-up settings. Returns the updated purse details. - [Retrieves collection account status history for an account](https://developer.greendot.com/embedded-finance/reference/scc_get_getcollectionaccountstatushistory.md): Get the collection account status history for a specified account identifier and program code. - [Retrieves OD Fee Eligible Transactions for an account](https://developer.greendot.com/embedded-finance/reference/scc_get_odfeeeligibletransactions.md): Get OD Fee Eligible Transactions for a specified account identifier and program code. - [Check Credit Line Decrease Eligibility](https://developer.greendot.com/embedded-finance/reference/scceligibilities_get_checkcreditlinedecreaseeligibility.md): Checks if the specified account is eligible for a credit line decrease within a given program. - [Check Credit Line Increase Eligibility](https://developer.greendot.com/embedded-finance/reference/scceligibilities_get_checkcreditlineincreaseeligibility.md): Checks if the specified account is eligible for a credit line increase within a given program. - [Check SCC Eligibilities](https://developer.greendot.com/embedded-finance/reference/scceligibilities_get_scceligibilitiescheck.md): Checks the SCC (Secured Credit Card) eligibilities for a user within a specific program. - [Get User Tokens by Account Identifier](https://developer.greendot.com/embedded-finance/reference/tokenmanagement_get_getusertokensbyaccountid.md): Retrieves all user tokens associated with the specified account identifier. - [Get User Tokens by Resource Identifier](https://developer.greendot.com/embedded-finance/reference/tokenmanagement_get_getusertokensbyresourceid.md): Retrieves user tokens associated with the specified resource identifier. - [Add Token to Recipient List](https://developer.greendot.com/embedded-finance/reference/tokenmanagement_post_addtokentorecipientslist.md): Adds a token to the user's recipient list for the specified program. - [Create User Token](https://developer.greendot.com/embedded-finance/reference/tokenmanagement_post_createtokenidentifier.md): Creates a new P2P user token for the specified account and program. - [Search Contacts in Directory](https://developer.greendot.com/embedded-finance/reference/tokenmanagement_post_directorysearchtoken.md): Searches for contacts in the P2P directory using the provided search criteria. - [Generate User Token Name Suggestions](https://developer.greendot.com/embedded-finance/reference/tokenmanagement_post_generateusertokennamesuggestioins.md): Generates a list of suggested user token names based on the customer's name and external resource. - [Get All Recipients for a Token](https://developer.greendot.com/embedded-finance/reference/tokenmanagement_post_getallrecipientstoken.md): Retrieves all recipients associated with a token for the specified program. - [Update Recipient Nickname and Status](https://developer.greendot.com/embedded-finance/reference/tokenmanagement_put_updaterecipientbyid.md): Updates the nickname and status of a recipient in the P2P directory. - [Update User Token by Resource Identifier](https://developer.greendot.com/embedded-finance/reference/tokenmanagement_put_updatetokenidentifierbyresourceid.md): Updates the P2P user token name and status for the specified resource identifier. - [Create One Pay Transaction Event](https://developer.greendot.com/embedded-finance/reference/transactionevent_post_createonepaytransactionevent.md): Create One Pay Transaction Event - [Get Cash Back Reward Transactions](https://developer.greendot.com/embedded-finance/reference/transactions_get_getcashbackrewardstransactions.md): Retrieves a list of cash back reward transactions for the specified account, with optional filters for date range and purchase inclusion. - [Get Direct Depositor Information](https://developer.greendot.com/embedded-finance/reference/transactions_get_getdirectdepositor.md): Retrieves information about the direct deposit depositor for the specified account. - [Get Direct Deposits](https://developer.greendot.com/embedded-finance/reference/transactions_get_getdirectdeposits.md): Retrieves a list of direct deposit transactions for the specified account, optionally filtered by date range. - [Get Interest Earned](https://developer.greendot.com/embedded-finance/reference/transactions_get_getinterestearned.md): Retrieves the total interest earned for a specified purse within a given date range. - [Get Overdraft Fee Authorization Transactions](https://developer.greendot.com/embedded-finance/reference/transactions_get_getoverdraftfeeauthtransactions.md): Retrieves a list of overdraft fee authorization transactions for the specified account within a given date range. - [Get Overdraft Transactions](https://developer.greendot.com/embedded-finance/reference/transactions_get_getoverdrafttransactions.md): Retrieves a list of overdraft transactions for the specified account within a given date range. - [Get Related Transactions](https://developer.greendot.com/embedded-finance/reference/transactions_get_getrelatedtransactions.md): Retrieves transactions related to a specific transaction identifier for the specified account. - [Gets Transaction Pagination](https://developer.greendot.com/embedded-finance/reference/transactions_get_gettransactionpagination.md): Retrieves a paginated list of transactions for the specified account, allowing clients to page through large sets of transaction data. - [Get Transactions List](https://developer.greendot.com/embedded-finance/reference/transactions_get_gettransactions.md): Retrieves a list of transactions for the specified account, with optional filters for date range, transaction type, status, and purse. Supports inclusion of all authorizations. Returns transaction details and metadata. - [Get ACH Delivery Date](https://developer.greendot.com/embedded-finance/reference/transfers_get_getachdeliverydate.md): Retrieves the expected funding date and time (achDeliveryDate) for ACH Pull transfers. Requires transfer type, optional schedule date, and delivery type. Returns the expected funding date for the transfer. - [Get Bank Eligibility by Routing Number](https://developer.greendot.com/embedded-finance/reference/transfers_get_getbankeligibility.md): Checks if a bank, identified by its routing number, is eligible for ACH or other transfer types. Returns eligibility status and related information. - [Get Bank Name by Routing Number](https://developer.greendot.com/embedded-finance/reference/transfers_get_getbankname.md): Retrieves the bank name associated with a specific routing number. Partners can use this to validate or display bank information for user-entered routing numbers. - [Get GFT Fees and limits](https://developer.greendot.com/embedded-finance/reference/transfers_get_gettransferlimitsandfeeratesv2.md): Get GFT Transfer Fees and Limits - [Handles health check requests for the Single Commit transfer operation. Used to verify the readiness and availability of the Single Commit transfer infrastructure for a given program. Accepts the program code and request ID, and returns a Gd.Bos.DataTransfer.Response.SingleCommitHealthCheckResponse indicating the health status.](https://developer.greendot.com/embedded-finance/reference/transfers_get_singlecommithealthcheck.md) - [Link External Bank Account via ACH](https://developer.greendot.com/embedded-finance/reference/transfers_post_achlinkexternalaccountrequest.md): Links one or more external bank accounts to a specified account using ACH. Requires selected bank account tokens and provider information. Returns reference IDs for linked accounts. - [Assess ACH Transfer Prerequisites](https://developer.greendot.com/embedded-finance/reference/transfers_post_assessachtransfer.md): Verifies ACH Pull limits, frequency, delivery type, and bank account verification method for ACH authorization. Returns assessment results and any unmet requirements. - [Assess MRDC Transfer Eligibility](https://developer.greendot.com/embedded-finance/reference/transfers_post_assessmrdctransfer.md): Checks if the account meets eligibility requirements for submitting a check via MRDC. Returns any unmet prerequisites required for MRDC check submission. - [Assess Transfer Prerequisites](https://developer.greendot.com/embedded-finance/reference/transfers_post_assesstransfer.md): Assesses if the required prerequisites are met for various transfer types (P2P, ACH Out, IFT). Verifies user identity and returns any unmet requirements. - [Create New ACH Transfer](https://developer.greendot.com/embedded-finance/reference/transfers_post_createachtransfer.md): Creates a new ACH Out or ACH Pull transfer to move funds between a Green Dot account and an external bank account. Supports daily limits for ACH Out transfers. On success, returns details of the created ACH transfer. Refer to the API documentation for event types and webhook behavior. - [Generate External Account Link Token](https://developer.greendot.com/embedded-finance/reference/transfers_post_createexternalaccountlinktoken.md): Generates a secure link token for connecting an external bank account using a third-party provider. Returns the generated link token for use in account linking flows. - [Create MRDC Transfer](https://developer.greendot.com/embedded-finance/reference/transfers_post_createmrdctransfer.md): Creates a new Mobile Remote Deposit Capture (MRDC) transfer and runs check deposits through a pre-validation process. User must accept the 'Funds Available Date' or a 'Manual Review'. - [Create Wire Out Transfer](https://developer.greendot.com/embedded-finance/reference/transfers_post_createwireout.md): This new endpoint allows Partners to wire out transactions and testing in PIE. Note: This feature must be explicitly requested and configured on a per partner basis. Contact your Green Dot Account Liaison for assistance. How it works: Call POST …/accounts/{accountIdentifier}/wires and include the following information: - [Get Transfer by Token (Guest Checkout)](https://developer.greendot.com/embedded-finance/reference/transfers_post_gettransferbytoken.md): Retrieves transfer details using a guest checkout token. Allows partners to access transfer information for users without authentication. - [Create GFT (Global Fund Transfer)](https://developer.greendot.com/embedded-finance/reference/transfers_post_gfttransfer.md): Creates a global fund transfer (GFT) from a partner to a user. Supports B2C, A2A, and partner account transfers. Returns the created transfer details. - [Create Single-Commit Transfer](https://developer.greendot.com/embedded-finance/reference/transfers_post_singlecommit.md): Executes a single-commit funds transfer in one step, using encrypted transfer route details. Returns the created transfer details, including identifier, status, and related accounts. - [Submit Check for MRDC](https://developer.greendot.com/embedded-finance/reference/transfers_post_submitcheck.md): Submits a check for Mobile Remote Deposit Capture (MRDC) processing. Requires check and account details. Returns the result of the check submission. - [Create Transfer (B2C, A2A, or P2P)](https://developer.greendot.com/embedded-finance/reference/transfers_post_transfer.md): Transfers funds from a program funding source to a consumer account. The transferType differentiates B2C, A2A, or P2P transactions. Returns details of the created transfer. - [Assess Update Transfer](https://developer.greendot.com/embedded-finance/reference/transfers_put_assessupdatetransfer.md): Assesses the prerequisites and eligibility for updating an existing transfer. Returns assessment results and any unmet requirements. - [Update MRDC Funds Available Date](https://developer.greendot.com/embedded-finance/reference/transfers_put_updatemrdcfundsavailabledate.md): Modifies the funding date of a specific MRDC transaction. The new date must be a business day between the current and scheduled funding dates. - [Update Existing Transfer](https://developer.greendot.com/embedded-finance/reference/transfers_put_updatetransfer.md): Updates an existing transfer, including reversals. Reversals are subject to account status and balance requirements. Returns updated transfer details. - [Get Consumer Profile Extension – Retrieves extension attributes for a user's consumer profile.](https://developer.greendot.com/embedded-finance/reference/users_get_getconsumerprofileextension.md): Retrieves extension attributes for the specified user's consumer profile. Returns the requested attributes or all supported attributes if none are specified. - [Get Credit Line Range – Retrieves the eligible credit line range for an account based on income and expense information.](https://developer.greendot.com/embedded-finance/reference/users_get_getcreditlinerange.md): Retrieves the eligible credit line range for the specified account based on provided income and expense information. Returns the calculated range or an error if the input is invalid. - [Get Users Requiring ID Verification – Retrieves a list of users who require identity verification (IDV) for a given account.](https://developer.greendot.com/embedded-finance/reference/users_get_getusersrequireidv.md): Retrieves a list of users who require identity verification (IDV) for the specified account. Returns the list of users and their verification status. - [Get Validate Identity – Retrieves the identity validation status for a user.](https://developer.greendot.com/embedded-finance/reference/users_get_getvalidateidentity.md): Retrieves the identity validation status for the specified user and account. Returns the validation status and any related information. - [Get Validate SSN – Retrieves the SSN validation status for a user.](https://developer.greendot.com/embedded-finance/reference/users_get_getvalidatessn.md): Retrieves the SSN validation status for the specified user and account. Returns the validation status and any related information. - [Get Credit Scores – Retrieves credit scores for a user associated with an account.](https://developer.greendot.com/embedded-finance/reference/users_post_getcreditscores.md): Retrieves credit scores for the specified user and account. Optional date range filters can be provided. Returns the user's credit scores and related information. - [Add Consumer Profile Attachment – Uploads an attachment to a user's consumer profile.](https://developer.greendot.com/embedded-finance/reference/users_post_uploadconsumerprofileattachment.md): Uploads an attachment to the specified user's consumer profile. The request must include the attachment data and metadata. Returns the result of the upload operation. - [Validate Identity – Validates the identity information for a user.](https://developer.greendot.com/embedded-finance/reference/users_post_validateidentity.md): Validates the identity information for the specified user. Returns validation status and any errors encountered during the process. - [Validate SSN – Validates the Social Security Number (SSN) for a user.](https://developer.greendot.com/embedded-finance/reference/users_post_validatessn.md): Validates the Social Security Number (SSN) for the specified user. Returns validation status and any errors encountered during the process. - [Update Credit Line Source – Updates the source information for a credit line on an account.](https://developer.greendot.com/embedded-finance/reference/users_put_updatecreditlinesource.md): Updates the source information for a credit line on the specified account. Returns the result of the update operation. - [Update User – Updates an existing user profile.](https://developer.greendot.com/embedded-finance/reference/users_put_updateuser.md): Updates the user profile for the specified user identifier. Only the fields provided in the request will be updated. Returns the updated user details or validation errors. - [Update User Name](https://developer.greendot.com/embedded-finance/reference/users_put_updateusername.md): Updates the legal name of a user due to a legal event such as marriage, divorce, or court order. Requires supporting documentation and may trigger card re-issuance and CRM case creation. - [Retrieve Active Account Features](https://developer.greendot.com/embedded-finance/reference/vipfeature_get_getfeatures.md): Allows Partners to retrieve the active features that customers are enrolled in, including the startDate and expiredDate of the features. - [Retrieve Features For Showcase](https://developer.greendot.com/embedded-finance/reference/vipfeature_get_getfeaturesforshowcase.md): Allows Partners to retrieve: The active features that customers are enrolled in - The startDate and expiredDate of the features - [Enroll or Unenroll a Customer in an Account Feature](https://developer.greendot.com/embedded-finance/reference/vipfeature_put_updatefeature.md): · Enroll or Unenroll a Customer into or from an Additional Account Feature.
· Negative Balance: The Negative Balance feature is available to be used by Partners. This feature can only be requested during onboarding.
· Feature ID: NB100 – Negative balance $100 feature code. Depending on the terms and conditions included in the daa that is accepted during account registration, some features may need to be explicitly accepted via the PUT /accounts endpoint. Initially, all programs will be configured to not enforce terms acceptance. Once the system is configured to enforce terms acceptance for a feature, any customer that does not accept the terms for that feature will not be allowed to use the feature. For any programs, where customers are already using features that may require explicit terms acceptance, a data backfill will be required for those customers prior to enforcement being enabled. Please work with your Green Dot Account Manager and/or Product Manager to understand the impact and transition plan for your program and features.
· UCB 1 – 4: UCB tiers are cash back reward tiers based on program setup. These features are mutually exclusive. For example, if a customer is enrolled in UCB 1, then they cannot be enrolled in UCB 2, 3, or 4.
However, a customer can be enrolled in NB100 and a UCB feature. For example, NB100 and UCB 2.
· Remote Check Deposit Tiers (RCDTier): Check Deposit Tiers are required to use MRDC and to manage MRDC hold periods on an account.
· CDTiers are mutually exclusive, meaning an account can only be enrolled in one CDTier at a time.
· Call PUT /accounts/{accountIdentifier}/features/{featureId} to assign a CDTier to an account.
- [Create a barcode for cash deposit or payment](https://developer.greendot.com/embedded-finance/reference/barcode_generatebarcodev2.md): Creates a barcode number or barcode link for a cash deposit or cash payment transaction. - [Retrieve a barcode](https://developer.greendot.com/embedded-finance/reference/barcode_inquirebarcode.md): Retrieves barcode details by barcode number and retailer key. - [List barcodes by customer](https://developer.greendot.com/embedded-finance/reference/barcode_inquirebarcodebysenderref.md): Retrieves barcodes by customer in the specified date range. - [Void a barcode](https://developer.greendot.com/embedded-finance/reference/barcode_updatebarcodestatusbybarcodeid.md): Void a barcode by barcode number. - [Check connectivity and include a parameter](https://developer.greendot.com/embedded-finance/reference/ping_get_2.md): Checks for connectivity with Green Dot APIs and includes an input parameter in the request. - [Check connectivity](https://developer.greendot.com/embedded-finance/reference/ping_get.md): Checks for connectivity with Green Dot APIs. - [Check connectivity and include headers](https://developer.greendot.com/embedded-finance/reference/ping_pingwithheaders.md): Checks for connectivity with Green Dot APIs and includes headers and an input parameter in the request. - [List all retailers](https://developer.greendot.com/embedded-finance/reference/retailer_getretailerdetail.md): Retrieves the list of retailers for the program. - [List stores by zip](https://developer.greendot.com/embedded-finance/reference/store_getretailer_2.md): Retrieves the list of stores for the requested service by zip code. - [List specific number of stores by latitude and longitude](https://developer.greendot.com/embedded-finance/reference/store_getretailer_3.md): Retrieves a specific number of stores for the requested service by latitude and longitude. - [List a page of stores by latitude and longitude](https://developer.greendot.com/embedded-finance/reference/store_getretailer_4.md): Retrieves a page of stores for the requested service by latitude and longitude. - [List stores by latitude and longitude](https://developer.greendot.com/embedded-finance/reference/store_getretailer_5.md): Retrieves the list of stores for the requested service by latitude and longitude. - [List specific number of stores by zip](https://developer.greendot.com/embedded-finance/reference/store_getretailer.md): Retrieves a specific number of stores for the requested service by zip code - [Create a customer](https://developer.greendot.com/embedded-finance/reference/customer_createcustomerv11_2-2.md): Creates a customer profile for Cash Pickup. - [Create a customer with identifier](https://developer.greendot.com/embedded-finance/reference/customer_createcustomerv11-2.md): Creates a customer profile for Cash Pickup. - [Retrieve a customer](https://developer.greendot.com/embedded-finance/reference/customer_getcustomerbycustomeridv11-2.md): Retrieves customer profile details by Customer ID. - [Create a cash pickup link](https://developer.greendot.com/embedded-finance/reference/customerlink_createcashlink-2.md): Creates a link for the customer profile used to generate a Cash Pickup claim code. - [List links by ID](https://developer.greendot.com/embedded-finance/reference/link_linkbyprofiletokenv11-2.md): Retrieves customer and Cash Pickup links by Link ID. - [List links by customer](https://developer.greendot.com/embedded-finance/reference/link_linksbycustomeridv11-2.md): Retrieves cash pickup links by customer. - [Check connectivity with parameter](https://developer.greendot.com/embedded-finance/reference/ping_get_2-3.md): Checks for connectivity with Green Dot APIs and includes an input parameter in the request. - [Check connectivity](https://developer.greendot.com/embedded-finance/reference/ping_get-3.md): Checks for connectivity with Green Dot APIs. - [List pending transactions by customer](https://developer.greendot.com/embedded-finance/reference/transfer_getcashpickuptransfersbycustomerid-2.md): Retrieves pending Cash Pickup transactions by customer in the specified date range. - [Retrieve a transaction](https://developer.greendot.com/embedded-finance/reference/transfer_gettransferbytransferidv11-2.md): Retrieves Cash Pickup transaction by Transfer ID. - [Retrieve a transaction by request identifier](https://developer.greendot.com/embedded-finance/reference/transfer_gettransferbytransferrequestidv11-2.md): Retrieves Cash Pickup transaction by Transfer Request ID. - [Check transaction status](https://developer.greendot.com/embedded-finance/reference/transfer_gettransferdetailinfobytransferid-2.md): Retrieves the status of a Cash Pickup transaction. - [List all transactions by customer](https://developer.greendot.com/embedded-finance/reference/transfer_gettransfersbycustomeridv11_2-2.md): Retrieves Cash Pickup transactions by customer. - [List transactions by date](https://developer.greendot.com/embedded-finance/reference/transfer_gettransfersbycustomeridv11-2.md): Retrieves Cash Pickup transactions by customer in the specified date range. - [Cancel a claim code](https://developer.greendot.com/embedded-finance/reference/transfer_transferconfirmv11-2.md): Cancels a Cash Pickup claim code. - [Create a claim code](https://developer.greendot.com/embedded-finance/reference/transfer_transferv11-2.md): Creates a cash pickup claim code using the specified Transfer ID - [Direct Deposit Form](https://developer.greendot.com/embedded-finance/reference/directdepositform.md): Download Form pdf - [Get Customer Info](https://developer.greendot.com/embedded-finance/reference/getcustomer.md): Get customer information - [Get Direct Deposit Info](https://developer.greendot.com/embedded-finance/reference/getdirectdepositinfo-1.md): Get DirectDeposit Info - [Idv Upload Result](https://developer.greendot.com/embedded-finance/reference/idvdocumenturlrequest.md): FSC IDV Document Upload URL Request - [Idv Document Url Request](https://developer.greendot.com/embedded-finance/reference/idvdocumenturlresult.md): Verify IDV Upload Result Request - [Idv Upload](https://developer.greendot.com/embedded-finance/reference/idvupload-1.md): FSC IDV Document Upload - [Validate Registration](https://developer.greendot.com/embedded-finance/reference/registration-1.md): FSC Customer PreSignUp - [Sale Card](https://developer.greendot.com/embedded-finance/reference/salecard-1.md): FSC Sale Card - [Replace Card](https://developer.greendot.com/embedded-finance/reference/replacecard-1.md): Replace Card - [Search](https://developer.greendot.com/embedded-finance/reference/search.md): Search account information - [Reload](https://developer.greendot.com/embedded-finance/reference/authreload.md): Auth Reload Transaction - [Cash PickUp Auth](https://developer.greendot.com/embedded-finance/reference/cashpickupauth.md): Auth the CashPickUp Transaction - [Cash PickUp Commit](https://developer.greendot.com/embedded-finance/reference/cashpickupcommit.md): Commit the cash pick up transaction - [Cash PickUp Details](https://developer.greendot.com/embedded-finance/reference/cashpickupdetails.md): Get the details info of the cash pick up barcode - [Get Card Info](https://developer.greendot.com/embedded-finance/reference/getcardinfo-1.md): Get Card Info - [Return](https://developer.greendot.com/embedded-finance/reference/return-2.md): Reverse Transaction - [Unload](https://developer.greendot.com/embedded-finance/reference/unload-3.md): Auth Unload Transaction - [Validate Card For Unload](https://developer.greendot.com/embedded-finance/reference/validatecardforunload-1.md): Validate Card For Unload - [Validate Unload Eligibility](https://developer.greendot.com/embedded-finance/reference/validateunloadeligibility-1.md): Validate Unload Eligibility - [Void](https://developer.greendot.com/embedded-finance/reference/voidtransaction.md): Void Transaction - [Ping](https://developer.greendot.com/embedded-finance/reference/ping-9.md) - [Create Retail Chain User](https://developer.greendot.com/embedded-finance/reference/addeditteller.md): Add or edit teller - [Associate Retail Chain User With Card](https://developer.greendot.com/embedded-finance/reference/associatetellercard.md): Associate Teller's Card - [Get Retail Chain User Info](https://developer.greendot.com/embedded-finance/reference/getteller.md): Get teller - [Get EStatement Files](https://developer.greendot.com/embedded-finance/reference/getestatementfiles.md): GetEStatementFiles - [Get EStatement List](https://developer.greendot.com/embedded-finance/reference/getestatementlist.md): GetEStatementList - [Get Transaction History](https://developer.greendot.com/embedded-finance/reference/transactionhistory.md): Transaction History - [Get Transaction Info](https://developer.greendot.com/embedded-finance/reference/transactioninfo.md): Get transaction information - [API Reference Overview](https://developer.greendot.com/embedded-finance/reference/getting-started-with-your-api.md): This page will help you get started with Green Dot's API Reference documentation. ## Changelog - [Release 6-04-2026](https://developer.greendot.com/embedded-finance/changelog/release-6-04-2026.md) - [Release 5-15-2026](https://developer.greendot.com/embedded-finance/changelog/5-15-2026.md) - [Release 5-09-2026](https://developer.greendot.com/embedded-finance/changelog/release-5-08-2026.md) - [Release 4-23-2026](https://developer.greendot.com/embedded-finance/changelog/release-4-23-2026.md) - [Release 4-10-2026](https://developer.greendot.com/embedded-finance/changelog/release-4-10-2026.md)