Retrieve Payment Method

This endpoint is important when you want to check the settings or operational status of a Payment Method. For instance, if you want to ensure that the PayPal option is correctly configured, this endpoint allows you to verify its status, including whether it's active and if it's applying additional fees to the customer. This detailed information is vital for troubleshooting, auditing, and ensuring each payment method aligns with your current business strategies and customer needs.

GET/payment_methods/{name}
Sandbox: https://api.payiano.dev/v1/payment_methods/{name}
Live: https://api.payiano.com/v1/payment_methods/{name}
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
Path parameters:
name
required
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.

Query parameters:
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:
payment_method
Type: object

The payment method model details.

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.

fees
Type: array_of_objects

The payment method fees details.

currency_code
Type: enum
Possible values:
[ "EGP" ]

The three-character ISO-4217 Currency Code that identifies the currency for the payment method fee. Your business should be eligible to use the selected currency code.

type
Type: enum
Possible values:
[ "PROCESSING_FEE" ]

This indicates the category of the fee being charged for.

flat_amount
Type: decimal

This represents a FLAT fee amount that will be charged per transaction regardless of the transaction size.

percentage
Type: decimal

This indicates the PERCENTAGE of the transaction amount that will be taken as a transaction fee.

min_amount
Type: decimal|null

This is the minimum amount that can be charged for the transaction fee. If it's set to null, it means that there is no minimum fee limit.

max_amount
Type: decimal|null

This is the maximum amount that can be charged for the transaction fee. If it's set to null, it means that there is no maximum fee cap.

Response sample:
1
{ 2
 "payment_method": { 3 "name": "fawry", 4 "is_enabled": true, 5 "apply_fees_on_payer": false, 6 "is_active": true, 7
 "provider": { 8 "name": "fawry" 9 } 10 }, 11
 "fees": [ 12
 { 13 "currency_code": "EGP", 14 "type": "PROCESSING_FEE", 15 "flat_amount": 2.5, 16 "percentage": 2, 17 "min_amount": null, 18 "max_amount": null 19 } 20 ] 21}