Jump to Content
Guides
API Reference
Release Notes
v1.1
API Reference
1.1 (7-03-2025)
Guides
API Reference
Release Notes
Registration
Search
JUMP TO
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
delete
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
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
Update Affiliate
put
Get affiliates List
get
Get Affiliate
get
Delete Affiliate
delete
Create Affiliate Settlement
post
Update Affiliate Settlement
put
Get AffiliateSettlement
get
Delete AffiliateSettlement
delete
AMMRule
Create New AMM Rule
post
Delete AMM Rule
delete
Update AMM Rule
put
Bulk Update AMM Rule Priority
put
Get AMM Rules for Given Account Identifier
get
Get Rules by Target Account ID
get
Update AMM Rule Status
put
BillPay
Create New Payee – Creates a new payee for a customer’s account.
post
Get Payee List – Retrieves all active payees for a given account.
get
Get Payee by Payee Identifier – Retrieves payee information for a given payee identifier.
get
Update Payee – Updates an existing payee’s information.
put
Remove Payee – Deletes an existing payee from a user’s account.
delete
Search Payee – Searches for a payee in the payee directory by name.
post
Create New Payment – Schedules a new bill payment to a selected payee.
post
Get Payment List – Retrieves a list of payments for an account, optionally filtered by date and status.
get
Get Payment – Retrieves the details of a scheduled bill payment.
get
Update Payment – Updates the details of a scheduled bill payment.
put
Delete Payment – Deletes or cancels a scheduled bill payment.
delete
BusinessProfile
Get Business Profile
get
Update Business Profile
put
/programs/{programCode}/accounts/{accountIdentifier}/businessProfile/unencrypted
get
Get Business Lookup Data
get
Save Business Address
put
Set Business Profile Owner
post
Update Business Profile Owner
put
Delete Owner
delete
Save Business Info
put
Get Business Metadata
get
Save Business Application
post
CardOption
Get Card Replacement Options
get
CareCase
Set Customer Care Cases
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 Category for a Transaction
put
Get User Categoried Transaction
get
Get User Categoried Transaction Summary
get
ContactVerification
Generate Verifications
post
Check Verifications
put
Address Verifications
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 Device
post
Update Device
put
DirectDeposit
Creates Direct Deposit Dwitch Manual Form
post
Creates Direct Deposit Switch Attempt
post
Gets All Direct Deposit Switch Attempts
get
Updates a Direct Deposit Switch Attempt
patch
Gets 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 Url
post
Create OAuth Token
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
Post eGifts
post
Get eGifts
get
Get egiftID
get
Delete egiftID
delete
Get eGift Balance
get
Update eGift Balance
put
Get eGift Lifetime Rewards
get
Enrollments
Get Activation Link
get
Add Samples Enrollment (Encrypted)
post
Add Enrollment for User and Create Account/Card (Encrypted)
post
Adds SCC Enrollment and Create Account/Card (Encrypted)
post
Adds Retail Card Enrollment and Activate Card (Encrypted)
post
Recovers Retail Card (Encrypted)
post
Updates Enrollment Details (Encrypted)
put
Gets Enrollment Details (Encrypted)
get
Gets Enrollment Type by Mapping Identifier
get
Adds Linked Account Enrollment
post
Get Product Material Type List for Enrollment Flow
post
Event
Configuration Controller for Test Event Webhook Loopback Response Time
post
POC for Event Webhook Loopback RCV
post
POC for Event Webhook Loopback
post
Experian
Update OptIn
put
Get OptIn
get
Create AuthorizeExtend
post
Get RedirectUrl
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
Retrieve links for a customer profile by token and link type.
get
Link a card to a customer profile.
post
Retrieve a transfer by customer token and transfer ID.
get
Delete a bank link from a customer profile.
delete
Update a bank link for a customer profile.
put
Link a card to a source customer profile by GFT.
post
Delete a card link from a customer profile.
delete
Retrieve card links for a source customer profile.
get
Update a card link for a customer profile.
put
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 Waived for a User between a Range
post
Get Fee Info by Product Code and Fee Type Key
post
GuestVerification
Create New Payee
post
HealthCheck
Reports Service Health Status
get
Tests if Green Dot Dot Servicers are Reachable
get
HostedUserExperience
Get Hosted User Experience Config
post
InterestRate
Get Purse Interest Rate Tiers
get
Add Interest Rate Tier
post
Update Interest Rate Tier
put
Delete Interest Rate Tier
delete
/programs/{programCode}/InterestRateTiers
post
/programs/{programCode}/InterestRateTiers
put
/programs/{programCode}/InterestRate/ChangeRequest
post
Kyc
Add KYC2 Request – Creates a KYC2 gate request for a user.
post
Add KYC1 Request – Creates a KYC1 gate request for a user.
post
Add IDV Request – Submits identification verification information for a user.
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
Order
Post to Receive Card Inventory Order from Partners
post
Check Card Inventory Order Status
get
P2P TokenManagement
Generate Suggested Token Name
post
Create User Token
post
Get User Token by AccountIdentifier
get
Update User Token
put
Update Nickname and Status of Recipient
put
Get User Token by Token Name
get
Get List of Contacts from Directory
post
Get All Recipients for a Token
post
Add Token to Recipient List
post
PaperCheck
Stop Paper Check Payment
put
Update Check Book Order
put
Get Check Book Orders
get
Get Check Payment Images
get
Payment
Get Payment Details for Given Account
get
Pre-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
PaymentInstrumentToken
Get List of Push Provision Config Options
get
Get List of Payment Instrument Tokens
get
Creates Push Provisioning Data for App-Initiated Digital Wallet Operations
post
Creates Push Provisioning Data for App-Initiated Digital Wallet Operations
post
ProductFeatureLimits
Get Product Feature Limits
get
Products
Product Interest Rate Tier
get
Program
/programs/{programCode}/GetProgramInfo
get
Get List of Interest Rate Tiers and APY by Programcode
get
Purse
Add Purse – Creates a new savings purse for an account.
post
Get Purses – Retrieves all purses and balances for an account.
get
Update Purse – Updates the details of a specific purse.
put
Close Purse – Closes an empty, non-spending savings purse.
delete
Calculate Interest – Calculates interest earned for a purse over a specified date range.
get
Scc
Get OD Fee Eligibe Transactions
get
/programs/{programCode}/accounts/{accountIdentifier}/collectionAccountStatusHistory
get
SccEligibilities
Check SCC Eligibilities
get
Check Credit Line Increase Eligibility
get
Check Credit Line Decrease Eligibility
get
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
Submit Check for MRDC
post
Get Bank Eligibility by Routing Number
get
Generate External Account Link Token
post
Get GFT Fees and limits
get
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
Update Feature
put
Get Feature
get
Get Feature For Showcase
get
Health Checks
Config Health Check
get
Env Health Check
get
Version Health Check
get
Liveness Health Check
get
Readiness Health Check.
get
Synthetic validation Health Check.
get
Uncached Readiness Health Check.
get
Startup Health Check
get
Always Encrypted Column Health Check
get
Downstream Health Check
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
Registration
(Internal - exclude from public portal)
