Query a Transaction

Query a Transaction with a specified identifier string. The query will contact the gateway account to find the result and amount/currency. The response should be analyzed. If deemed appropriate, the transaction could be updated using the Transaction Update API.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Responses
201

Transaction was queried successfully.

Response Headers
Location
string <uri>

The location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
result
string

Transaction result.

Enum: "abandoned" "approved" "canceled" "declined" "unknown"
status
string

Transaction status.

Enum: "completed" "conn-error" "disputed" "never-sent" "offsite" "partially-refunded" "pending" "refunded" "sending" "suspended" … 6 more
amount
number <double>

The transaction's amount.

currency
string = 3 characters

ISO 4217 alphabetic currency code.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

post/transactions/{id}/query
Request samples
Response samples
application/json
{
  • "result": "abandoned",
  • "status": "completed",
  • "amount": 0,
  • "currency": "USD"
}