Docs
DocumentationAPI ReferenceAsk AI Assistant
  • Home
    • Get Your Business Started
    • Services and Supported Features
  • Documentation
    • Developer Quickstart
      • Authentication
      • Card Sales and Consent
      • Querying and Filtering
      • Payment Reminders
    • Getting Started
      • Integration Checklist
      • Integration Options
        • REST API
        • Android SDK
        • iOS SDK
        • React Native Wrapper
        • PayForm
        • Verifone
        • Virtual Terminal
      • Basics
        • Authentication
        • API Best Practices
        • API Input Validation
        • Testing Considerations
      • Client Admin Portal
    • Testing
      • Testing Overview
      • Global Payments Testing
      • First Data Testing
      • ACH Testing
    • Resources
      • Tools and Downloads
      • Vocabulary
      • Querying
      • Error Codes
      • Software Requirements
  • API Reference
    • REST API
      • Authentication
      • ACH
      • Card Operations
        • Process a Card Sale
      • Consent Annual
        • Create Annual Consent
      • Consent Recurring
        • Create Recurring Consent
      • Consent Subscription
      • International
      • PayForm
      • Query
        • Account
        • ACH
        • Batch
        • Consent Annual
        • Consent Recurring
        • Consent General
        • Recurring Schedule
        • Receipt
        • Transaction
        • Voice
        • Query General
        • Reconcile
      • Receipt
      • Recurring Schedule
      • Settlement
      • Text to Pay
  • Help
    • Customer Support
      • FAQ
Powered by GitBook

Copyright © Number

On this page

Was this helpful?

Export as PDF
  1. API Reference
  2. REST API

Authentication

PreviousREST APINextACH

Last updated 4 months ago

Was this helpful?

Authenticate user and retrieve session key

post
Header parameters
Content-TypestringRequiredExample: application/json
AcceptstringRequiredExample: application/json
Body
AcctCodestringOptional

Account code that never changes

Example: EP911XXXX
TokenstringOptional

Token that expires every 2 years

Example: 2148B239CF6846BDA5D141BF4A4CFBE8
Responses
200
Successful authentication and session key retrieval
application/json
post
POST /APIcardProcREST/v1.0.0/Authenticate HTTP/1.1
Host: easypay5.com
Content-Type: application/json
Accept: application/json
Content-Length: 67

{
  "AcctCode": "EP911XXXX",
  "Token": "2148B239CF6846BDA5D141BF4A4CFBE8"
}
200

Successful authentication and session key retrieval

{
  "AuthenticateResult": {
    "AuthSuccess": true,
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "MerchantList": [
      {
        "Address": "45 spring street portland Maine 04101",
        "Descrip": "Test Merchant 1",
        "ID": 1,
        "Location": "Test Merchant 1",
        "TermID": "006"
      }
    ],
    "RespMsg": "SessKey Expires|4/18/2019 7:29:47 AM",
    "SessKey": "B9F24903C3BA4770AE303032303541303032353437",
    "ThisUser": {
      "APILocationID": 2210,
      "AccountCode": "EP9116875",
      "AcctID": 205,
      "Alias": "vidya_Venkatraman",
      "CreatedBy": "ADMIN : vidya Venkatraman",
      "DateCreated": "2024-12-01 11:19:01",
      "DateModified": "2024-12-01 11:19:01",
      "Description": "EP DEV ACCT",
      "ExpirationDate": "2024-12-01 11:19:01",
      "ID": 2547,
      "IsExpired": false,
      "IsLockedOut": false,
      "TokenDescription": "EP DEV ACCT"
    }
  }
}