Jump to Content
Guides
API Reference
Release Notes
v1.1
API Reference
1.1 (7-01-2024)
Guides
API Reference
Release Notes
PaymentInstrument
JUMP TO
Getting started
API Reference Overview
BaaS APIs
Account
Get Account
get
Update Account
put
/programs/{programCode}/accounts/{accountIdentifier}/getAccountForShowcase
get
Get Linked Accounts Info
get
Get eStatements
get
Get eStatements List
get
Search Account
post
Update Account Status to Restricted
put
Update Account Status to Specified Status with Notes
put
Get Users
get
Update Users
put
Update Users Identity
post
Execute KYC
post
Returns List of Transfers for an Account in a Specific Time Period
get
Updates Check Status by Accepting or Rejecting the Transfer
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 by Transfer Identifier
get
Get MRDC Transfer
get
Get P2P Transfer
get
Get All P2P Transfer
get
Get All External Cards
get
Delete an External Card
delete
Add an Account Holder to an Exiting Account
post
Get All Linked Accounts
get
Get SSO Token
get
Get Auth Customer Enrollment
get
Perform OD Eligibility Check Based on Inquiry Date
get
Get a taxdocument
get
Get a Tax Document by Doc Type
get
Get List of Tax Documents
get
Get List of Tax Documents by Doc Type
get
Get Account Fee Summary
get
Get Account Type
get
Adjustment
Adjust Balance
post
Get Adjust Balance Status Async
get
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
post
Get Payee List
get
Get Payee by Payee Identifier
get
Update Payee
put
Remove Payee
delete
Search Payee
post
Create New Payment
post
Get Payment List
get
Get Payment
get
Update Payment
put
Delete 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 Options
get
CareCase
Set Customer Care Cases
post
CashbackReward
Get Cashback Reward Business Process Rules
get
Get Cashback Reward Summary
get
Get Cashback Reward Summary
get
Post Cashback Reward OBS Redeem
post
Post Cashback Reward Redeem
post
Get Cashback Reward OBSInquiry
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
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
Creates Bank Card Link
post
Creates Cash Link
post
Create Ach Link
post
Get Transfer Status
get
Generic Transfer
post
Update Transfer to Cancel Claim Code
put
DisputeAutomation
Get Tokenized Url
post
Create OAuth Token
post
ECash
Get ECash Partners
get
Get ECash Partners by location
get
Gets the active barcodes associated with account identifier
get
Gets Details of the Barcode
get
Generates New Barcode for Given 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
Enrolls for DM/WB's Activation
post
Enrolls User into Product and Creates Account and Card
post
Enrolls SCC User into Product and Creates Account and Card
post
Enrolls Retail Customer into Product and Creates Account and Activates Card
post
Recovers Retail Card
post
Update Enrollment Details
put
Get Enrollment Details
get
Get Enrollment Type by Mapping Identifier
get
Create Linked Account
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 Customer Profile in Green Dot System
post
Update Customer Profile
put
Get Customer Profile
get
Get Transfer Limits and Fee Rates
get
Link Card for Transfers
post
Get Card Links
get
Get Transfer from GFT Service
get
Delete Link Card
delete
Update Link
put
Link Card to Source Profile by GFT(Global Fund Transfer)
post
Get Card Links
get
Search Transfers by date range from GFT Service
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
Create KYC1 Request
post
Create IDV request
post
Create KYC2 Request
post
Submit OOW Answers
post
Create ScanCapture Request
post
IDV Socure Request
post
IDV Document Request
post
Locator
Get ATM Location List
get
Get Retail Location List
get
Notification
Create Notification Enrollment
post
Get Notification Enrollment
get
Get Inbox Message
get
Get Notification Enrollment
put
Get Inbox Message Count
get
Order
Post to Receive Card Inventory Order from Partners
post
Check Card Inventory Order Status
get
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
get
Set ATM Pin for Payment Instrument
put
Get User Payment Instrument List
get
Complete Incomplete Status Registrations
post
Set ATM Pin on Payment Instrument
post
Validate Card CVV
post
Activate Card via Account Identifier
post
Activate Card via Payment Instrument Identifier
post
Activate Card for Pre-Login
post
Update Lifecycle Event
put
Get Delivery Status
get
Get Replace Card Eligibility
get
Validate Card CVV
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
Create New Purse
post
Get Purses
get
Update Purse
put
Close Saving Purse
delete
Calculate Interest
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
TokenManagement
This API will generate suggested token name
post
Create user token
post
Get user token by AccountIdentifier
get
Update user token
put
Update NickName and Status of the recipient
put
Get user token by Token Name
get
Get the list of contacts from directory
post
Get all recipients for a token
post
/programcode/{programCode}/accounts/{accountIdentifier}/contacts
post
Transactions
Get Pagination
get
Get Transactions List
get
Get Interest Earned
get
Get Direct Deposits Information
get
Get Direct Deposits Depositor Information
get
Get cashBackReward Transactions List
get
Get Related Transactions by transactionIdentifier
get
Get Overdraft Auth transactions
get
Get Overdraft Transactions List
get
Transfers
Create New ACH Transfer
post
Get Delivery Date
get
Create New MRDC Transfer
post
Assess MRDC Transfer
post
Updates Funds Available Date to Earlier Date
put
Transfer from Partner to Partner or Purse to Purse
post
Transfer from Partner to User or Purse to Purse
post
Assess an ACH Transfer.
post
Assess Update Transfer
put
Update Existing Transfer
put
Wire Out Transfer
post
Returns a List Link to External
post
Update Existing Transfer
post
Get Bank Names
get
Submit Check for MRDC
post
Create Token
post
Disburse or Transfer from Business/ Partner to Customer's Card
post
Handles Health Check Requests from Single Commit Operation
get
Transfer from Partner to User by GFT(Global Fund Transfer)
post
Users
Update User
put
Update Username
put
Validate SSN
post
Get ValidateSSN for Baas Gateway
get
Validate Identity
post
Get ValidateIdentity for Baas Gateway
get
Get Credit Line Range
get
Upload Attachment
post
Get Consumer Profile Extension
get
Update Credit Line Source
put
Get Credit Scores for SCC Users
post
Get Users RequireIDV
get
VIPFeature
Update Feature
put
Get Feature
get
Health Checks
Config Health Check
get
Env Health Check
get
Version Health Check
get
Liveness Health Check
get
Readiness 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
Sale Card
post
Get Direct Deposit Info
post
Direct Deposit Form
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
PaymentInstrument
