List Payment Methods

This endpoint provides a comprehensive list of all payment methods integrated into your Payiano account. It's like a directory that shows you every payment option set up for your business, from digital wallets like PayPal to various card payment systems. The endpoint is crucial for managing your payment options because it gives you a quick and complete overview. You can see which methods are available to your customers, allowing you to adjust your offerings based on their preferences or your business needs. This overview is especially important for ensuring you're providing a diverse range of payment options, catering to the varied preferences of your customers.

GET/payment_methods
Sandbox: https://api.payiano.dev/v1/payment_methods
Live: https://api.payiano.com/v1/payment_methods
Security
  • Authorization header with access token is required to access this endpoint: Bearer ACCESS-TOKEN
  • Your access token should be associated to this permission payment_methods_view
Request
Request body schema:
application/json
Query parameters:
page
Type: integer|null
Default: 1

The page number to be retrieved, for the list of payment methods. So, a combination of page=1 and per_page=25 returns the first 25 payment methods. A combination of page=2 and per_page=25 returns the next 25 payment methods.

per_page
Type: integer|null
Default: 25
Possible values: [1 ... 200]

The maximum number of payment methods to return in the response.

includes
Type: array_of_enums|null
Possible values:
[ "payment_method.provider" ]

A list of additional payment method relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

Response
200
Response schema:
application/json
Response body:
total_pages
Type: integer

The total number of pages that are available for the payment methods search criteria.

current_page
Type: integer

The current pagination page.

per_page
Type: integer

The amount of payment methods items return per page.

total_items
Type: integer

The total number of payment methods that match the search criteria.

items
Type: array_of_objects

The list of payment methods that match the search criteria.

name
Type: enum
Possible values:
[ "basata", "card", "damen", "ewallet", "fawry", "maxab", "opay", "sadad" ]

This attribute is the identifier for the Payment Method. Each name is unique ensuring there's no confusion between different Payment Methods.

is_enabled
Type: boolean

This attribute shows if the Payment Method is currently operational and capable of processing payments. This status is managed by the Payiano system and determines whether transactions can be made using this method. A true value means the Payment Method is active and functioning, while a false value implies that the Payment Method is deactivated or not in use.

apply_fees_on_payer
Type: boolean
Default: false

This attribute determines if processing fees are applied to the customer during checkout. When set to true, it means customers will pay additional charges when they choose this Payment Method, while a false value implies that the commission will be applied on your account. By default the processing fees will be applied to your account unless you chose to change it.

is_active
Type: boolean
Default: true

This value indicates whether the payment method is active or not. This flag can be used to control the payment method's availability in runtime environments or listings without deleting or removing the payment method from records. A true value means the payment method is active and functioning, while a false value implies that the payment method is deactivated or not in use.

provider
Type: object

The provider is the entity or service that facilitates or processes payments. This could be a bank, a digital wallet service, a credit card company, or any other financial service that enables transactions. Providers are integral to the functioning of payment systems as they are responsible for the actual processing of transactions. They ensure that payments are securely and efficiently processed, from the point of sale to the final settlement. In Payiano's system, each Payment Method is associated with a provider to clarify which service is handling the transactions for that specific method.

name
Type: enum
Possible values:
[ "basata", "damen", "fawry", "maxab", "opay", "payiano", "sadad" ]

The attribute is a unique identifier or label that clearly specifies which payment processing service is associated with a particular Payment Method. This could be names like paypal or fawry. It's essential for distinguishing between different providers, especially when offering multiple payment options to customers. The name helps in identifying the provider quickly and accurately, both for internal reference and for informing customers about the available Payment Methods. This clarity is crucial for efficient payment management and for maintaining transparency with customers about who is handling their transactions.

Response sample:
1
{ 2 "per_page": 25, 3 "total_pages": 1, 4 "total_items": 1, 5 "current_page": 1, 6
 "items": [ 7
 { 8 "name": "fawry", 9 "is_enabled": true, 10 "apply_fees_on_payer": false, 11 "is_active": true, 12
 "provider": { 13 "name": "fawry" 14 } 15 } 16 ] 17}