For AI agents: visit https://developer.greendot.com/embedded-finance/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Guides
API Reference
Release Notes
v(9-01-26)
API Reference
v(9-01-26)
Guides
API Reference
Release Notes
User
Getting started
API Reference Overview
BaaS APIs
Account
Get Account Details
get
Update Account Terms Acceptances
put
Get Account Details for Showcase
get
Get Linked Accounts Info
get
Get eStatement PDF
get
Get eStatements List
get
Search Account
post
Update Account Status to Restricted
put
Update Account Status and Reason
put
Get Users
get
Update User
put
Update ITIN
post
Execute KYC
post
Get ACH Transfers
get
Update Check
put
Get MRDC Transfer
get
Get Fund Fulfillment MRDC Transfer
get
Get MRDC Transfer List
get
Get Fund Fulfillment MRDC Transfer List
get
Get Check Images
get
Get MRDC Transfers On Hold
get
Get P2P Transfer
get
Get All P2P Transfers
get
Get All External Cards
get
Delete External Card
del
Add Account Holder
post
Get Linked Account
get
Get Auth Customer SSO Token
get
Get Auth Customer Enrollment
get
OD Eligibility Check
get
Get Tax Document (INT-1099)
get
Get Tax Document (by Type)
get
Get Tax Document List (INT-1099)
get
Get Tax Document List (by Type)
get
Get Account Fee Summary
get
Get Account Type
get
Get Account IDs by Partner Consumer ID
get
AccruedInterest
Process Accrued Interest – Processes accrued interest calculations for a program.
post
Adjustment
Creates a balance adjustment for the specified account. Supports adjustment types such as promo, instructionCredit, disbursement, achOut, and their reversals.
post
Retrieves the status of a previously submitted balance adjustment request.
get
Affiliate
Create Affiliate
post
Get Affiliates List
get
Update Affiliate
put
Get Affiliate
get
Delete Affiliate
del
Create Affiliate Settlement
post
Update Affiliate Settlement
put
Get Affiliate Settlement
get
Delete Affiliate Settlement
del
AMMRule
Create a new AMM rule for an account
post
Delete an AMM rule
del
Update an existing AMM rule
put
Bulk update AMM rule priorities
put
Get AMM rules for a given account identifier
get
Get AMM rules by target account identifier
get
Update the status of an AMM rule
put
BillPay
Create New Payee
post
Get Payee List
get
Get Payee by Payee Identifier
get
Update Payee
put
Delete Payee
del
Search Payee by Name
post
Schedule Bill Payment
post
Get Payment List
get
Get Payment
get
Update Scheduled Bill Payment
put
Delete Scheduled Bill Payment
del
BusinessProfile
Get Business Profile
get
Update Business Profile
put
Get Business Profile (Unencrypted)
get
Get Business Lookup Data
get
Save Business Address
put
Set Business Profile Owner
post
Update Business Profile Owner
put
Delete Business Profile Owner
del
Save Business Info
put
Get Business Metadata
get
Save Business Application
post
CardOption
Get Card Replacement Options
get
CareCase
Add Customer Care Case
post
CashbackReward
Get Cashback Reward Business Process Rules
get
Get Cashback Reward Summary
get
Get Cashback Reward Inquiry
get
Redeem Cashback Rewards via OBS
post
Redeem Cashback Rewards
post
Get Cashback Reward OBS Inquiry
get
CategorizeTransaction
Set a category for a transaction
put
Get categorized transactions for a user
get
Get a summary of categorized transactions for a user
get
Certificates
Get Program Public Certificates for ECC Encryption
get
ContactVerification
Generate Contact Verifications
post
Check Contact Verifications
put
Validate Address and Return Suggestions
post
Get Contact Verification Status
get
CreditBuilder
Credit Builder Enroll
post
CustomCard
Get Custom Card
get
Create Custom Card
post
Cancel Custom Card
post
DeviceVerification
Verify a device for a user account
post
Update device verification status for a user account
put
DirectDeposit
Add Direct Deposit Manual Form
post
Add Direct Deposit Switch Attempt
post
Get All Direct Deposit Switch Attempts
get
Update Direct Deposit Switch Attempt
patch
Get Latest Direct Deposit Switch Attempt
get
Disbursement
Create Bank Card Link
post
Create Cash Link
post
Create ACH Link
post
Get Transfer Status
get
Create Disbursement Transfer
post
Update Disbursement Transfer
put
DisputeAutomation
Get Tokenized Dispute URL
post
Create OAuth Token for Dispute Workflow
post
ECash
Lists participating eCash partners associated with a program.
get
Retrieves eCash partners by geographic location for a specific account.
get
Gets the active barcodes associated with an account identifier.
get
Retrieves details of a specific barcode associated with a user’s account.
get
Generates a new barcode for a given eCash partner (retailer).
post
EGift
Get eGift Catalog
get
Purchase an eGift
post
Get eGift Wallet
get
Get eGift by ID
get
Delete an eGift by ID
del
Get eGift Balance
get
Update eGift Balance
put
Get eGift Lifetime Rewards
get
Enrollments
Add Enrollment for User and Create Account/Card (Encrypted)
post
Gets Enrollment Details (Encrypted)
get
Event
Configure Test Event Webhook Loopback Response
post
Receive and validate Event Webhook Loopback (RCV) for testing integrations
post
Simulate Event Webhook Loopback for Testing
post
Experian
Update Experian Opt-In Status
put
Get Experian Opt-In Status
get
Create Authorization Extension
post
Get Experian Redirect URL
get
ExternalAccount
Create a new customer profile in the Green Dot system.
post
Update an existing customer profile.
put
Retrieve a customer profile.
get
Get transfer limits and fee rates for a program.
get
Link a bank account to a customer profile.
post
Link a card to a customer profile.
post
Retrieve a transfer by customer token and transfer ID.
get
Assess/validate transfer limits for a customer profile.
get
Delete a bank link from a customer profile.
del
Update a bank link for a customer profile.
put
Delete a card link from a customer profile.
del
Update a card link for a customer profile.
put
Link a card to a source customer profile by GFT.
post
Retrieve card links for a source customer profile.
get
Retrieve links for a customer profile by token and link type.
get
Search transfers by date range for a customer profile.
get
ExternalCards
Add or Validate External Bank Card
post
Get External Card Profile
get
FeatureEligibility
Get All Feature Eligibility
get
Set Feature Eligibility
put
Fee
Get fee waivers for a user within a date range
post
Get fee information by product code and fee type key
post
GuestVerification
Create New Payee
post
HealthCheck
Reports the health status of the service.
get
Tests if Green Dot services are healthy
get
HostedUserExperience
Get Hosted User Experience Configuration
post
InterestRate
Retrieves a list of all Interest Rate Tiers and Annual Percentage Yields (APYs)
get
Add a new interest rate tier to an existing purse.
post
Update an existing interest rate tier for a specified purse and account.
put
Deletes an interest rate tier for a specified program, account, and purse.
del
Adds a new program-level interest rate tier.
post
Updates an existing program-level interest rate tier.
put
Creates a new interest rate change request for a program.
post
Kyc
Create Legacy / Limited Verification KYC Request
post
Add IDV Request – Submits identification verification information for a user.
post
Create KYC Request
post
Submit OOW Answers – Submits out-of-wallet (OOW) answers for KYC verification.
post
Add ScanCapture Request – Submits Matricula Consular ID images for verification.
post
Add IDV Socure Result – Validates user’s identification documents uploaded via Doc V SDK.
post
Generate DocV Document Request – Returns a DocVTransaction Token for Socure DocV SDK initialization.
post
Locator
Get ATM Locations List
get
Get Retail Locations List
get
Notification
Add Notification Enrollment – Creates a notification enrollment for an account.
post
Get Notification Enrollment – Retrieves the notification enrollment details for an account.
get
Get Inbox Messages – Retrieves inbox messages for an account, with optional filtering and pagination.
get
Mark Message As Read – Updates the status of an inbox message to 'read' for an account.
put
Get Inbox Message Count – Retrieves the count of inbox messages for an account, optionally filtered by status.
get
Ofac
OFAC2 Cure Gate for Enrollment
post
Order
Submit a card inventory order request.
post
Check the status of a card inventory order.
get
PaperCheck
Update Paper Check Payment Status
put
Update Check Book Order Status
put
Get Check Book Orders
get
Get Check Payment Images
get
Payment
Get Payment Details for an Account
get
Authorize a closed loop transaction
post
Get status of a closed loop transaction
get
PaymentInstrument
Get Payment Instrument Details
get
Set ATM Pin for Payment Instrument
put
Get User Payment Instrument List
get
Complete Payment Instrument Registration
post
Verify ATM Pin for Payment Instrument
post
Validate Card CVV
post
Activate Card via Account Identifier
post
Activate Card via Account Identifier
post
Activate Card for Pre-Login
post
Update Payment Instrument Lifecycle Event
put
Get Payment Instrument Delivery Status
get
Get Replace Card Eligibility
get
Validate Card for Pre-Login
post
/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}/pushProvisionData/onepay
post
PaymentInstrumentToken
Retrieve a list of push provision configuration options for a specific account.
get
Retrieve a list of previously provisioned payment instrument tokens for a specific account.
get
Create Push Provisioning Data for App-Initiated Digital Wallet Operations
post
Create Push Provisioning Data for App-Initiated Digital Wallet Operations
post
PaymentInstrumentVgs
Get Payment Instrument Details applying partner access control (VGS)
get
ProductFeatureLimits
Get product feature limits
get
Products
Get Interest Rate Tiers and APYs for a Product
get
Get Terms and Conditions for a Product
get
Get Term By Id for a Product
get
Program
Retrieves program information for a given program code.
get
Gets interest rate tiers and APY for a program.
get
Purse
Add Purse – Creates a new savings purse for an account.
post
Get Purses – Retrieves all purses and balances for an account.
get
/programs/{programCode}/accounts/{accountIdentifier}/purses/{purseIdentifier}/CreditBuilder/payment
post
Update Purse – Updates the details of a specific purse.
put
Close Purse – Closes an empty, non-spending savings purse.
del
Calculate Interest – Calculates interest earned for a purse over a specified date range.
get
Scc
Retrieves OD Fee Eligible Transactions for an account
get
Retrieves collection account status history for an account
get
SccEligibilities
Check SCC Eligibilities
get
Check Credit Line Increase Eligibility
get
Check Credit Line Decrease Eligibility
get
TokenManagement
Generate User Token Name Suggestions
post
Create User Token
post
Get User Tokens by Account Identifier
get
Update User Token by Resource Identifier
put
Update Recipient Nickname and Status
put
Get User Tokens by Resource Identifier
get
Search Contacts in Directory
post
Get All Recipients for a Token
post
Add Token to Recipient List
post
TransactionEvent
Create One Pay Transaction Event
post
Transactions
Gets Transaction Pagination
get
Get Transactions List
get
Get Interest Earned
get
Get Direct Deposits
get
Get Direct Depositor Information
get
Get Cash Back Reward Transactions
get
Get Related Transactions
get
Get Overdraft Fee Authorization Transactions
get
Get Overdraft Transactions
get
Transfers
Create New ACH Transfer
post
Get ACH Delivery Date
get
Create MRDC Transfer
post
Assess MRDC Transfer Eligibility
post
Update MRDC Funds Available Date
put
Create Transfer (B2C, A2A, or P2P)
post
Assess Transfer Prerequisites
post
Assess ACH Transfer Prerequisites
post
Assess Update Transfer
put
Update Existing Transfer
put
Create Wire Out Transfer
post
Link External Bank Account via ACH
post
Get Transfer by Token (Guest Checkout)
post
Get Bank Name by Routing Number
get
Get Bank Eligibility by Routing Number
get
Get GFT Fees and limits
get
Submit Check for MRDC
post
Generate External Account Link Token
post
Create Single-Commit Transfer
post
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.
get
Create GFT (Global Fund Transfer)
post
Users
Update User – Updates an existing user profile.
put
Update User Name
put
Validate SSN – Validates the Social Security Number (SSN) for a user.
post
Get Validate SSN – Retrieves the SSN validation status for a user.
get
Validate Identity – Validates the identity information for a user.
post
Get Validate Identity – Retrieves the identity validation status for a user.
get
Get Credit Line Range – Retrieves the eligible credit line range for an account based on income and expense information.
get
Add Consumer Profile Attachment – Uploads an attachment to a user's consumer profile.
post
Get Consumer Profile Extension – Retrieves extension attributes for a user's consumer profile.
get
Update Credit Line Source – Updates the source information for a credit line on an account.
put
Get Credit Scores – Retrieves credit scores for a user associated with an account.
post
Get Users Requiring ID Verification – Retrieves a list of users who require identity verification (IDV) for a given account.
get
VIPFeature
Enroll or Unenroll a Customer in an Account Feature
put
Retrieve Active Account Features
get
Retrieve Features For Showcase
get
Cash Deposits and Payments
Barcode
Retrieve a barcode
get
List barcodes by customer
get
Void a barcode
post
Create a barcode for cash deposit or payment
post
Ping
Check connectivity
get
Check connectivity and include a parameter
get
Check connectivity and include headers
get
Retailer
List all retailers
get
Store
List specific number of stores by zip
get
List stores by zip
get
List specific number of stores by latitude and longitude
get
List a page of stores by latitude and longitude
get
List stores by latitude and longitude
get
Cash Pickup APIs
Customer
Retrieve a customer
get
Create a customer with identifier
post
Create a customer
post
CustomerLink
Create a cash pickup link
post
Link
List links by customer
get
List links by ID
get
Ping
Check connectivity
get
Check connectivity with parameter
get
Transfer
Create a claim code
post
Retrieve a transaction
get
Retrieve a transaction by request identifier
get
List transactions by date
get
List all transactions by customer
get
List pending transactions by customer
get
Check transaction status
get
Cancel a claim code
post
FSC Retail APIs
Ping
Ping
get
Account Creation
Validate Registration
post
Idv Upload
post
Idv Document Url Request
post
Idv Upload Result
post
Sale Card
post
Get Direct Deposit Info
post
Direct Deposit Form
post
Get Customer Info
post
Money Movement
Get Card Info
post
Reload
post
Validate Unload Eligibility
post
Validate Card For Unload
post
Unload
post
Void
post
Return
post
Cash PickUp Details
post
Cash PickUp Commit
post
Cash PickUp Auth
post
Card Management
Replace Card
post
Search
post
Transactions
Get Transaction Info
post
Get Transaction History
post
Get EStatement List
post
Get EStatement Files
post
Teller Management
Create Retail Chain User
post
Associate Retail Chain User With Card
post
Get Retail Chain User Info
post
User
Updated 12 months ago
API Reference Overview
Did this page help you?
Yes
No
Updated 12 months ago
API Reference Overview
Did this page help you?
Yes
No
