Overview

The Accounts API allows Partners to:

• List the transactions for a specific account
• Retrieve account details
• Retrieve user’s primary account balances
• List available account statements for a specific period
• Verify user identities through Know Your Customer (KYC) and Green Dot

Accounts API Endpoints

Assigning Custom Account Identifiers

🚧

This feature can only be used if it has been agreed upon during onboarding and included in your onboarding contract.

This optional feature enables partners to assign their own account identifiers to their customer’s accounts. Simply call PUT /programs/{programCode}/accounts/{accountIdentifier} and include your partnerAccountIdentifier. The partnerAccountIdentifier facilitates cross-reference purposes, such as settlement and reconciliation reports.

API Call Structure

PUT /programs/{programCode}/accounts/{accountIdentifier}

Opt In/Out Terms or Agreements

This feature allows any terms or agreements that were opted into during enrollment to be opted out of later. Conversely, any terms or agreements that were opted out of during enrollment can be opted into later.

API Call Structure

PUT /programs/{programCode}/accounts/{accountIdentifier}

Request Parameters

Credit Line Decrease (CLD) Eligibility Criteria Change

This feature further determines when an SCC account is eligible for a Credit Line Decrease. And when eligible, this change replaces statement check with funding date, thereby ensuring a statement is generated in 30 days instead of 7.

Request

GET https://bospart.qa.uw2.gdotawsnp.com/baas/v1/programs/gbr/accounts/07d8ba76-6549-
4903-8434-90a11ae77300/cldEligibilityCheck HTTP/1.1
Accept-Encoding: gzip,deflate
Authorization: Bearer tcanJISPn0GUq4iImRY7Ig==
X-GD-RequestId: bf8b175e-5cfe-46d2-8cf0-fd6aea887e12
Content-Length: 0
Host: bospart.qa.uw2.gdotawsnp.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/1.8.0_181)

Response – Successful CLD

{
   "isEligible":true,
   "decreaseAmount":200,
   "responseDetails":[
      {
         "code":0,
         "subCode":0,
         "description":"Success",
         "url":"http://tbd"
      }
   ]
}

Response – Unsuccessful CLD

{
   "isEligible":false,
   "decreaseAmount":0,
   "responseDetails":[
      {
         "code":3,
         "subCode":810,
         "description":"Credit line decrease is not allowed since your account was opened less than a month ago.",
         "url":"http://tbd"
      }
   ]
}

Search Account

This endpoint allows partners to search through accounts.

API Call Structure

POST /programs/{programCode}/accounts/search

Update Account Status

🚧

This endpoint can only be used if the Partner is configured to change statuses.

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.

📘

Partners can unlock an account on their own IF the lock was performed by the Partner. To unlock accounts, call this API with the status you would like to set. Any accounts locked by Green Dot will remain locked until Green Dot returns status to healthy.

API Call Structure

PUT /programs/{programCode}/accounts/{accountIdentifier}/status

Valid Parameters and Conditions

Note: PUT /accounts/{accountIdentifier}/status can be used to update account status and account status reason under the following conditions.

Response Codes

📘

Status changes initiated by Green Dot (i.e. fraud or manual review) will override any partner-initiated status changes.

Partners must also send notes to the Green Dot Care team when updating an account status. When a valid request including the required notes property, is sent to PUT /accounts/{accountIdentifier}/status, the notes will be saved in CRM. Notes longer than 1000 characters will be truncated.

Obtain Account Fee Summary

This API obtains a fee summary for a specific account.

API Call Structure

GET ​/programs​/{programCode}​/accounts​/{accountIdentifier}​/feeSummary

Return Last Calculated Minimum Payment

After a customer schedules a one-time SCC payment and chooses the minimum-amount option, the BaaS GetSccPayment API returns this amount to Gateway so that it can request FundTransfer or CreateAmmRule with the correct amount.

API Call Structure

GET /programs/{programCode}/accounts/{accountIdentifier}/payments

Obtain Account Details

This endpoint retrieves detailed information about a specific account.

API Call Structure

GET /programs/{programCode}/accounts/{accountIdentifier}

📘

During the GPR > DDA upgrade process, the response will include the UpgradeKycStateData property. If the account is already a DDA account, the response will not include the UpgradeKycStateData property.

Sample Response Parameters

Update Account Details

This API updates detailed information about a specific account.

Structure of API Call

PUT​ /programs​/{programCode}​/accounts​/{accountIdentifier}

Obtain Bank Name

This API allows Partners to retrieve the bank name associated with a specific routing number.

Structure of API Call

GET /programs/{programCode}/bankNames?routingNumber={routingNumber}

API Call Structure Parameters

How it Works

Call GET …/bankNames?routingNumber={routingNumber} and include the routing number for which the bank name is being requested.

Sample Response Body Parameters

Response Codes

Close Account

This endpoint provides the ability to close accounts without the assistance of the Green Dot Care team.

Structure of API Call

PUT /programs/{programCode}/accounts/{accountIdentifier}/close

How it Works

• 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.

Response Codes

Closed Accounts

📘

APIs will be disabled for closed/purged accounts, so they can be placed into a closed terminal state.

How it Works

• The accountStatus of an account will be set to closed if it meets the following conditions:
  • The current status is restricted, the statusReason is customerInitiatedSpendDown, and the balance has been $0 for 60 days.
  • The current status is restricted, the statusReason is spendDown, and the balance has been $0 for 210 days.
• All state changing API endpoints will be blocked for a closed account.

Sample Response:

{
   "responseDetails":[
      {
         "code":3,
         "subCode":105,
         "description":"Account is closed.",
         "url":"http://tbd"
      }
   ]
}

Response Codes

📘

If an account is closed and any of the following endpoints are called, the following response details will be returned.

Obtain List of Fund Fulfillment MRDC Transfers

This endpoint accesses a list of MRDC transfers based on specific dates.

Structure of API Call

GET /programs/{programCode}/accounts/{accountIdentifier}/fundfulfillment/{transferIdentifier}/mrdc[?startDate][&endDate][&offset][&limit]

Obtain Fund Fulfillment MRDC Transfer

This endpoint accesses a specific MRDC transfer.

Structure of API Call

GET /programs/{programCode}/accounts/{accountIdentifier}/fundfulfillment/{transferIdentifier}/mrdc

Wire Out Transactions

🚧

This feature must be explicitly requested and configured on a per-partner basis. Contact your Green Dot Account Liaison for assistance.

This endpoint allows partners to wire out transactions and test in PIE (Partner Integration Environment).

Structure of API Call

POST /programs/{programCode}/accounts/{accountIdentifier}/wires

Request Body Parameters

encryptedBeneficiaryData Parameters

Refer to Crypto Primer for Banking as a Service (BaaS) for encryption details.

Sample Decrypted Data Parameters

Response Codes

Update User Identity

This API updates the identity for a specific user.

Structure of API Call

POST /programs​/{programCode}​/accounts​/{accountIdentifier}​/users​/{userIdentifier}​/identity

Obtain MRDC Transfer

This API retrieves the information for a specific MRDC transfer.

Structure of API Call

GET /programs​/{programCode}​/accounts​/{accountIdentifier}​/transfers​/{transferIdentifier}​/mrdc

Set Feature Eligibility

This API establishes the eligibility of a specific feature for a specific account.

Structure of API Call

PUT ​/programs​/{programCode}​/accounts​/{accountIdentifier}​/featureeligibility​/{featureId}

Obtain All Feature Eligibility

This API obtains feature eligibility details.

Structure of API Call

GET ​/programs​/{programCode}​/accounts​/{accountIdentifier}​/featureeligibility

Create Customer Profile (external account)

This API creates a customer profile for an external account.

Structure of API Call

POST​ /programs​/{programCode}​/externalAccounts

Update Customer Profile (external account)

This API updates a customer profile for an external account.

Structure of API Call

PUT​ /programs​/{programCode}​/externalAccounts/customers/{customerToken}

Link Customer Profile with Card (external account)

This API links a customer profile with a specific card for an external account.

Structure of API Call

POST​ /programs​/{programCode}​/externalAccounts/customers/{customerToken}/linkCard

Obtain Transfer from GFT Service (external account)

This API obtains a transfer from the GFT service for an external account.

Structure of API Call

GET​ /programs​/{programCode}​/externalAccounts/{externalAcctID}/transfers/{transferID}

Return List Link (external account)

This API returns a list link for an external account.

Structure of API Call

POST​ /programs​/{programCode}​/account/{accountIdentifier}/externalbankaccount

ACH Return Codes