Sign in

v1

latestOpenAPI 3.0.0ISC2026-07-249501.1 MB
Card Processing Online Application

View application by onboarding ID

Returns the application information for a specific onboardingId that is associated with the Nexio account used to authenticate.

<!-- theme: info -->

📘 Notes

  • You cannot use this endpoint in the sandbox environment.
  • For authentication with this endpoint, use your Production API user credentials.
<!-- theme: warning -->

⚠️ Try It

Due to technical limitations, it is not possible to use the Try It feature with this endpoint. Instead, for the production environment, use something like Postman or your own server (along with the credentials for your Production API user) to make the request.

<div style="display:none;">

Request parameters

  • onboardingId

Response parameters

  • merchantName
  • merchantId
  • status
  • signer
  • phoneNumber
  • agentName
  • repCode
  • agentId
  • onboardingId
  • credsReady
  • pendingItemsUpdatedAt
  • pendingNotes.dateAdded
  • pendingNotes.note
  • apiUserCredentials.apiKey
  • apiUserCredentials.userName
  • apiUserCredentials.merchantIds
  • apiUserCredentials.accountId
</div>
get/processorOnboarding/v2/applications/{onboardingId}

Response

Success

merchantNamestring

The merchant name.

merchantIdstring

The Nexio merchant ID (MID) associated with the application.

status'App Created' | 'Merchant Signed' | 'Sales Agent Signed' | 'Underwriting Signed' | 'Received' | 'Boarded' | 'Pending' | 'Live' | 'Declined' | 'Closed' | 'NULL'

Indicates the status of the application.

signerstring

Indicates the name of the signer authorized for this account.

phoneNumberstring

The phone number associated with the application.

agentNamestring

Indicates the name of the agent associated with this application.

repCodestring

Indicates the repCode associated with the application. This value matches the Rep Code displayed in the Nexio Dashboard.

agentIdinteger

Indicates the ID of the agent associated with this application.

onboardingIdstring

Indicates the ID associated with the application

credsReadyboolean

Indicates whether user credentials have been created for the merchant.

pendingItemsUpdatedAtstring

The date and time any pending items for the application were last updated, formatted as an ISO-8601 date expressed in UTC.

Example response

{
  "merchantName": "[Merchant name]",
  "merchantId": "000999",
  "status": "App Created",
  "signer": "John Doe",
  "phoneNumber": "15555555555",
  "agentName": "Agent Smith",
  "repCode": "123Z",
  "agentId": 1234,
  "onboardingId": "16c3d4c3673f3b5193e56a651df0d3e4",
  "pendingItemsUpdatedAt": "2023-04-28T18:50:04.866Z",
  "pendingNotes": [
    {
      "dateAdded": "2023-04-29T18:50:04.866Z",
      "note": "This is a pending note."
    }
  ],
  "apiUserCredentials": [
    {
      "apiKey": "apiKey_c78GnjfRBQTjxz",
      "userName": "user_bfh4673d42a24234ddf2d430234fe24e",
      "merchantIds": [
        "000999"
      ],
      "accountId": "bc2d3e21-3d12-34ac-b789-f6c5dba45941"
    }
  ]
}