Point of Banking Payment
This offering is not yet live, and contract(s) may change. However, you can read below to get a sneak-peak before full release!
Point of Banking Payment
This method is used to deposit cash to any valid US debit card.
Every request triggered should have a unique X-GD-RequestId value in the header
Syntax
POST {baseUrl}/pointofbanking/payment
Example Request
Success Request
POST {baseUrl}/pointofbanking/payment
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: 123456789
{
"metadata": {
"merchantId": "FSCC0342",
"registerId": "01001",
"requestDateTime": "2013-09-18T10:53:00Z",
"storeId": "CC970",
"userId": "[email protected]"
},
"accountNumber": "1234567890123456",
"paymentProgramType": "Regular",
"transactionAmount": 50.00,
"customerFirstName": "First",
"customerLastName": "Last",
"customerZipcode": "112345",
"cardExpirationDate": "2835",
}
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 | 2023-08-08T12: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 |
| registerId | No | String | MaxLength: 20 | Register where the transaction occurred. |
| userId | No | String | MaxLength:50 | The unique ID of the user generating the transaction. UserID is now a required field to support ‘teller incentive program’. |
| storeId | Yes | String | MaxLength: 20 | The store number associated with the retailer that sold the package. If not supplied, InvalidParameter (Code:100) error will be return. |
| merchantId | Yes | String | MaxLength: 20 | The unique merchant Id. 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. Retail Partners must provide AccountNumber |
| transactionAmount | Yes | Decimal | 500.00 | Amount of money to be reloaded. Must be greater than zero. For example: Five Hundred Dollars is entered as 500.00. Twenty Dollars is entered as 20.00. |
| paymentProgramType | Yes | Enum | Regular, CheckCashing | Type of payment option that customer selects. For example: • If the customer is paying with a check, then it will be “CheckCashing”. • If they are paying by cash, or a combination of check and cash, PaymentProgramType will be “Regular”. |
| customerFirstName | Yes | String | Max: 25 | This is the customer’s first name. |
| customerLastName | Yes | String | Max: 25 | This is the customer’s last name. |
| customerZipcode | Yes | String | Max: 5 | This is the customer’s zipcode. |
| cardExpirationDate | Yes | String | “YYMM” format | This is the card expiration date. |
Example Response
Success Response
HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: 201309181254
X-GD-ResponseId: 873e01e2-76fe-4fd1-8b18-2ccf5f2d5af9
X-GD-ResponseCode: 1
{
"metadata": {
"requestId": "201309181254",
"responseCode": 1,
"responseDescription": "SuccessFundingDelay",
"responseDateTime": "2013-09-18T10:53:10.2543261Z",
"responseId": "873e01e2-76fe-4fd1-8b18-2ccf5f2d5af9"
},
"externalReferenceID":"12d1453e1321",
"receiptText":"Keep your receipt as proof of your reload. Check with your card provider for your updated account balance. Stores cannot provide refunds or exchanges."
}
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 | 2023-09-07T16: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. |
| externalReferenceID | Yes | String | Max: 50 | The ExternalReferenceID for the Point of Banking Payment. |
| receiptText | No | String | Max 1000 | Describes the receipt text. |
Response Codes
| Code | CodeText | Response Description | Explanation |
|---|---|---|---|
| 0 | Success | Success | Success with Point of Banking Payment. |
| 100 | InvalidParameter | • Either AccountNumber or AccountIdentifier is required • MerchantId is required • RequestId is required • RequestDateTime is required • UserId is required • StoreId is required • RequestId is too long • UserId is too long • StoreId is too long • MerchantId is too long • Invalid length of AccountNumber • The field RegisterId must be a string or array type with a maximum length of '20'. | Invalid parameter when validating request. |
| 130 | InvalidMerchant | InvalidMerchant | MerchantId in request has not been found/enabled in the system. |
| 800 | InvalidStore | • Store was not found • Store feature is invalid | Store is not found; store is not for the partner or store does not support this operation. |
| 801 | StoreBlocked | The store is blocked | Store is blocked by store blocker rule. |
| 700 | LoadLimitValidationFailed | • Load amount should be between XX and XXX • The transfer would cause the account's maximum allowed balance to be exceeded. • Exceeds account daily load limit | Per transaction, account balance or daily account reload limit reached |
| 110 | InvalidAccountNumber | • AccountNotFound • Account Not Found. • AccountStatus is Closed. • AccountStatus is Pending. • AccountStatus is Locked. • Account Status is Restricted • This account is in a restricted state that does not allow inbound or internal transfers. | Account is not found; account status is not valid, or account is not reloadable for current partner |
| 600 | UnableToProcessRequest | Duplicate transaction detected. | Unable to process request due to duplicate transaction and downstream error. The duplicate reload request is a request with same partner, retail chain, store, user, card number and amount within 3 minutes. |
| 842 | TransactionAlreadyVoided | Transaction was already voided | Void request has been received before reload. Decline reload request and mark transaction as voided. |
| 1000 | GeneralFailure | Success with Point of Banking Payment. | Service failure. |
Updated 2 months ago