Skip to content
APIs
/
Payments
/
Payments API
/
Process a Payment Request

Payments API v3 (1.0.4)

The Payments API is used to send payment requests to process transactions.

Download OpenAPI description
osi-payments-api.json
osi-payments-api.yaml
Languages
Servers
Mock server

https://docs.nelnetpay.com/_mock/apis/osi-payments-api/

UAT

https://api.uat.nelnetpay.com/payments-api/

Process a Payment Request

Request

Perform a request to process a payment.

This endpoint uses a valid Bearer Authentication API Key ID and HMAC Key for authentication.

Security
bearerAuth
Headers
nps-trace-uuidstringrequired
Bodyapplication/jsonrequired
entityIdinteger(int64)required

A unique ID assigned by NPS that represents the client.

Example: 1325691045
paymentTypeobjectrequired

Indicates the type of payment. Only one type of payment is allowed.

paymentType.​achobject

Used to identify the ACH payment type.

paymentType.​creditCardobject

Used to identify the credit card payment type.

paymentType.​applePayobject

Used to identify the Apple Pay payment type. Either encryptedData or token needs to be provided.

transactionTypestringrequired

Indicates the type of transaction.

Enum"AUTH_ONLY""CAPTURE""SALE""REFUND""VERIFY""VOID""CANCEL""ACH_DEBIT""ACH_CREDIT""ACH_CANCEL"
Example: "AUTH_ONLY"
amountnumber

Amount of the transaction in BigDecimal.

Example: 123.65
accountHolderobject

Account holder details.

transactionInformationobject

Additional information about the transaction.

payfacobject

Information about the payment facilitator. Contact NPS Client Services before sending information in this field.

credentialsOnFileobject

Information for stored card transactions. Required to be sent only for recurring transactions.

additionalAmountArray of objects

Additional amount that is added to the amount of the cardholder's original transaction.

riskIdstring

A unique ID returned by the Risk Service.

Example: "12e3cdac-d347-4564-ba1f-305e5e1e8ded"
processingModestring

Mandatory for ACH transactions.

For transactions where the merchant sets the processingMode field value to SYNCHRONOUS, we will process these transactions in real-time using existing flows.

For transactions where the merchant sets the processingMode field value to ASYNCHRONOUS, we will process these transactions asynchronously.

We will queue the transaction for processing later.

Format Type: String

Enum"SYNCHRONOUS""ASYNCHRONOUS"
Example: "SYNCHRONOUS"
accountAndRoutingRequestboolean
curl -i -X POST \
  https://docs.nelnetpay.com/_mock/apis/osi-payments-api/payments \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'nps-trace-uuid: string' \
  -d '{
    "entityId": 1325691045,
    "paymentType": {
      "ach": {
        "bankAccount": {
          "accountNumber": "459887746321Z",
          "routingNumber": "021000021",
          "accountType": "CHECKING"
        }
      }
    },
    "transactionType": "ACH_DEBIT",
    "amount": 123.65,
    "accountHolder": {
      "accountHolderName": "John Smith",
      "accountHolderId": "134267"
    },
    "transactionInformation": {
      "customId": "330d4c38-7904-47cf-be8e-0972a93f7386",
      "description": "tuition",
      "additionalPaymentInformation": "U00102",
      "companyName": "College Prep",
      "companyDiscretionaryData": "Test1234",
      "standardEntryCode": "WEB",
      "terminalCity": "MPLS",
      "terminalState": "MN",
      "discretionaryData": "R",
      "effectiveEntryDate": "250110",
      "originalTransactionType": "",
      "originalPaymentTransactionId": "80503dc9-15f8-430a-8622-3cff38124bbd"
    },
    "riskId": "12e3cdac-d347-4564-ba1f-305e5e1e8ded"
  }'

Responses

OK

Bodyapplication/json
responseCodestring[ 4 .. 5 ] characters

Response code defined by NPS indicating status of request.

Format Type: Alphanumeric

Length: 4 to 5

Example: "A100"
responseMessagestring

The text description of the response code.

Example: "Approved"
paymentTransactionIdstring[ 1 .. 36 ] characters

Unique transaction identifier. This value is used when sending a subsequent transaction such as a Capture or Refund.

Format Type: UUID

Length: 36

Example: "80503dc9-15f8-430a-8622-3cff38124bbd"
paymentTypeobject

Indicates the type of payment.

accountValidationResultobject

The ACH account validation return code, which indicates if ACH validation was performed.

processorResponseobject

Response returned by processor.

riskResponseobject

Response returned by the Risk Service if the service was invoked during processing the payment.

Response
application/json

ACH Response

{
  "responseCode": "A100",
  "responseMessage": "Approved",
  "paymentTransactionId": "80503dc9-15f8-430a-8622-3cff38124bbd",
  "paymentType": {
    "ach": { … }
  },
  "riskResponse": {
    "responseCode": "0",
    "riskId": "12e3cdac-d347-4564-ba1f-305e5e1e8ded",
    "data": { … }
  },
  "accountValidationResult": {
    "responseCode": "1",
    "thirdPartyResponseCode": "2",
    "bankName": "UB Bank"
  }
}