payment_transactions

Creates, updates, deletes, gets or lists a payment_transactions resource.

Overview

Name	payment_transactions
Type	Resource
Id	ovh.me.payment_transactions

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
payment_method_id	integer	Associated payment method ID (wire: paymentMethodId)
transaction_id	integer	Transaction ID (wire: transactionId)
amount	object	Transaction amount
creation_date	string (date-time)	Creation date (wire: creationDate)
last_update	string (date-time)	Last update date (wire: lastUpdate)
status	string	Transaction status (CANCELED, CANCELING, CONFIRMING, ERROR, EXPIRED, FAILED, READY, SUCCESS)
type	string	Transaction type (CREDIT, DEBIT)

list

Transaction object

Name	Datatype	Description
payment_method_id	integer	Associated payment method ID (wire: paymentMethodId)
transaction_id	integer	Transaction ID (wire: transactionId)
amount	object	Transaction amount
creation_date	string (date-time)	Creation date (wire: creationDate)
last_update	string (date-time)	Last update date (wire: lastUpdate)
status	string	Transaction status (CANCELED, CANCELING, CONFIRMING, ERROR, EXPIRED, FAILED, READY, SUCCESS)
type	string	Transaction type (CREDIT, DEBIT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	transaction_id		Retrieve a transaction
list	select		payment_method_id, status, x_pagination_mode	Retrieve payment transaction list

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
transaction_id	integer	Transaction ID (wire: transactionId)
payment_method_id	integer	Payment method ID (wire: paymentMethodId)
status	string	Status
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Retrieve a transaction

SELECT
payment_method_id,
transaction_id,
amount,
creation_date,
last_update,
status,
type
FROM ovh.me.payment_transactions
WHERE transaction_id = '{{ transaction_id }}' -- required
;

list

Retrieve payment transaction list

SELECT
payment_method_id,
transaction_id,
amount,
creation_date,
last_update,
status,
type
FROM ovh.me.payment_transactions
WHERE payment_method_id = '{{ payment_method_id }}'
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;