Jumpseller Payment Methods API
The Payment Methods API from Jumpseller — 2 operation(s) for payment methods.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/jumpseller-com:jumpseller-com-payment-methods-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Jumpseller Com Payment Methods API
version: 1.0.0
x-logo:
url: https://api.jumpseller.com/images/jumpseller-logo-full.svg
altText: Jumpseller logo
href: /
description: 'Operations tagged Payment Methods across 2 of this provider''s published API definitions: jumpseller-com-openapi-openapi.json, jumpseller-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.jumpseller.com/v1
tags:
- name: Payment Methods
paths:
/payment_methods.json:
get:
tags:
- Payment Methods
summary: Retrieve all Store's Payment Methods
security:
- BasicAuthentication:
- payment_methods
- loginParameter: []
authtokenParameter: []
- OAuth2:
- read_payment_methods
parameters: []
responses:
'200':
description: An array of Payment Methods
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PaymentMethod'
x-codeSamples:
- lang: Shell
label: cURL
source: curl -u XXXXX:YYYYY -X GET "https://api.jumpseller.com/v1/payment_methods.json"
- lang: PHP
label: PHP
source: '<?php
$login = ''XXXXX'';
$authtoken = ''YYYYY'';
$url = ''https://api.jumpseller.com/v1/payment_methods.json'';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, $login . '':'' . $authtoken);
curl_setopt($ch, CURLOPT_HTTPHEADER, [''Content-Type: application/json'']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;'
- lang: Ruby
label: Ruby
source: 'require ''net/http''
require ''json''
uri = URI(''https://api.jumpseller.com/v1/payment_methods.json'')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request.basic_auth(''XXXXX'', ''YYYYY'')
request[''Content-Type''] = ''application/json''
response = http.request(request)
puts JSON.parse(response.body)'
- lang: Python
label: Python
source: "import requests\n\nresponse = requests.get(\n 'https://api.jumpseller.com/v1/payment_methods.json',\n auth=('XXXXX', 'YYYYY')\n)\nprint(response.json())"
- lang: JavaScript
label: JavaScript
source: "const response = await fetch('https://api.jumpseller.com/v1/payment_methods.json', {\n method: 'GET',\n headers: {\n 'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n 'Content-Type': 'application/json'\n }\n});\n\nconst data = await response.json();\nconsole.log(data);"
operationId: getPaymentMethodsJson
x-operation-id-source: derived
post:
tags:
- Payment Methods
summary: Creates an External Payment Method
security:
- BasicAuthentication:
- payment_methods
- loginParameter: []
authtokenParameter: []
- OAuth2:
- write_payment_methods
parameters: []
requestBody:
description: Payment Method parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodEdit'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethod'
'404':
description: PaymentMethod Not Found.
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
x-codegen-request-body-name: body
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -u XXXXX:YYYYY -X POST \"https://api.jumpseller.com/v1/payment_methods.json\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"payment_method\": {\"name\": \"My Example\", \"description\": \"example\", \"payment_method_url\": \"https://example.com\"}}'"
- lang: PHP
label: PHP
source: '<?php
$login = ''XXXXX'';
$authtoken = ''YYYYY'';
$url = ''https://api.jumpseller.com/v1/payment_methods.json'';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, $login . '':'' . $authtoken);
curl_setopt($ch, CURLOPT_HTTPHEADER, [''Content-Type: application/json'']);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, ''POST'');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([''payment_method'' => [''name'' => ''My Example'', ''description'' => ''example'', ''payment_method_url'' => ''https://example.com'']]));
$response = curl_exec($ch);
curl_close($ch);
echo $response;'
- lang: Ruby
label: Ruby
source: 'require ''net/http''
require ''json''
uri = URI(''https://api.jumpseller.com/v1/payment_methods.json'')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request.basic_auth(''XXXXX'', ''YYYYY'')
request[''Content-Type''] = ''application/json''
request.body = { payment_method: { name: ''My Example'', description: ''example'', payment_method_url: ''https://example.com'' } }.to_json
response = http.request(request)
puts JSON.parse(response.body)'
- lang: Python
label: Python
source: "import requests\n\nresponse = requests.post(\n 'https://api.jumpseller.com/v1/payment_methods.json',\n auth=('XXXXX', 'YYYYY'),\n json={'payment_method': {'name': 'My Example', 'description': 'example', 'payment_method_url': 'https://example.com'}}\n)\nprint(response.json())"
- lang: JavaScript
label: JavaScript
source: "const response = await fetch('https://api.jumpseller.com/v1/payment_methods.json', {\n method: 'POST',\n headers: {\n 'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({\"payment_method\": {\"name\": \"My Example\", \"description\": \"example\", \"payment_method_url\": \"https://example.com\"}})\n});\n\nconst data = await response.json();\nconsole.log(data);"
operationId: postPaymentMethodsJson
x-operation-id-source: derived
servers:
- url: https://api.jumpseller.com/v1
/payment_methods/{id}.json:
get:
tags:
- Payment Methods
summary: Retrieve a single Payment Method
security:
- BasicAuthentication:
- payment_methods
- loginParameter: []
authtokenParameter: []
- OAuth2:
- read_payment_methods
parameters:
- name: id
in: path
description: Id of the Payment Method
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethod'
'404':
description: PaymentMethod Not Found.
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
x-codeSamples:
- lang: Shell
label: cURL
source: curl -u XXXXX:YYYYY -X GET "https://api.jumpseller.com/v1/payment_methods/123.json"
- lang: PHP
label: PHP
source: '<?php
$login = ''XXXXX'';
$authtoken = ''YYYYY'';
$url = ''https://api.jumpseller.com/v1/payment_methods/123.json'';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, $login . '':'' . $authtoken);
curl_setopt($ch, CURLOPT_HTTPHEADER, [''Content-Type: application/json'']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;'
- lang: Ruby
label: Ruby
source: 'require ''net/http''
require ''json''
uri = URI(''https://api.jumpseller.com/v1/payment_methods/123.json'')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request.basic_auth(''XXXXX'', ''YYYYY'')
request[''Content-Type''] = ''application/json''
response = http.request(request)
puts JSON.parse(response.body)'
- lang: Python
label: Python
source: "import requests\n\nresponse = requests.get(\n 'https://api.jumpseller.com/v1/payment_methods/123.json',\n auth=('XXXXX', 'YYYYY')\n)\nprint(response.json())"
- lang: JavaScript
label: JavaScript
source: "const response = await fetch('https://api.jumpseller.com/v1/payment_methods/123.json', {\n method: 'GET',\n headers: {\n 'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n 'Content-Type': 'application/json'\n }\n});\n\nconst data = await response.json();\nconsole.log(data);"
operationId: getPaymentMethods{id}Json
x-operation-id-source: derived
put:
tags:
- Payment Methods
summary: Update an External Payment Method
security:
- BasicAuthentication:
- payment_methods
- loginParameter: []
authtokenParameter: []
- OAuth2:
- write_payment_methods
parameters:
- name: id
in: path
description: Id of the Payment Method
required: true
schema:
type: integer
format: int32
requestBody:
description: Payment Method parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodEdit_2'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethod'
'400':
description: Invalid `payment_method_url`.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageObject'
'404':
description: PaymentMethod Not Found.
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
x-codegen-request-body-name: body
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -u XXXXX:YYYYY -X PUT \"https://api.jumpseller.com/v1/payment_methods/123.json\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"payment_method\": {\"name\": \"My Updated Example\", \"description\": \"updated\", \"payment_method_url\": \"https://example.com\"}}'"
- lang: PHP
label: PHP
source: '<?php
$login = ''XXXXX'';
$authtoken = ''YYYYY'';
$url = ''https://api.jumpseller.com/v1/payment_methods/123.json'';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, $login . '':'' . $authtoken);
curl_setopt($ch, CURLOPT_HTTPHEADER, [''Content-Type: application/json'']);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, ''PUT'');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([''payment_method'' => [''name'' => ''My Updated Example'', ''description'' => ''updated'', ''payment_method_url'' => ''https://example.com'']]));
$response = curl_exec($ch);
curl_close($ch);
echo $response;'
- lang: Ruby
label: Ruby
source: 'require ''net/http''
require ''json''
uri = URI(''https://api.jumpseller.com/v1/payment_methods/123.json'')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Put.new(uri)
request.basic_auth(''XXXXX'', ''YYYYY'')
request[''Content-Type''] = ''application/json''
request.body = { payment_method: { name: ''My Updated Example'', description: ''updated'', payment_method_url: ''https://example.com'' } }.to_json
response = http.request(request)
puts JSON.parse(response.body)'
- lang: Python
label: Python
source: "import requests\n\nresponse = requests.put(\n 'https://api.jumpseller.com/v1/payment_methods/123.json',\n auth=('XXXXX', 'YYYYY'),\n json={'payment_method': {'name': 'My Updated Example', 'description': 'updated', 'payment_method_url': 'https://example.com'}}\n)\nprint(response.json())"
- lang: JavaScript
label: JavaScript
source: "const response = await fetch('https://api.jumpseller.com/v1/payment_methods/123.json', {\n method: 'PUT',\n headers: {\n 'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({\"payment_method\": {\"name\": \"My Updated Example\", \"description\": \"updated\", \"payment_method_url\": \"https://example.com\"}})\n});\n\nconst data = await response.json();\nconsole.log(data);"
description: Only External Payment Gateways created through the API can be updated. Only the fields sent are changed.
operationId: putPaymentMethods{id}Json
x-operation-id-source: derived
servers:
- url: https://api.jumpseller.com/v1
components:
schemas:
NotFound:
type: object
properties:
message:
type: string
PaymentMethod:
type: object
properties:
payment_method:
$ref: '#/components/schemas/PaymentMethodFields'
PaymentMethodFields:
type: object
properties:
id:
type: integer
description: Unique identifier of the Payment Method
format: int32
type:
type: string
description: Type of the Payment Method
enum:
- manual
- paypal
- pagseguro
- moneybookers
- webpay_cl
- easypay
- easypaycc
- ideal_basic
- hipay
- khipu
- mercado_pago
- ifthenpay
- eupago
- stripe
- payu
- servipag
- external_payment_gateway
name:
type: string
description: Name of the Payment Method
PaymentMethodEdit:
type: object
properties:
payment_method:
type: object
properties:
name:
type: string
description: Name of the Payment Method
description:
type: string
description: Payment information (optional) of the Method
payment_method_url:
type: string
description: The URL where we will provide information about your orders to your merchant account.
key:
type: string
description: The credential identifier of your merchant account.
secret:
type: string
description: The credential secret from your merchant account issued by your provider.
show_review:
type: boolean
description: Show the Checkout Review Order page when a customer selects this payment method.
use_new_version:
type: boolean
description: (Optional) Use new version of external payment gateway (x_tax, x_discount, x_shipping now included in params)
MessageObject:
type: object
properties:
message:
type: string
PaymentMethodFields_2:
type: object
properties:
id:
type: integer
description: Unique identifier of the Payment Method
format: int32
type:
type: string
description: Type of the Payment Method, e.g. `manual`, `paypal`, `stripe`, `mercado_pago`, `external_payment_gateway` or `external_payment_gateway_v2`
name:
type: string
description: Name of the Payment Method
PaymentMethodEdit_2:
type: object
properties:
payment_method:
type: object
properties:
name:
type: string
description: Name of the Payment Method
description:
type: string
description: Payment information (optional) of the Method
payment_method_url:
type: string
description: The URL where we will provide information about your orders to your merchant account. Required on create.
key:
type: string
description: The credential identifier of your merchant account.
secret:
type: string
description: The credential secret from your merchant account issued by your provider.
show_review:
type: boolean
description: Show the Checkout Review Order page when a customer selects this payment method.
use_new_version:
type: boolean
description: (Optional, create only) Use new version of external payment gateway (x_tax, x_discount, x_shipping now included in params)
securitySchemes:
BasicAuthentication:
type: http
scheme: basic
description: Basic authentication in the format of `login:authtoken` or `partner_code:auth_token`.
loginParameter:
type: apiKey
in: query
name: login
description: API OAuth login. Learn how to get yours [here](#section/Authentication).
authtokenParameter:
type: apiKey
in: query
name: authtoken
description: API OAuth token. Learn how to get yours [here](#section/Authentication).
auth_tokenParameter:
type: apiKey
in: query
name: auth_token
description: Partner authentication token.
OAuth2:
type: oauth2
description: OAuth 2.0 authorization code flow. Register your app at the Jumpseller Admin Panel to get client credentials. See https://jumpseller.com/support/oauth-2/ for details.
flows:
authorizationCode:
authorizationUrl: https://accounts.jumpseller.com/oauth/authorize
tokenUrl: https://accounts.jumpseller.com/oauth/token
refreshUrl: https://accounts.jumpseller.com/oauth/token
scopes:
read_products: Read products, variants, images, options, and custom fields
write_products: Create, update, and delete products
read_orders: Read orders, fulfillments, and order history
write_orders: Create, update, and refund orders
read_customers: Read customer accounts and groups
write_customers: Create, update, and delete customers
read_categories: Read product categories
write_categories: Create, update, and delete categories
read_store: Read store information and settings
write_store: Update store settings
read_settings: Read store configuration
write_settings: Update store configuration
read_shipping_methods: Read shipping methods and rates
write_shipping_methods: Create and update shipping methods
read_payment_methods: Read payment methods
write_payment_methods: Create and update payment methods
read_hooks: Read webhooks
write_hooks: Create, update, and delete webhooks
read_promotions: Read promotions and discounts
write_promotions: Create, update, and delete promotions
read_taxes: Read tax rules
write_taxes: Create and update tax rules
read_pages: Read store pages
write_pages: Create, update, and delete pages
read_countries: Read country information
write_countries: Update country settings
read_custom_fields: Read product custom fields
write_custom_fields: Create and update custom fields
read_checkout_custom_fields: Read checkout additional fields
write_checkout_custom_fields: Update checkout additional fields
read_customer_categories: Read customer categories
write_customer_categories: Create and update customer categories
read_jsapps: Read JavaScript apps
write_jsapps: Create, update, and delete JavaScript apps
read_apps: Read installed apps
read_fulfillments: Read fulfillment information
write_fulfillments: Create and update fulfillments
read_locations: Read warehouse locations
write_locations: Create and update locations
write_reviews: Manage product reviews
read_transaction_ledgers: Read store balance
write_store_setup: Create new stores via the store setup endpoint
x-refined-from:
- jumpseller-com-openapi-openapi.json
- jumpseller-com-openapi.json