Skip to content

List payment methods

GET
/api/v1/business/website/payments/

Active payment methods to show at checkout — manual methods, gateway-backed methods (is_api_enabled: true), and cash on delivery. The COD entry may include spam_protection_enabled and an advance_config block when advance payment is configured.

Authorizations

apiKey

Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.

Type
API Key (header: X-Periscale-Key)

Parameters

Responses

Payment methods.

application/json
JSON
{
  
"status": true,
  
"status_code": 0,
  
"message": "string",
  
"data": {
  
  
"items": [
  
  
],
  
  
"next_cursor": "string",
  
  
"has_more": true
  
}
}

Playground

Server
Authorization

Samples

Powered by VitePress OpenAPI

© Periscale