Headers
Request Headers
Standard Headers
- accept: What the response should be formatted with. We currently support the following:
- application/xml
- application/json (Default)
- Accept-Encoding: gzip, deflate
- Content-Type: application/json;charset=UTF-8
Custom Headers
- requestid: The unique request ID generated by the client for transaction tracking. It is advisable to prepend the ID with the unique partner name. This header is optional for all APIs, except for POST/Transfer.
- endusersecurityid: The agreed upon unique Security ID of the End User. This header is used for fraud prevention and is a required value.
- enduserip: The IP address of the End User. This header is used for fraud prevention and is a required value.
- partneridentifier: Identifies the sender of the request. The value will be provided by Green Dot. This header is required if it is not an admin call. If it is an admin call, this is not required (the url is /admin/xyz).
- apikey: This is an admin identifier/key. The value is “disbAdmin.” This is an optional header for non-admin calls but required for admin calls. If this header is populated, the caller needs to use an admin credentials to generate the authorization header. For all CRM calls, they can pass apikey along with the corresponding authorization header. If you are using version 1.2 and above, this is no longer used.
- x-gdc-authentication-method: Specifies the authentication method. This is used in version 1.2 and above. Values are:
- Basic – 1
- Oauth -2 (will be supported in the future)
- x-gdc-client-type: Specifies the client type. This is used in version 1.2 and above. Values are:
- External – 1 (default)
- Internal – 2
Response Headers
Standard Headers
- date: The date and time that the response was sent (in "HTTP-date" format as defined by RFC 7231 7.1.1.2)
- content-type: What the request was encoded with. Currently we support:
- application/xml
- application/json (Default)
Custom Headers
- x-version: the format of the version string is: major.minor.build.revision, where:
- build is the number of days since January 1, 2000 local time.
- revision is the number of seconds since midnight local time (without considering time zone adjustments for daylight saving time), divided by 2. (https://msdn.microsoft.com/en-us/library/system.reflection.assemblyversionattribute.assemblyversionattribute.aspx)
- requestid: The same requestid passed into the request.
Updated 9 months ago