Request specification
| Field
|
Required
|
Type
|
Description
|
| target
|
Y
|
string, 128
|
Must equal payment
|
| action
|
Y
|
string, 128
|
Must equal get_info
|
| txnId
|
Y
|
string, 32
|
Unique payment ID
|
| refresh
|
N
|
0 or 1
|
A flag specifying that the data in X-Payments must be overwritten by the data from the payment gateway. By default - 0
|
| api_version
|
Y
|
string
|
Must equal one of the following: 1.2, 1.3, 1.4, 1.5 etc.
|
Request example
<txnId>e7f398cee98ec062abac0d2c937da181</txnId>
<refresh>0</target>
<target>payment</target>
<action>get_info</action>
Response specification
| Field
|
Type
|
Description
|
| status
|
integer, 1
|
Payment status code
|
| message
|
string, 65536
|
Human readable message containing the payment status
|
| isFraudStatus
|
0 or 1
|
Means that the payment is blocked by the gateway, because the customer has not passed the gateway security check
|
| currency
|
string, 3
|
Payment currency code
|
| amount
|
currency
|
Payment total
|
| authorized
|
currency
|
Authorized payment total
|
| chargedAmount
|
currency
|
Charged payment total
|
| capturedAmount
|
currency
|
Captured amount of the authorized amount
|
| capturedAmountAvail
|
currency
|
Amount that is authorized and can be captured
|
| voidedAmount
|
currency
|
Amount that is authorized but voided
|
| voidedAmountAvail
|
currency
|
Amount that is authorized and can be voided
|
| refundedAmount
|
currency
|
Amount that can be refunded
|
| refundedAmountAvail
|
currency
|
Amount that can be refunded
|
| fraudAuthorized
|
currency
|
A part of the authorized amount that was blocked by the gateway because the customer had not passed the gateway security check
|
| fraudCharged
|
currency
|
A part of the charged amount that was blocked by the gateway because the customer had not passed the gateway security check
|
| authorizeInProgress
|
currency
|
A part of the authorized amount that is being handled by the gateway
|
| chargeInProgress
|
currency
|
A part of the charged amount that is being handled by the gateway
|
| transactionInProgress
|
0 or 1
|
Are there any payment transactions handled by the gateway?
|
| capturedAmountAvailMin
|
currency
|
Minimum amount that can be captured from the authorized amount
|
| capturedAmountAvailGateway
|
currency
|
Amount that can be captured from the authorized amount through the gateway
|
| capturedAmountAvailMinGateway
|
currency
|
Minimum amount that can be captured from the authorized amount through the gateway
|
| voidedAmountAvailGateway
|
currency
|
Amount that can be voided from the authorized amount through the gateway
|
| refundedAmountAvailGateway
|
currency
|
Amount that can be refunded from the authorized amount through the gateway
|
| txnId
|
string, 32
|
Unique payment ID
|
| lastMessage
|
string, 65536
|
Last gateway message
|
| error
|
string, 128
|
Error code
|
| error_message
|
string, 65536
|
Error message
|
Note: Fields ending in "Gateway" contain amounts that can be used in transactions through the gateway. For example, if a sum of $100 was authorized, and then a capture transaction was emulated for $100, the next refund operation will be available in the emulation mode only. The value of the refundedAmountAvailGateway field will be equal to 0.
Response example
<data>
<status>2</status>
<message>Payment is authorized</message>
<isFraudStatus></isFraudStatus>
<currency>USD</currency>
<amount>414.99</amount>
<authorized>414.99</authorized>
<chargedAmount>0.00</chargedAmount>
<capturedAmount>0.00</capturedAmount>
<capturedAmountAvail>414.99</capturedAmountAvail>
<voidedAmount>0.00</voidedAmount>
<voidedAmountAvail>414.99</voidedAmountAvail>
<refundedAmount>0.00</refundedAmount>
<refundedAmountAvail>0.00</refundedAmountAvail>
<fraudAuthorized>0.00</fraudAuthorized>
<fraudCharged>0.00</fraudCharged>
<authorizeInProgress>0.00</authorizeInProgress>
<chargeInProgress>0.00</chargeInProgress>
<transactionInProgress></transactionInProgress>
<capturedAmountAvailMin>0.00</capturedAmountAvailMin>
<capturedAmountAvailGateway>414.99</capturedAmountAvailGateway>
<capturedAmountAvailMinGateway>0.00</capturedAmountAvailMinGateway>
<voidedAmountAvailGateway>414.99</voidedAmountAvailGateway>
<refundedAmountAvailGateway>0.00</refundedAmountAvailGateway>
<txnId>8e67e0da23ce7ed451b2c1adbbd7373c</txnId>
<lastMessage>Success</lastMessage>
<error></error>
<error_message></error_message>
</data>
