Show Menu

Validate OTP

Validate one time password to Authenticate Remitter

This is used to validate the one time password to allow the user to transfer funds and is used in conjunction with 'Authorize Vendor'

post/API/v4/OTP/ValidateOTPAuthorizeVendor

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

RecipientUserIdstring

String length: inclusive between 1 and 25

OneTimePasswordint

Response Parameters

Messagestring

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/ValidateOTPAuthorizeVendor

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

Sample Response:


{
	"ValidateOTPAuthorizeVendorResponse": {
		"ValidateOTPAuthorizeVendorResult": {
			"Message": "Authorized",
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}