Payment method
The Payment Method API endpoints allow fetching supported payment methods from a store.
Filter the returned list of items
{"value":" "}
Limit the properties returned in the response
{"value":" "}
Defines the properties that should be expanded in the response
{"value":" "}
API key specified through configuration to authorize access to the API.
The ID or the alias of the store
{"value":"78710b41-4956-46af-a646-1d3aa478bacf"}
The ID of the current order associated with the current session
c7458f8a-e776-48c1-8760-c1aa36f3fb0b
The ID or alias of the session default billing country
{"value":"f2b95ffe-72db-4fd3-867a-bcee497619a6"}
The ID or alias of the session default billing region
{"value":"f1fb8159-30cd-42d7-bbe7-f79308ddcb28"}
The ID or alias of the session default shipping country
{"value":"51ae67d5-dda4-4d9c-98fe-a16528331cfd"}
The ID or alias of the session default shipping region
{"value":"1c7c655e-a232-4e4f-ab8a-fd691b67ec02"}
The ID or alias of the session default tax class
{"value":"a43efe6d-9006-449e-889d-7ef9de8a3d80"}
The ID or alias of the session currency
{"value":"8de0307d-cedc-4e64-aaba-919f98654f96"}
The ISO culture code of the current session culture
en-US
The unique reference for the customer associated with the current session
cust_9dd6ef24-3cf9-47bc-beaa-47bd48e55618
GET /umbraco/commerce/storefront/api/v1/paymentmethods HTTP/1.1
Host:
Api-Key: text
Store: text
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text",
"name": "text",
"store": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text",
"name": "text",
"defaultCountry": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text",
"name": "text",
"store": "[Circular Reference]",
"defaultCurrency": "[Circular Reference]",
"defaultPaymentMethod": "[Circular Reference]",
"defaultShippingMethod": "[Circular Reference]",
"regions": "[Circular Reference]"
},
"defaultTaxClass": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text",
"name": "text",
"store": "[Circular Reference]",
"defaultTaxRate": 1,
"defaultTaxCode": "text",
"taxRate": 1,
"taxCode": "text",
"countryRegionTaxClasses": "[Circular Reference]"
},
"baseCurrency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text",
"name": "text",
"store": "[Circular Reference]",
"culture": "text",
"symbol": "text",
"decimalPlaces": 1,
"decimalSeparator": "text",
"groupSeparator": "text",
"formatTemplate": "text",
"allowedCountries": "[Circular Reference]"
},
"pricesIncludeTax": true
},
"sku": "text",
"taxClass": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text",
"name": "text",
"store": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text",
"name": "text",
"defaultCountry": "[Circular Reference]",
"defaultTaxClass": "[Circular Reference]",
"baseCurrency": "[Circular Reference]",
"pricesIncludeTax": true
},
"defaultTaxRate": 1,
"defaultTaxCode": "text",
"taxRate": 1,
"taxCode": "text",
"countryRegionTaxClasses": [
{
"store": "[Circular Reference]",
"country": "[Circular Reference]",
"region": "[Circular Reference]",
"taxRate": 1,
"taxCode": "text"
}
]
},
"paymentProviderAlias": "text",
"imageUrl": "text"
}
]
The ID or the alias of the given resource
{"value":"6bb2c127-6d5c-4f3b-b82b-17ac379a9164"}
Limit the properties returned in the response
{"value":" "}
Defines the properties that should be expanded in the response
{"value":" "}
API key specified through configuration to authorize access to the API.
The ID or the alias of the store
{"value":"28949a61-f663-418f-8c5a-018da2e51f69"}
The ID of the current order associated with the current session
60d08247-03e3-47f0-9c08-98ac8523aeea
The ID or alias of the session default billing country
{"value":"41169e96-4ca1-499d-b6ea-05eedba9ced6"}
The ID or alias of the session default billing region
{"value":"b2b918b2-687c-4c51-8823-3998aed03dfb"}
The ID or alias of the session default shipping country
{"value":"de37500c-9ba3-4e66-afc4-e354d3ca8caa"}
The ID or alias of the session default shipping region
{"value":"210e74c1-9bee-4831-9ca3-9c7c93a2449a"}
The ID or alias of the session default tax class
{"value":"aac38a2a-8e72-43f1-944b-bf3182151d2f"}
The ID or alias of the session currency
{"value":"cf4c636a-4a11-40e4-bd9b-2ac426d89a9e"}
The ISO culture code of the current session culture
en-US
The unique reference for the customer associated with the current session
cust_c8e6904c-52ef-4345-a2ad-9f1bf8b28c3b
GET /umbraco/commerce/storefront/api/v1/paymentmethod/{idOrAlias} HTTP/1.1
Host:
Api-Key: text
Store: text
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text",
"name": "text",
"store": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text",
"name": "text",
"defaultCountry": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text",
"name": "text",
"store": "[Circular Reference]",
"defaultCurrency": "[Circular Reference]",
"defaultPaymentMethod": "[Circular Reference]",
"defaultShippingMethod": "[Circular Reference]",
"regions": "[Circular Reference]"
},
"defaultTaxClass": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text",
"name": "text",
"store": "[Circular Reference]",
"defaultTaxRate": 1,
"defaultTaxCode": "text",
"taxRate": 1,
"taxCode": "text",
"countryRegionTaxClasses": "[Circular Reference]"
},
"baseCurrency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text",
"name": "text",
"store": "[Circular Reference]",
"culture": "text",
"symbol": "text",
"decimalPlaces": 1,
"decimalSeparator": "text",
"groupSeparator": "text",
"formatTemplate": "text",
"allowedCountries": "[Circular Reference]"
},
"pricesIncludeTax": true
},
"sku": "text",
"taxClass": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text",
"name": "text",
"store": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text",
"name": "text",
"defaultCountry": "[Circular Reference]",
"defaultTaxClass": "[Circular Reference]",
"baseCurrency": "[Circular Reference]",
"pricesIncludeTax": true
},
"defaultTaxRate": 1,
"defaultTaxCode": "text",
"taxRate": 1,
"taxCode": "text",
"countryRegionTaxClasses": [
{
"store": "[Circular Reference]",
"country": "[Circular Reference]",
"region": "[Circular Reference]",
"taxRate": 1,
"taxCode": "text"
}
]
},
"paymentProviderAlias": "text",
"imageUrl": "text"
}
Last updated
Was this helpful?