This endpoint allows the retrieval of a list of transfers for an account.
Note: The maximum number of transfers in a list is 180 per request.
If the GET request is successful, the following response message will be returned along with a 200 HTTP status code. Filtering ACH Transfers ACH transfers can be filtered based on the following ACH Transfer Statuses, so specific ACH transfers can be viewed by the Partner. If GET /achTransfers is called and the status provided is one or more of the valid ACH Transfer Statuses (listed above), then the response will contain the ACH transfers within the selected (or defaulted) date range that have an ACH Transfer Status that matches one of the statuses that was provided in the call.
Sample Response Body
{
"responseDetails":[
{
"code":0,
"subCode":0,
"description":"operation is successful",
"url":" http://tbd"
}
],
"totalRecordCount":1,
"transfers":[
{
"achTransferType":"achPull",
"transferIdentifier":"4b830092-e5d4-45b8-ad26-8a42c94aaa2a",
"accountIdentifier":"9b830092-e5d4-45b8-ad26-8a42c94ccc2c",
"submissionDateTime":"2019-01-03T21:02:45.260Z",
"transactionAmount":5,
"achTransferStatus":"pending",
"expectedDeliveryDate":"2020-06-24T17:07:00.028Z",
"bankAccountType":"checking",
"institutionName":"GDot Bank",
"last4BankAccountNumber":"*************9999"
}
]
}If the GET request includes an invalid scheduleDate, the following response message is returned along with a 400 HTTP status code.
{
"transfer":{
},
"responseDetails":[
{
"code":400,
"subCode":0,
"description":"Invalid ACH Schedule Date.",
"url":"http://tbd"
}
]
}Filtering ACH Transfers
ACH transfers can be filtered based on the following ACH Transfer Statuses, so specific ACH transfers can be viewed by the Partner.
Valid ACH Transfer Statuses
| achTransferStatus | Available in BaaS | ACH Out | ACH Pull | Description | Notes |
|---|---|---|---|---|---|
| Pending | Y | Y | Y | ACH Instruction is received and ready to send to the network, money has been moved off the Green Dot Account. | Money moved off the GD account for only ACHOut |
| Sent | Y | Y | Y | ACH instruction has been sent to the network. | |
| Returned | Y | Y | Y | ACH instruction was returned from RDFI. Money will be returned to the Green Dot Account. | Returned is available for both ACHPull and ACHOut |
| Failed | Y | Y | Y | ACH instruction failed. | |
| Canceled | Y | N | Y | ACH instruction was canceled prior to being sent to the network. Money has been returned to the Green Dot Account. | Cancel ACHPull is available only to GBR for now. |
| ManualReturn | Y | Y | N | ACH instruction was returned by the RDFI via a manual process—not the network. Money will be returned to the Green Dot account. | |
| Hold | N | Y | Y | ACH Instruction is held at Green Dot for review. Money has been debited from the Green Dot Account. | |
| Rejected | Y | Y | Y | ACH instruction was held and determined to be invalid. Money will be returned to the Green Dot Account. | |
| RejectedManualReview | Y | Y | Y | ACH manual return was reviewed and determined to be invalid. Money will not be returned to the Green Dot Accounts. | |
| Successful | Y | N | Y | ACH transaction transmitted successfully. | Successful is applicable to ACHPull only. |
| Paused | N | Y | Y | ACH transaction was paused. Money has moved. | |
| PendingClawback | N | Y | N | The account holder has requested clawback of an ACH instruction after it’s entered the network. Instruction has not left Green Dot. | |
| ClawbackSent | N | Y | N | The clawback instruction has been sent to the network. | |
| ClawbackCompleted | N | Y | N | The clawback instruction was completed and money has been returned to the Green Dot account. | |
| ClawbackReturned | N | Y | N | The clawback instruction was completed and returned as not executable. No money will be returned to the Green Dot Account. |
If GET /achTransfers is called and the status provided is one or more of the valid ACH Transfer Statuses (listed above), then the response will contain the ACH transfers within the selected (or defaulted) date range that have an ACH Transfer Status that matches one of the statuses that was provided in the call.
Sample Response Body Snippets
Filtered by pending
"transfers": [{
"achTransferType": "achPull",
"transferIdentifier": "4434898b-d201-4634-be23-41e77587aa95",
"accountIdentifier": "78b41a0a-88ca-4386-82dd-33f9f30f818e",
"submissionDateTime": "2020-05-14T22:26:13.773Z",
"transactionAmount": 2.2300,
"achTransferStatus": "pending",
"expectedDeliveryDate": "2020-06-24T17:07:00.028Z",
"bankAccountType": "checking",
"institutionName": "GDot Bank",
"last4BankAccountNumber": "*************9999"
}]Filtered by sent
"transfers":[
{
"achTransferType":"achPull",
"transferIdentifier":"2eb154fb-291a-4faa-aaf6-73479b055c0d",
"accountIdentifier":"d1f2c754-0802-4048-b1a0-8309b3b35202",
"submissionDateTime":"2020-05-14T03:07:54.077Z",
"transactionAmount":2.2300,
"achTransferStatus":"sent",
"expectedDeliveryDate":"2020-06-24T17:07:00.028Z",
"bankAccountType":"checking",
"institutionName":"GDot Bank",
"last4BankAccountNumber":"*************9999"
}
],Filtered by multiple statuses
"transfers":[
{
"achTransferType":"achOut",
"transferIdentifier":"08ce2c74-7cd5-4706-9414-857b60b85e81",
"accountIdentifier":"38c33ebb-a83c-4cd1-a8a4-4a420e553112",
"submissionDateTime":"2020-02-25T23:11:06.310Z",
"transactionAmount":5.0000,
"achTransferStatus":"failed"
},
{
"achTransferType":"achOut",
"transferIdentifier":"872fab86-c394-455a-ab80-7284c1b2d827",
"accountIdentifier":"e802b9be-781c-4112-8c18-3d27e9e1fc95",
"submissionDateTime":"2020-05-15T18:31:45.527Z",
"transactionAmount":5.0000,
"achTransferStatus":"pending"
}
],