Jump to Content

Guides API Reference Release Notes

v1.1

API Reference

1.1 (8-29-2025)Guides API Reference Release Notes

All

Pages

Start typing to search…

Getting started

API Reference Overview

BaaS APIs

Account
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
AMMRule
BillPay
BusinessProfile
CardOption
- Get Card Replacement Optionsget
CareCase
- Add Customer Care Casepost
CashbackReward
CategorizeTransaction
ContactVerification
CreditBuilder
- Credit Builder Enrollpost
CustomCard
DeviceVerification
- Verify a device for a user accountpost
- Update device verification status for a user accountput
DirectDeposit
Disbursement
DisputeAutomation
- Get Tokenized Dispute URLpost
- Create OAuth Token for Dispute Workflowpost
ECash
EGift
Enrollments
Event
Experian
ExternalAccount
ExternalCards
- Add or Validate External Bank Cardpost
- Get External Card Profileget
FeatureEligibility
- Get All Feature Eligibilityget
- Set Feature Eligibilityput
Fee
- Get fee waivers for a user within a date rangepost
- Get fee information by product code and fee type keypost
GuestVerification
- Create New Payeepost
HealthCheck
- Reports the health status of the service.get
- Tests if Green Dot services are healthyget
HostedUserExperience
- Get Hosted User Experience Configurationpost
InterestRate
Kyc
Locator
- Get ATM Locations Listget
- Get Retail Locations Listget
Notification
Order
- Submit a card inventory order request.post
- Check the status of a card inventory order.get
P2P TokenManagement
PaperCheck
Payment
PaymentInstrument
PaymentInstrumentToken
ProductFeatureLimits
- Get product feature limitsget
Products
- Get Interest Rate Tiers and APYs for a Productget
Program
- Retrieves program information for a given program code.get
- Gets interest rate tiers and APY for a program.get
Purse
Scc
- Retrieves OD Fee Eligible Transactions for an accountget
- Retrieves collection account status history for an accountget
SccEligibilities
Transactions
Transfers
Users
VIPFeature
Health Checks
PaymentInstrumentVgs
- Get Payment Instrument Details applying partner access control (VGS)get
TransactionEvent
- Create One Pay Transaction Eventpost

Cash Deposits and Payments

Barcode
Ping
Retailer
- List all retailersget
Store

Cash Pickup APIs

Customer
CustomerLink
- Create a cash pickup linkpost
Link
- List links by customerget
- List links by IDget
Ping
- Check connectivityget
- Check connectivity with parameterget
Transfer

FSC Retail APIs

Ping
- Pingget
Account Creation
Money Movement
Card Management
- Replace Cardpost
- Searchpost
Transactions
Teller Management

Powered by

Collections Health Check

get https://example.com/healthz/collections

Returns the result of health checks against collections

Language

Credentials

Header