Grant List API (1.1.5)

The Grant List API is used as an internal fraud and risk mitigation tool for merchants performing remittance transactions. Merchants can add account information to the Grant List database using the /account operation to let us know which account(s) to use for deposits.

Upon receiving the remittance transaction request, Payments-API checks that the account specified in the request exists in the Grant List database for that merchant. The Grant List API requires Basic Authentication.

Production Server URL: https://api.nelnetpay.com/grantlist

Download OpenAPI description

grant-list-api-spec.json

grant-list-api-spec.yaml

Servers

Mock server

https://docs.nelnetpay.com/_mock/apis/grant-list-api-spec-1/

UAT

https://api.uat.nelnetpay.com/grantlist/

Add or Remove an account from Grant List

Request

Perform a request to add or remove an account from the Grant List.

This endpoint uses a valid Basic Authentication username and password for authentication.

Security

basicAuth

Bodyapplication/jsonrequired

accountNumberstringrequired

The client’s bank account number.

Example: "12345677898"

routingNumberstringrequired

The routing number identifying the client’s bank.

Example: "051000017"

activebooleanrequired

Indicates whether the request is to add or remove an account to or from the Grant List database.

Default true

Example: true

curl -i -X POST \
  -u <username>:<password> \
  https://docs.nelnetpay.com/_mock/apis/grant-list-api-spec-1/account \
  -H 'Content-Type: application/json' \
  -d '{
    "accountNumber": "12345677898",
    "routingNumber": "051000017",
    "active": true
  }'

Responses

Bodyapplication/json

resultobject

Response

application/json

{
  "result": {
    "status": "success"
  }
}