List a seller's services

Credentials

Returns the value-added services (VAS) installed on one of your sellers, with each service's prices, payer and status. Partners only: send your payme_client_key and the seller's seller_payme_id. Inactive sellers can be queried too.

To narrow the list, filter by vas_type, vas_api_key or vas_payme_id. Service types are on VAS types.

Prices ending in _fixed are in minor units of vas_price_currency. Prices ending in _variable are percentages.

Parameters

This endpoint takes no path, query or header parameters.

Request body

Content type: application/json

Field Type Required Description
payme_client_key string yes Your partner key.
seller_payme_id string yes The seller's MPL.
vas_type string no A service type name from VAS types, for example Settlements. Unknown names return error 24.
vas_api_key string no A service's public ID, or an array of them.
vas_payme_id string no The vas_guid of one of the seller's services. Returns that service.
language string no Language of error messages: he (default) or en.

Request example

{
  "payme_client_key": "XXXXXXXX",
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "vas_type": "Settlements",
  "language": "en"
}

Code samples

curl

curl -X POST 'https://sandbox.payme.io/api/get-vas-seller' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "payme_client_key": "XXXXXXXX",
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "vas_type": "Settlements",
  "language": "en"
}'

Node.js

const response = await fetch("https://sandbox.payme.io/api/get-vas-seller", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "payme_client_key": "XXXXXXXX",
    "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
    "vas_type": "Settlements",
    "language": "en"
  }),
});

console.log(await response.text());

Python

import requests

response = requests.post(
    "https://sandbox.payme.io/api/get-vas-seller",
    json={
        "payme_client_key": "XXXXXXXX",
        "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
        "vas_type": "Settlements",
        "language": "en",
    },
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{
  "payme_client_key": "XXXXXXXX",
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "vas_type": "Settlements",
  "language": "en"
}
BODY;

$ch = curl_init('https://sandbox.payme.io/api/get-vas-seller');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Responses

200 — OK (success)

Field Type Description
status_code integer 0 on success.
session string PayMe session ID.
seller_payme_id string The seller's MPL.
vas_payme_id string The vas_payme_id filter from the request, or null.
items_count integer Number of services in items.
items array The seller's services.
items[].vas_description string Name of the service.
items[].vas_type string Service type name, see VAS types.
items[].vas_name string Plan name, for creation plans only. Otherwise null.
items[].vas_api_key string The service's public ID, or null.
items[].vas_guid string This seller's instance of the service.
items[].vas_is_active boolean true when the service is active for this seller.
items[].vas_payer_type integer Who pays for the service: 1 – partner, 2 – seller, 3 – reseller.
items[].vas_price_currency string Currency of the prices, ISO 4217, for example ILS.
items[].vas_price_setup_fixed integer One-time setup price, in minor units.
items[].vas_price_periodic_fixed integer Fixed periodic price, in minor units.
items[].vas_price_periodic_variable string Variable periodic price, percent.
items[].vas_price_usage_fixed integer Fixed price per use, in minor units.
items[].vas_price_usage_variable string Variable price per use, percent.
items[].vas_market_fee string Market fee set on this service, or null.
items[].vas_period integer Billing period: 1 – instant, 2 – daily, 3 – monthly, 4 – yearly.
items[].vas_data array Settings stored on the service. Their content depends on the service type. 
{
  "status_code": 0,
  "session": "a1B2c3D4",
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "vas_payme_id": null,
  "items_count": 1,
  "items": [
    {
      "vas_description": "עמלת סליקה",
      "vas_type": "Settlements",
      "vas_name": null,
      "vas_api_key": null,
      "vas_guid": "VASL1234-ABCD1234-EFGH5678-IJKL9012",
      "vas_is_active": true,
      "vas_payer_type": 2,
      "vas_price_currency": "ILS",
      "vas_price_setup_fixed": 0,
      "vas_price_periodic_fixed": 0,
      "vas_price_periodic_variable": "0.00",
      "vas_price_usage_fixed": 0,
      "vas_price_usage_variable": "0.00",
      "vas_market_fee": null,
      "vas_period": 1,
      "vas_data": []
    }
  ]
}

500 — Error, for example error 24: unknown vas_type (error)

Field Type Description
status_code integer 1 on failure.
status_error_code integer PayMe error code. See Errors.
status_error_details string Error message, in the request's language.
status_additional_info string Extra detail, such as the name of the missing or invalid field. Can be null.
session string PayMe session ID. Quote it when you contact support. 
{
  "status_code": 1,
  "status_error_details": "Invalid enum value",
  "status_additional_info": null,
  "status_error_code": 24,
  "session": "a1B2c3D4"
}