PaymentProvider - Liquid Object Reference
On this page
Description
The PaymentProvider object represents a source that can be used to collect Payments. Can be a 3rd party provider or a Pay Later provider.
:::note
This object supports custom data via the data attribute.
:::
Attributes
| Attribute | Type | Description |
|---|---|---|
active? |
Boolean | Returns true if this PaymentProvider is active |
code |
String | Returns the code of this PaymentProvider |
description_content |
String | Returns a description for this PaymentProvider |
id |
String | Returns a unique id for this PaymentProvider |
name |
String | Returns the name of this PaymentProvider |
payment_instructions_content |
String | Returns the value of the Payment Instructions attribute as rich text |
position |
Number | Returns the position of this PaymentProvider |
supports_express_checkout? |
Boolean | Returns true if this PaymentProvider supports express checkout and it is enabled in api_options |
supports_recurring_payments? |
Boolean | Returns true if this PaymentProvider supports recurring payments |
valid_payment_method? |
Boolean | Returns true if the current OrderSource has a valid payment method for this PaymentProvider |
validation_errors |
List[String] | Returns an array of validation errors for this Cart/Order/Customer if they choose this PaymentProvider |