Skip to main content

payment_available_methods

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

Overview​

Namepayment_available_methods
TypeResource
Idovh.me.payment_available_methods

Fields​

The following fields are returned by SELECT queries:

Available payment method object

NameDatatypeDescription
form_session_idstringForm session ID (wire: formSessionId)
merchant_idstringMerchant ID (wire: merchantId)
organization_idstringOrganization ID (wire: organizationId)
iconobjectPayment method type icon
integrationstringPayment method integration type (BANK_TRANSFER, COMPONENT, IFRAME_VANTIV, IN_CONTEXT, NONE, OSP, POST_FORM, REDIRECT)
oneshotbooleanIndicates if payment method type allows to process oneshot payment
payment_sub_typestringPayment method sub-type (30_DAYS, 45_DAYS, 60_DAYS, AMERICAN_EXPRESS, AURA, CARTE_BANCAIRE, CARTE_BLEUE, CHORUS, DINERS_CLUB, DISCOVER, JCB, MAESTRO, MASTERCARD, NONE, RUPAY, VISA) (wire: paymentSubType)
payment_typestringPayment method type (wire: paymentType)
registerablebooleanIndicates if payment method type is registerable ?
registerable_with_transactionbooleanIndicates if payment method type allows payment and registration at the same time (wire: registerableWithTransaction)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectRetrieve available payment method

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.

NameDatatypeDescription
api_hoststringThe 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"}})

SELECT examples​

Retrieve available payment method

SELECT
form_session_id,
merchant_id,
organization_id,
icon,
integration,
oneshot,
payment_sub_type,
payment_type,
registerable,
registerable_with_transaction
FROM ovh.me.payment_available_methods
;