| |
SOAPGetTransactionStatus
Go back to the Buxter API here.
This operation retrieves the current status of a given transaction. It it usually called after the buyer returned to the originating site from his purchase to determine whether or not the payment was successfully completed.
| Operation Type |
Request-response. The endpoint receives a message, and sends a correlated message. |
| SOAP Action |
http://buxter.com/api/1.0/TransactionStatus |
| Input |
GetTransactionStatusRequest (soap:body, use = literal)
A type containing all information about a financial transaction in the Buxter system.
| request type |
GetTransactionStatus_Request |
|
| Parameters |
|
|
|
apiConfigurationID
|
type long
|
A long representing an unique identifier of an application in the Buxter system
|
|
requesterSignature
|
type Signature
|
string with maxLength(255)
A string representing a signature of the requester, calculated with the shared secret key.
|
|
transactionID
|
type long |
A long representing an unique identifier of the transaction in the Buxter system as returned in the CreateTransaction_Response
|
| externalID |
type ExternalID |
string with restriction maxLength(255)
A string representing an identifier of the transaction in an external system (e.g. in the seller's database), which must be unique for the given apiConfigurationID.
Please note that externalIDs that are used twice will not be accepted.
|
|
| Output |
GetTransactionStatusResponse (soap:body, use = literal)
| response type |
GetTransactionStatus_Response;
extension of type TransactionInfo
|
|
| Parameters |
|
|
| transactionID |
type long |
A unique identifier of the transaction in the Buxter system as returned in the CreateTransaction_Response |
| transactionStatus |
type TransactionStatus |
string with restriction - enum { 'CREATED', 'PENDING_CONFIRMATION', 'PENDING_PAYMENT', 'SUCCESS', 'DECLINED', 'ABORTED', 'CANCELLED', 'EXPIRED', 'CHARGEDBACK', 'BOOKED_OUT', 'BOOKED_IN', 'INSUFFICIENT_FUNDS' }
A string representing current status of the transaction e.g. CREATED or CANCELLED
|
| externalID |
type ExternalID |
string with restriction maxLength(255)
A string representing an identifier of the transaction in an external system (e.g. in the seller's database) as specified by the requester in the transaction request
|
| redirectURL |
optional; type anyURI |
A string representing an URI where a buyer will be redirected after a successful transaction |
|
| Fault |
ErrorResponse (soap:fault)
| exception type |
Error_Response
|
type containing informations returned in case of an error |
| Parameters |
|
|
| name |
type ErrorName |
A string with restriction - enum { 'MalformedRequest', 'InvalidRequest', 'AuthenticationFailed', 'TechnicalError' }
An enumeration representing the error name
|
| detail |
type ErrorDetail |
A string with restriction - enum { 'MalformedRequest', 'EmptyRequest', 'UnknownRequest', 'InvalidRequest', 'InvalidAPIConfigurationID', 'APIConfigurationNotActive', 'APIConfigurationLocked', 'DuplicateExternalID', 'LimitsExceeded', 'TransactionNotFound', 'TransactionNotCancellable', 'AuthenticationFailed', 'InvalidSignature', 'TechnicalError' }
A string representing a more detailed description of the error Please note that the content of the description field is meant for human interpretation, it's contents may change at any time for a given error scenario.
|
|
SOAPGetTransactionStatus
|
|
Tip: To turn text into a link, highlight the text, then click on a page or file from the list above.
|
|
|
Comments (0)
You don't have permission to comment on this page.