Hiweb Developers

# Transaction API Reference

Endpoint:

https://[client].hiweb.io/api/transactions

Transaction object:

{
	"type": "transactions",
	"id": "(string)",
	"attributes": {
		"invoice_id": "string|uuid",
		"parent_id": {"string|uuid" | null},
		"payment_id": "string|uuid",
		"payment_gateway_id": "string|uuid",
		"kind": "string|in:authorization,capture,sale,void,refund",
		"gateway": "string",
		"status": "string|in:pending,success,failure,error",
		"amount": {Float},
		"currency": "string",
		"data": {Object|Array},
		"processed_at": "string|datetime",
		"created_at": "string|datetime",
		"updated_at": "string|datetime"
	}
}

Related resources: Order

# Writable fields

Field name Creating Updating
invoice_id uuid uuid
parent_id uuid uuid
payment_id string string
payment_gateway_id string|uuid string|uuid
kind string|in:authorization,capture,sale,void,refund string|in:authorization,capture,sale,void,refund
gateway required|max:255 not_fillable
status string|in:pending,success,failure,error string|in:pending,success,failure,error
amount float|>=0 float|>=0
currency string string

# Writable relationships

Relationship name Relationship resource type Type Creating Updating
order orders To-one Yes - Required No

# Sortable

Field name
processed_at
created_at
updated_at
kind
gateway
status

# Filters

Filter name Detail
invoice_id uuid
order_id uuid
parent_id uuid
kind string
gateway string
status string
processed_at string|datetime
created_at string|datetime
updated_at string |datetime

← Fulfillments →