Show Menu

Fetch Connected Account Status

Fetch Connected Account Status

This allows you to get the connected status of the remitter and the user or company. If they are not connected, you can use /API/v4/OTP/GetOTPAuthorizedVendor to send one time password to the user or company to connect/authorize the remitter followed by /API/v4/OTP/ValidateOTPAuthorizeVendor to validate the one time password and complete the connection/authorization.

post/API/v4/OTP/GetConnectedStatus

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

UserIDstring

String length: inclusive between 1 and 25

Response Parameters

Statusstring

OperationStatusstring

Always returned Indicates the status of the operation. Allowed parameters are:
Errors - Displays an error message if the Property name Obligation Definition/value operation was unsuccessful. For more information, see API Error Message Appendix.
Success—Indicates whether the operation was successful. Returns True if the action was successful or False if it was not successful.

Sample Request:

sandbox.xapi.xtrm.com/API/v4/OTP/GetConnectedStatus 

{
  "ValidateOTPAuthorizeVendor": {
    "request": { 
    	"IssuerAccountNumber": "SPN Account Number",
    	"RecipientUserId":"PAT Account Number",
    	"OneTimePassword":"One Time Password"
    	
    }
  }
}

Sample Response:


{
	"GetConnectedStatusResponse": {
		"GetConnectedStatusResult": {
			"Status": "Not Connected",
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}

Why

Products

Developers

How It Works

Resources

Payment and foreign exchange transactions are powered and provided by Corpay. “Corpay” is the marketing trade name for the International Payment Solutions and Risk Management Solutions provided by certain subsidiaries of FleetCor Technologies, Inc. Use of this service is governed by Corpay’s Terms and Conditions.

➤