GetEStatementFiles API Method

This operation is used to get EStatement PDF file by account.

📘
Every request triggered should have a unique X-GD-RequestId value in the header.

Syntax

POST {baseUrl}/estatement/getfiles

Example Request

Success Request

POST {baseUrl}/estatement/getfiles
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: 66219996371691

{
    "statementPeriods": [
        {
            "period": "202408"
        },
        {
            "period": "202407"
        },
        {
            "period": "202406"
        },
        {
            "period": "202405"
        },
        {
            "period": "202404"
        }
    ],
    "accountNumber": "",
    "accountIdentifier": "688A0885-67B0-4D01-8119-C1AA149C31C4",
    "metadata": {
        "storeId": "abc123",
        "merchantId": "FSCC0342",
        "userId": "TELLERIDWRUAQNIT",
        "requestDateTime": "2024-08-27T10:30:53",
        "registerId": ""
    }
}

Negative Request

POST {baseUrl}/estatement/getfiles
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: 66219996371691

{
	"accountNumber": "",
"accountIdentifier": "688A0885-67B0-4D01-8119-C1AA149C31C4",
"statementPeriods":[],
"metadata": 
{
    		"storeId": "abc123",
    		"merchantId": "FSCC0342",
        	"userId": "TELLERIDWRUAQNIT",
        	"requestDateTime": "2024-08-27T10:30:53",
        	"registerId": ""
  	}
}

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.
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.
registerId	No	String		Register where the transaction occurred.
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.
statementPeriods	Yes	Array		The StatementPeriods in charge of pass multiple period to call core api to get estatement pdf file.（duplicate period only return one file.）
period		String	202407	The period of selected billing cycle.

Example Response

Success Response

HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: 66219996371691
X-GD-ResponseId: 0648d859-f7e3-4d51-a164-af4d2614dc90
X-GD-ResponseCode: 0
{
"metadata": {
"requestId": "66219996371691",
"responseId": "0648d859-f7e3-4d51-a164-af4d2614dc90",
"responseDateTime": "2024-08-27T10:30:56.884207Z",
"responseCode": 0,
"responseDescription": "Success"
},
"statementFiles"[{
          "period": "202408"，
          "file": "JVBERi0xLjcKJe......NTU3NgolJUVPRgo"
          
},
{
          "period": "202407"，
    "file": "JVBERi0xLjcKJe......E4CiUlRU9GCg=="
          
}, 
{
          "period": "202406"，
          "file": "JVBERi0xLjcKJe......NTU3NgolJUVPRgo"
          
}, 
{
          "period": "202405"，
          "file": "JVBERi0xLjcKJe......NTU3NgolJUVPRgo"
          
},
{
          "period": "202404"，
          "file": "JVBERi0xLjcKJe......NTU3NgolJUVPRgo"
          
}

]
}

Negative Response

HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: 66219996371691
X-GD-ResponseId: 160d9d1b-c528-425c-ad09-01ade5fb5fa9
X-GD-ResponseCode: 800
{
	"metadata": {
		"requestId": "66219996371691",
		"responseId": "160d9d1b-c528-425c-ad09-01ade5fb5fa9",
		"responseDateTime": "2024-08-27T10:30:56.884207Z",
		"responseCode": 800,
		"responseDescription": "Store was not found"
	}
}

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-098-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.
statementFiles	Yes	Array		Return statement files by account request.
period	Yes	String	202407	The period of selected billing cycle.
file		String		The pdf file content encode using Base64, need decode using Base64 before download.

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 • StatementPeriods can not be empty. • The number of StatementPeriods can not over 5. • Either AccountNumber or AccountIdentifier is required	Invalid parameter in the request. Examples: MerchantID not supplied, StoreID not supplied.
110	InvalidAccountNumber	• InvalidAccountNumber • Account Not Found	Account is not found
130	InvalidMerchant	InvalidMerchant	MerchantId in request has not been found/enabled in the system.
600	UnableToProcessRequest	• Invalid Statement Period • The StatementPeriod field is required • Invalid AccountIdentifier	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.