MRDC API Endpoints

MRDC Agreement

MRDC agreement is an additional feature that will allow MRDC to be used as a termsIdentifier so that Partners can indicate if a customer has accepted the MRDC terms (agreement). Initially, all programs will be configured to not enforce terms acceptance. This feature is only available for programs that have been configured to support it.

Once the system is configured to enforce terms acceptance for a feature, any customer that does not accept the terms for that feature will not be allowed to use the feature. For any programs, where customers are already using features that may require explicit terms acceptance, a data backfill will be required for those customers prior to enforcement being enabled.

Please work with your Green Dot Account Manager and/or Product Manager to understand the impact and transition plan for your program and features.

• Accept MRDC Terms (involves Partner API changes)

1. Call POST Enrollments or PUT Accounts with:
   1. termsIdentifier: MRDC and
   2. termsAcceptanceFlag: true
2. The MRDC Agreement will then be saved as accepted.
3. Call GET Accounts to retrieve the MRDC Agreement.

• Reject MRDC Terms

1. Call PUT Accounts with:
   1. termsIdentifier: MRDC and
   2. termsAcceptanceFlag: false
2. The MRDC Agreement will then be saved as rejected.
3. Call GET Accounts to retrieve the MRDC Agreement.

• Example: PUT https://bospart/baas/v1/programs/acme/accounts/11e56a47-5b3c-4c1d-9022- c248b0f41f69

)
{
   "termsAcceptances":[
      {
         "termsIdentifier":"mrdc",
         "termsAcceptanceFlag":"true",
         "termsAcceptanceDateTime":"2019-07-15T19:48:15.640Z"
      }
   ]
}

RCDTier and MRDC

Note: This feature is available only to programs with MRDC enabled.

Partners have the option to own Instant Funds eligibility or to allow Green Dot to determine Instant Funds eligibility.

• If a Partner has requested to be configured to manage hold periods or instant funds on check deposits (instantFundManaged: true), then Green Dot will apply a hold period based on the RDCTier assigned by the Partner to the account. The Partner will be responsible for adding the account subscription with applicable hold period tier to the account.

• If the instantFundManaged flag is set to false, Green Dot will check for Instant Funds eligibility and apply the hold period based on the results. Green Dot will be responsible for checking Instant Funds eligibility.

Note: Partners who are configured with instantFundManaged must first assign check deposit tiers (CDTier) to accounts to use MRDC and to manage MRDC hold periods.

• Call PUT /features/{featureID} to add a CDTier.
• MRDC transfers are not allowed if a CDTier is not assigned to the account.
• CDTiers are mutually exclusive, meaning an account can only be enrolled in one CDTier at a time.

Response Codes

Obtain MRDC Transfers On Hold

This endpoint obtains MRDC transfers that are on hold for a specific account.

API Call Structure

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

Response Body

{

"transfers": [

{

"transferIdentifier": "string",

"accountIdentifier": "string",

"initiator": "string",

"transferType": "string",

"isSource": true,

"transferStatus": "string",

"transactionAmount": 0,

"mobilePhoneNumber": "string",

"firstName": "string",

"lastName": "string",

"userName": "string",

"memo": "string"

}

],

"responseDetails": [

{

"code": 0,

"subCode": 0,

"description": "string",

"url": "string"

}

]

}

Parameters

Refer to API Call Structure Field Definitions for full details.

Create New MRDC Transfer

This endpoint allows you to:

• Create new MRDC transfers
• Run check deposits through a pre-validation process where the user is forced to either accept the “Funds Available Date” or a “Manual Review”.

Note: After the pre-requisites are met for the “Submit Check” call internally, the POST transfers/mrdc moves forward for further processing and the following results may occur.

API Call Structure

POST /programs/{programCode}/transfers/mrdc

If a user’s account changes to a non-normal status between the time that they submit a check and the time it is posted, then the deposit will fail. Note: A normal account status is one of the pre-requisites that users must meet in order to submit a check.

How it Works

• Once a check is placed under Manual Review, it will go through the following process:
  • The customer will be prompted to accept the review by agent.
  • If the customer accepts the review by agent, the check will be accepted and marked for agent review.
  • The agent will complete the manual review.
    • If the check is declined, a webhook containing the subStatus declinedByAgent will be returned and the transaction will be declined.
    • If the check is approved, a webhook containing the subStatus fundsScheduled and the funds available date will be returned.
    • The funds will post to the customer’s account on the funds available date and a webhook containing the subStatus fundsPosted and the transferStatus completed will be returned.
• Once a check is accepted with a funding date available, it will go through the following process:
  • The customer will be prompted to accept the funding date.
  • If the customer accepts the funding date, the check will be accepted.
    • The funds will post to the customer’s account on the funds available date and a webhook containing the subStatus fundsPosted and the transferStatus completed will be returned.

Image Best Practices

Sample Request Body

{
   "transferIdentifier":" 46cee849-79ae-4865-a1b4-450697803141",
   "currency":"USD",
   "transferRoute":{
      "transactionAmount":5.45,
      "sourceTransferEndpoint":{
         "latitude":34.1539941,
         "longitude":-118.0917594,
         "encryptedCheckImageData":{
            "version":"string",
            "ephemeralPublicKey":"string",
            "publicKeyHash":"string",
            "data":"string"
         },
         "imageFormat":"jpeg",
         "device":{
            "deviceID":"8E847BB848CDAECA94888E847BB848CDAECA9488",
            "deviceMake":"Apple",
            "deviceVersion":"iPhone4G",
            "deviceOS":"iOS",
            "deviceOSVersion":"12.1.2"
         }
      },
      "targetTransferEndpoint":{
         "accountIdentifier":"string"
      }
   },
   "fraudData":{      
   }
}
Unencrypted Check Image
{
   "frontCheckImage":"string",
   "backcheckImage":"string"
}

Request Parameters

Sample Response – Submit Check Happy Path

{
   "transfer":{
      "transferIdentifier":"64beeea0-8ed2-4862-9364-39d21f3a8ff9",
      "transferStatus":"pending",
      "checkDeposit":{
         "checkDepositStatus":"pending",
         "checkDepositSubStatus":"pendingUserAcceptance",
         "transactionAmount":50.0,
         "checkSubmitDate":"2020-08-19T19:44:47.255Z",
         "fundsAvailableDate":"2020-08-26T19:44:47.255Z"
      }
   },
   "responseDetails":[
      {
         "code":0,
         "subCode":0,
         "description":"Success",
         "url":"http://tbd"
      }
   ]
}

Sample Response – declinedByRisk

{
   "responseDetails":[
      {
         "code":913,
         "subCode":2022,
         "description":"Fraud system declined",
         "url":"http://tbd"
      }
   ],
   "transfer":{
      "transferIdentifier":"77927b7b-d2a4-445e-a659-d0bac2fee360",
      "transferStatus":"declined",
      "checkDeposit":{
         "checkDepositStatus":"declined",
         "checkDepositSubStatus":"declinedByRisk",
         "transactionAmount":50.00,
         "checkSubmitDate":"2019-05-16"
      }
   }
}

Response Parameters

Note: The following outcomes are supported at this stage of development.

Invalid Routing Number

Routing numbers will be validated for submitted checks.

Sample Request Body

{
   "transferIdentifier":"eb9494f9-d4db-4389-b1db-a065c13103ae",
   "currency":"USD",
   "transferRoute":{
      "transactionAmount":"10.0",
      "sourceTransferEndpoint":{
         "latitude":"34.1539941",
         "longitude":"-118.0917594",
         "encryptedCheckImageData":{
            "version":"EC_v1",
            "ephemeralPublicKey":"string”,
            "imageFormat": ""jpeg"",
            "device": {
            “deviceID”: 
            "8J847CX848CDAECA94888E847BB848CDAECA9488",
            "deviceMake": ""Apple"",
            "deviceVersion": ""iPhoneXS"",
            "deviceOS": ""iOS"",
            "deviceOSVersion": "12.1.2"
            }
         },
         "targetTransferEndpoint": {
             "accountIdentifier": "3f034af7-be57-4a2c-9aee-36a8c3221325"
	},
	"fraudData": {}		
  }
}

Sample Response Body

{
   "transfer":{
      "transferIdentifier":"f6381354-e88f-4cca-a22d-45ebffdb9565",
      "transferStatus":"declined",
      "checkDeposit":{
         "checkDepositStatus":"declined",
         "checkDepositSubStatus":"declined",
         "transactionAmount":10.0,
         "checkSubmitDate":"2020-05-05T19:44:47.255Z"
      }
   },
   "responseDetails":[
      {
         "code":909,
         "subCode":4037,
         "description":"Invalid routing number",
         "url":"http://tbd"
      }
   ]
}

Response Codes

Obtain MRDC Transfer

Accept or Cancel Check Deposit Request

After a check is submitted and the checkDepositStatus is either pending or in review, this endpoint forces the customer to either accept or cancel the check deposit request.

API Call Structure

PUT /programs/{programCode}/accounts/(accountIdentifier}/transfers/{transferIdentifier}/mrdc

Sample Request Body

{
   "transferAuthorizationType":"accept""OR""cancel"
}

Sample Response – Update Check (Accept)

{
   "transfer":{
      "transferIdentifier":"14a4f8e4-9b5e-4ce3-bd2b-1953f6f8ac7f",
      "transferStatus":"pending",
      "checkDeposit":{
         "checkDepositStatus":"approved",
         "checkDepositSubStatus":"fundsScheduled",
         "transactionAmount":50.00
      }
   },
   "responseDetails":[
      {
         "code":0,
         "subCode":0,
         "description":"success",
         "url":"http://tbd"
      }
   ]
}

Sample Response – Update Check (Cancel)

{
   "transfer":{
      "transferIdentifier":"7234b607-4811-420e-beba-0329ce645642",
      "transferStatus":"canceled",
      "checkDeposit":{
         "checkDepositStatus":"canceled",
         "checkDepositSubStatus":"canceledByCustomer",
         "transactionAmount":50.00
      }
   },
   "responseDetails":[
      {
         "code":0,
         "subCode":0,
         "description":"success",
         "url":"http://tbd"
      }
   ]
}

Obtain Check Images by Transfer ID

This API contains check images for a specific transfer ID.

API Call Structure

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

Request Parameters

• X-GD-RequestID (Required)
• accountIdentifier (Required)
• transferIdentifier (Required)
• programCode (Required)
• colorImage (Boolean Value)

For more information, refer to API Call Structures.

Response Body

{
  "encryptedCheckImageData": {
    "version": "string",
    "ephemeralPublicKey": "string",
    "publicKeyHash": "string",
    "data": "string"
  },
  "checkImageData": {
    "frontCheckImage": "string",
    "backCheckImage": "string"
  },
  "responseDetails": [
    {
      "code": 0,
      "subCode": 0,
      "description": "string",
      "url": "string"
    }
  ]
}

Appendices

MRDC Response Codes

• The following categories are not returned to you via the API. So, we are providing them here for your reference. However, you will receive the following descriptions via the API.
• Many of the errors listed under the “How to Test” column are not expected and seldom occur in production.
• There are a few limit errors that apply to the upper limits. If a lower limit is exceeded but an upper limit is not exceeded, then that is considered a successful request. However, the check will be placed into manual review.

Address Verification Response Codes

Adjustment Types