1. Resources
Qorpy
  • Getting Started: Qorpy API and NRS E-Invoice
  • Frequently Asked Questions
  • Qorpy API Onboarding
    • Request Business Key
      POST
    • Regenerate Business Key
      POST
    • Business Settings - Update
      POST
    • Business Settings - Read
      GET
  • E-Invoicing Lifecycle
    • E-Invoice Creation
      • Create Invoice
      • Get Invoice QR Code
      • Update Invoice Payment Status
      • Get Sent Invoices
      • Get Sent Invoice Details
    • E-Invoice Reversal
      • Invoice Reversal
    • E-Invoice Receipt
      • Fetch Received Invoices
  • Resources
    • Get NRS Invoice Quantity Codes
      GET
    • Get NRS Currencies
      GET
    • Get NRS States
      GET
    • Get NRS LGAs
      GET
    • Get NRS Countries
      GET
    • Get NRS Invoice Types
      GET
    • Get NRS Payment Means
      GET
    • Get NRS Product Codes
      GET
    • Get NRS Service Codes
      GET
    • Get NRS Tax Categories
      GET
  1. Resources

Get NRS States

GET
/{stage}/external/{businessId}/resources/states
Retrieve available currencies for a specific business.

Quick Reference#

MethodEndpointAuthentication Required
GET{{baseUrl}}/{{stage}}/external/businesses/:businessId/resources/statesYes

Request Structure#

Path Parameters#

ParameterTypeRequiredDescriptionExample
businessIdstring✅Unique identifier of the business26ede24b-ac50-475f-aacc-5ea6339f0863

Headers#

HeaderValueRequired
Content-Typeapplication/json or */*Yes
Acceptapplication/json or */*Yes
X-Business-KeybusinessKeyYes

Response Format#

Success Response (200)#

{
  "responseCode": "00",
  "responseMessage": "State resources retrieved successfully",
  "data": [
    {
      "name": "Lagos",
      "code": "LA"
    },
    {
      "name": "Ogun",
      "code": "OG"
    },
    {
      "name": "Oyo",
      "code": "OY"
    },
    {
      "name": "Rivers",
      "code": "RI"
    }
  ]
}

Response Data Structure#

Currency Object#

FieldTypeDescription
codestringISO currency code (e.g., NGN, USD)
decimalDigitsnumberNumber of decimal places for the currency
namestringFull currency name
namePluralstringPlural form of currency name
roundingnumberRounding increment (0 = no rounding)
symbolstringCurrency symbol
symbolNativestringNative currency symbol representation

Error Responses#

Error CodeMessageDescription
404Business not foundBusiness ID doesn't exist
403Access deniedUser doesn't have permission
400Invalid business IDBusiness ID format is invalid

Example Error Response#

{
  "responseCode": "404",
  "responseMessage": "Business not found with ID: invalid-business-id",
  "data": null
}

Related Endpoints#

POST /invoices - Create invoice (uses currency data)
GET /businesses/{businessId}/settings - Get business configuration

This endpoint provides currency information for businesses to use in invoices and financial documents.

Request

Path Params

Header Params

Responses

🟢200OK
text/plain
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '/{{stage}}/external/{{businessId}}/resources/states' \
--header 'X-Business-Key: BK-26EDE24BAC50475FAACC5EA6339F0863-DEV-B2Z6QCEHI3X9' \
--header 'Accept: */*'
Response Response Example
{
    "responseCode": "00",
    "responseMessage": "Completed successfully",
    "data": [
        {
            "name": "Abia",
            "code": "NG-AB"
        },
        {
            "name": "Adamawa",
            "code": "NG-AD"
        },
        {
            "name": "Akwa Ibom",
            "code": "NG-AK"
        },
        {
            "name": "Anambra",
            "code": "NG-AN"
        },
        {
            "name": "Bauchi",
            "code": "NG-BA"
        },
        {
            "name": "Benue",
            "code": "NG-BE"
        },
        {
            "name": "Borno",
            "code": "NG-BO"
        },
        {
            "name": "Bayelsa",
            "code": "NG-BY"
        },
        {
            "name": "Cross River",
            "code": "NG-CR"
        },
        {
            "name": "Delta",
            "code": "NG-DE"
        },
        {
            "name": "Ebonyi",
            "code": "NG-EB"
        },
        {
            "name": "Edo",
            "code": "NG-ED"
        },
        {
            "name": "Ekiti",
            "code": "NG-EK"
        },
        {
            "name": "Enugu",
            "code": "NG-EN"
        },
        {
            "name": "Abuja Federal Capital Territory",
            "code": "NG-FC"
        },
        {
            "name": "Gombe",
            "code": "NG-GO"
        },
        {
            "name": "Imo",
            "code": "NG-IM"
        },
        {
            "name": "Jigawa",
            "code": "NG-JI"
        },
        {
            "name": "Kaduna",
            "code": "NG-KD"
        },
        {
            "name": "Kebbi",
            "code": "NG-KE"
        },
        {
            "name": "Kano",
            "code": "NG-KN"
        },
        {
            "name": "Kogi",
            "code": "NG-KO"
        },
        {
            "name": "Katsina",
            "code": "NG-KT"
        },
        {
            "name": "Kwara",
            "code": "NG-KW"
        },
        {
            "name": "Lagos",
            "code": "NG-LA"
        },
        {
            "name": "Nasarawa",
            "code": "NG-NA"
        },
        {
            "name": "Niger",
            "code": "NG-NI"
        },
        {
            "name": "Ogun",
            "code": "NG-OG"
        },
        {
            "name": "Ondo",
            "code": "NG-ON"
        },
        {
            "name": "Osun",
            "code": "NG-OS"
        },
        {
            "name": "Oyo",
            "code": "NG-OY"
        },
        {
            "name": "Plateau",
            "code": "NG-PL"
        },
        {
            "name": "Rivers",
            "code": "NG-RI"
        },
        {
            "name": "Sokoto",
            "code": "NG-SO"
        },
        {
            "name": "Taraba",
            "code": "NG-TA"
        },
        {
            "name": "Yobe",
            "code": "NG-YO"
        },
        {
            "name": "Zamfara",
            "code": "NG-ZA"
        }
    ]
}
Modified at 2026-08-21 09:13:33
Previous
Get NRS Currencies
Next
Get NRS LGAs
Built with