Get EStatement List
GetEStatementList API Method
This operation is used to get EStatements by account.
Every request triggered should have a unique X-GD-RequestId value in the header.
Syntax
POST {baseUrl}/estatement/getlist
Example Request
Success Request
POST {baseUrl}/estatement/getlist
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: 33f45e99-92d2-410d-a8d4-37bf54e2cda2
{
"accountNumber": "",
"accountIdentifier": "8E221059-A193-43AD-8BD7-879112A732FC",
"metadata": {
"storeId": "abc123",
"merchantId": "FSCC0342",
"userId": "TELLERIDWRUAQNIT",
"requestDateTime": "2024-08-27T10:23:00",
"registerId": "optional"
}
}
Negative Request
POST {baseUrl}/estatement/getlist
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: 33f45e99-92d2-410d-a8d4-37bf54e2cda2
{
"accountNumber": "",
"accountIdentifier": "8E221059-A193-43AD-8BD7-879112A732FC"
"metadata": {
"storeId": "abc123",
"merchantId": "FSCC0342",
"userId": "TELLERIDWRUAQNIT",
"requestDateTime": "2024-08-27T10:23:00",
"registerId": "optional"
}
}
Request Parameters
| Parameter | Required (Y/N) | Format/ Data Type | Pattern | Description |
|---|---|---|---|---|
| X-GD-RequestId | Yes | String | MaxLength:50 | It is a unique transaction identifier that is generated by the retailer. |
| requestDateTime | Yes | DateTime | 2024-08-13T12:34:56Z | Time stamp at which transaction occurred. The time stamp has to be in UTC time zone and follow the following date and time formats: • YYYY-MM-DDTHH:mm:ssZ |
| userId | Yes | String | MaxLength:50 | The unique ID of the user generating the transaction. |
| registerId | No | String | Register where the transaction occurred. | |
| storeId | Yes | String | MaxLength: 20 | The store number associated with the offline store of retailer. If not supplied, InvalidParameter (Code:100) error will be return. |
| merchantId | Yes | String | MaxLength: 20 | Unique merchant Id. It is defined by Green Dot – Merchant corresponding with Retailer. |
| accountNumber | No | String | 16 digits PAN | Account Number (PAN) of the card. Note: Either AccountNumber or AccountIdentifier is required |
| accountIdentifier | No | GUID | e5843e05-d367-4bf1-a223-3af46ae18802 | Newly created unique identifier in sale card, should be using for all subsequent API calls. Either of AccountNumber / AccountIdentifier required. |
Example Response
Success Response
HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: 33f45e99-92d2-410d-a8d4-37bf54e2cda2
X-GD-ResponseId: 1d7e2ff2-4a0b-4610-bd38-c29b5a332922
X-GD-ResponseCode: 0
{
"statements": [
{
"statementPeriod": "202407",
"statementPeriodStartDate": "2024-06-28",
"statementPeriodEndDate": "2024-07-27"
},
{
"statementPeriod": "202406",
"statementPeriodStartDate": "2024-05-28",
"statementPeriodEndDate": "2024-06-27"
},
{
"statementPeriod": "202405",
"statementPeriodStartDate": "2024-04-28",
"statementPeriodEndDate": "2024-05-27"
},
{
"statementPeriod": "202404",
"statementPeriodStartDate": "2024-03-28",
"statementPeriodEndDate": "2024-04-27"
},
{
"statementPeriod": "202403",
"statementPeriodStartDate": "2024-02-28",
"statementPeriodEndDate": "2024-03-27"
}
],
"accountIdentifier": "8e221059-a193-43ad-8bd7-879112a732fc",
"metadata": {
"requestId": "33f45e99-92d2-410d-a8d4-37bf54e2cda2",
"responseId": "1d7e2ff2-4a0b-4610-bd38-c29b5a332922",
"responseDateTime": "2024-08-27T10:23:04.6016504Z",
"responseCode": 0,
"responseDescription": "Success"
}
}
Negative Response
HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: 33f45e99-92d2-410d-a8d4-37bf54e2cda2
X-GD-ResponseId: 160d9d1b-c528-425c-ad09-01ade5fb5fa9
X-GD-ResponseCode: 800
{
"metadata": {
"requestId": "33f45e99-92d2-410d-a8d4-37bf54e2cda2",
"responseId": "160d9d1b-c528-425c-ad09-01ade5fb5fa9",
"responseDateTime": "2024-08-27T10:23:04.6016504Z",
"responseCode": 800,
"responseDescription": "Store was not found"
},
"accountIdentifier": "8E221059-A193-43AD-8BD7-879112A732FC"
}
Response Parameters
| Parameter | Required(Y/N) | Format/Data Type | Pattern | Description |
|---|---|---|---|---|
| requestId | Yes | String | MaxLength:50 | The unique request ID from request. |
| responseId | Yes | String | MaxLength:50 | The unique Response Identifier (generated by GreenDot). |
| responseDateTime | Yes | DateTime | 2024-08-13T16:12:23.4541445+08:00 | Time stamp at which transaction occurred. The time stamp is in UTC time zone and follow the following date and time formats: • YYYY-MM-DDTHH:mm:ssfffffffK |
| responseCode | Yes | Numeric | MaxLength:4 | Indicates success and failure of the response codes. It is in the numeric format. |
| responseDescription | Yes | String | MaxLength:255 | Describes the Response Code in more detail. It is in the String format. |
| Statements | Yes | Array | Return statement period by account request,The maximum of list is 24. | |
| statementPeriod | String | 202407 | Describe the period of current statement. | |
| statementPeriodStartDate | String | 2024-06-27 | Describle the start date of current statement period. | |
| statementPeriodEndDate | String | 2024-07-26 | Describle the end date of current statement period. | |
| accountIdentifier | No | GUID | e5843e05-d367-4bf1-a223-3af46ae18802 | Return from the response, just confirm the accountid is consistency with request. |
Response Cases
| Code | CodeText | ResponseDescription | Description |
|---|---|---|---|
| 0 | Success | Success | |
| 100 | InvalidParameter | • RequestId is too long • Invalid length of AccountNumber • UserId is too long • StoreId is too long • MerchantId is too long • RequestId is required • RequestDateTime is required • UserId is required • StoreId is required • MerchantId is required | Invalid parameter in the request. Examples: MerchantID not supplied, StoreID not supplied, not a PLS account. |
| 110 | InvalidAccountNumber | • Account Not Found. • InvalidAccountNumber | Not a PLS account; Account does not exist in GreenDot. |
| 130 | InvalidMerchant | InvalidMerchant | MerchantId in request has not been found/enabled in the system. |
| 600 | UnableToProcessRequest | Unable to process request due to downstream errors. | |
| 800 | InvalidStore | Store was not found | Store is not found; store is not for the partner or store does not support this operation. |
| 861 | RetailChainUserNotFound | User is not found | UserID in request is not found in system. |
| 862 | RetailChainUserNotActive | User is not active | UserId in request is not active. |
| 1000 | GeneralFailure | GeneralFailure | Service failure. |
Updated 12 days ago