Skip to main content

Python wrapper for paylike.io's REST API

Project description

paylike-python-sdk

Python implementation of Paylike.io's rest api

Limitation

Only the transaction management part has been implemented, you can find the official api documentation here: https://github.com/paylike/api-docs#transactions

Basic Usage

client = PaylikeApiClient(api_key, merchant_id)

Methods

cancel_transaction

'''
Void or partially void the reserved amount on a transaction
  - transactionId: String,      // required
  - amount: Decimal,            // If no amount is given, the full amount will be voided
'''
client.cancel_transaction(transaction_id, amount=None)

capture_transaction

'''
Capture a transaction
  - transactionId: String,      // required
  - amount: Decimal,            // required
  - descriptor: String,         // optional, text on client bank statement
  - currency: String,           // optional, expected currency (for additional verification)
'''
client.capture_transaction(transaction_id, amount, descriptor='', currency=None)

create_payment_from_transaction

Make sure to read about recurring payments.

'''
Create a payment, based on an existing transaction (used for recurring payments)
  - transactionId: String,      // required
  - currency: String,           // required, three letter ISO
  - amount: Decimal,            // required, amount in minor units
  - descriptor: String,         // optional, the statement on the customers bankaccount. Will fallback to merchant descriptor
'''
client.create_payment_from_transaction(transaction_id, currency, amount, descriptor='')

create_payment_from_saved_card

Make sure to read about recurring payments. It's recommended to use create_payment_from_transaction

'''
Create a payment from a saved card token
  - cardId: String,             // required
  - currency: String,           // required, three letter ISO
  - amount: Decimal,            // required
  - descriptor: String,         // optional, the statement on the customers bankaccount. Will fallback to merchant descriptor
'''
client.create_payment_from_saved_card(card_id, currency, amount, descriptor='')

get_transaction

'''
Fetch a transaction
  - transactionId: String,      // required
'''
client.get_transaction(transaction_id)

get_transactions

'''
Fetch transactions
  - limit: Number,              // optional, the number of transactions to fetch. Default 100
'''
client.get_transactions(limit=100)

refund_transaction

'''
Refund, or partially refund a transaction
  - transactionId: String,      // required
  - amount: Decimal,            // required
  - descriptor: String,         // optional, the statement on the customers bankaccount. Will fallback to merchant descriptor
'''
client.refund_transaction(self, transaction_id, amount, descriptor="")

'''

Project details


Release history Release notifications | RSS feed

This version

1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

paylike-1.0.tar.gz (3.2 kB view hashes)

Uploaded Source

Built Distribution

paylike-1.0-py3-none-any.whl (3.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page