Get Transaction Results

URL: /api/v1/tx/authstatus?merchantId={merchantId}&txId={txId}&merchantTxId={merchantTxId}

METHOD: GET

DIRECTION: Integrator -> PM Gateway

Request

Parameter Name Type Mandatory Description
merchantId ASCII Yes Merchant Id in Elavon
txId ASCII No Transaction ID, provided by PM Gateway. Should be always provided if known. Request is considered valid of at least one of txId or merchantTxId is provided. If both are provided txId will be used for locating the transaction.
merchantTxId ASCII No Should be used in very rare cases, when client could not process Authorization response and txId is not known. It is client responsibility to ensure uniqueness of merchantTxId. If txId is not provided, PM Gateway will try to locate the transaction in context of provided merchantId. If more than one transactions are found with the same id, Error will be returned.

http://{root domain }/api/1/tx/authstatus?merchantId=1234m&txId=92ec1400-5965-4196-9a87-604433365e33&merchantTxId=b49c8898-f8c8-435a-828e-f87f5e

 

Response

Parameter Name Type Mandatory Description
txId ASCII Yes Transaction ID in PM Gateway. Always populated. Null in case error=ERR_TX_NOT_FOUND
merchantTxId ASCII Yes Merchant transaction ID. Null in case error=ERR_TX_NOT_FOUND
shortTxId ASCII Yes Short transaction ID. Numeric only. Min length 8 digits, Max 9 digits
status ASCII Yes

Status of Authorization request. One of :

  • PENDING - transaction is being processed
  • DECLINED - transaction failed
  • SUCCEEDED- transaction is successful

Null in case error=ERR_TX_NOT_FOUND
fundState ASCII Yes

Indicates the funds state, whether they are secured or not. Mandatory in case of status is set to SUCCEEDED. Possible values:

  • FUNDS_RECEIVED - funds are secured
  • FUNDS_MISSING - funds are not secured.
error ASCII Yes Error code. Refer to possible error codes for more info.
errorMessage UTF-8 No Human readable message, up to 200 characters. Set in case of error code <> ERR_OK
payload JSON No Key - value json structure. Used to set payment type specific parameters.

 

Example Response:

	{
		"txId": "92ec1400-5965-4196-9a87-604433365e33",
		"merchantTxId": "b49c8898-f8c8-435a-828e-f87f5e",
		18
		"shortTxId":"12345678",
		"status": "SUCCEEDED",
		"error": "ERR_OK",
		"payload": {
			"customParam1": "customValue1",
			"customParam2": "customValue2"
		}
	}

Error Codes

All error codes from Authorization Response are valid, in addition the following error codes:

Error Code Description
ERR_TX_NOT_FOUND Requested transaction is not found in PM Database, or more than one transaction is found with the same merchantTxId.

HTTP Error Codes

Error Code is always 200. All other error codes should be considered as System errors. Refer to the table above for error codes, encoded as part of the response body.