Queries APIs guides

For API reference, please head over to our APIs section using the sidebar on the left.

Queries Guide

For API reference, please head over to our APIs section using the sidebar on the left.

List Sales

API Reference

By using this API, you can get any sort of data in matters of a sales cycle for a certain seller. For exmaple, you can export sales data to measure any of the following business cases:

  1. Seller's Performance - Processing volume, transaction count and more.
  2. Average Transaction Value (ATV) - The average transaction amount in the presented currency.
  3. Understand Your Customer's User Behaviour - Preferred payment methods, Preferred products and more.
  4. Simplify Reconciliation Procedures - Export reporting independantly without waiting.
  5. Predict Seller's Cash-flow - Understand a seller future balance and take decisions based on it.

List Transactions

API Reference

With Get transactions API, you can extract data about transactions processed in a certain time period. Transactions can be one of the following:

Transaction type Explanation
Sale Sale is the initial status of a transaction.
Void A credit/debit card transaction that was cancelled before the business day it was initiated ended.
Refund A referral action for a sale. In case the buyer decided to cancel a certain purchase for any kind of reason and the merchant accepted the cancellation request, a refund will be issued.
Chargeback In case an unknown purchase appears in the credit/debit card description, the buyer can issue a chargeback.

List Sellers

API Reference

This API allows our partners to consume information about their sellers. The data includes:

  1. Registration date - When did a certail seller registered to PayMe's system
  2. Withdrawl plans - What is your seller's withdrawl plans with PayMe's payment processing services
  3. Seller's business code - What is your sellers business codes
  4. Seller's information - Address, Bank details and more

List Subscriptions

API Reference

This API allows our partners to learn about the active and inactive subscriptions of their sellers. The data includes:

  1. Subscriptions Iteration Model:
ID Description
1 Daily
2 Weekly
3 Monthly
4 Annually
  1. Subscription Status:
ID Description
1 Initial (not yet paid)
2 Active (paid successfully)
3 Failed
4 Cancelled
5 Completed
6 Failed, pending automatic retry
  1. Iterations count completed
  2. Iterations count left (based on subscription model)
  3. Buyer information

List Withdrawals

API Reference

This API allows our partners to obtain data on a specific withdrawl. The data includes:

  1. Withdrawal creation data - When a certain withdrawal request was created?
  2. Withdrawal Currency - What is a certain withdrawal currency?
  3. WIthdrawal total amount - Net withdrawal amount (Processing - Fees)
  4. Withdrawal status - Was the withdrawal completed succesfully?