Python library for Shift4 API

Installation

pip install shift4

Quick start

import shift4 as shift4

shift4.secret_key = 'pk_test_my_secret_key'

try:
    customer = shift4.customers.create({
        'email': '[email protected]',
        'description': 'User description'
    })
    print("Created customer:", customer)
    card = shift4.cards.create(customer['id'], {
        'number': '4242424242424242',
        'expMonth': '12',
        'expYear': '2023',
        'cvc': '123',
        'cardholderName': 'John Smith'
    })
    print("Created card:", card)
    charge = shift4.charges.create({
      'amount': 1000,
      'currency': 'EUR',
      'customerId': card['customerId']
    })
    print("Created charge:", charge)
except shift4.Shift4Exception as e:
  print(e)

API reference

Please refer to detailed API docs (linked) for all available fields

• charges
  • create(params)
  • get(charge_id)
  • update(charge_id, params)
  • capture(charge_id)
  • refund(charge_id, [params])
  • list([params])
• customers
  • create(params)
  • get(customer_id)
  • update(customer_id, params)
  • delete(customer_id)
  • list([params])
• cards
  • create(customer_id, params)
  • get(customer_id, card_id)
  • update(customer_id, card_id, params)
  • delete(customer_id, card_id)
  • list(customer_id, [params])
• subscriptions
  • create(params)
  • get(subscription_id)
  • update(subscription_id, params)
  • cancel(subscription_id, [params])
  • list([params])
• plans
  • create(params)
  • get(plan_id)
  • update(plan_id, params)
  • delete(plan_id)
  • list([params])
• events
  • get(event_id)
  • list([params])
• tokens
  • create(params)
  • get(token_id)
• blacklist
  • create(params)
  • get(blacklist_rule_id)
  • delete(blacklist_rule_id)
  • list([params])
• checkoutRequest
  • sign(checkoutRequestObjectOrJson)
• credits
  • create(params)
  • get(credit_id)
  • update(credit_id, params)
  • list([params])
• disputes
  • get(dispute_id)
  • update(dispute_id, params)
  • close(dispute_id)
  • list([params])
• fileUploads
  • upload(content, params)
  • get(file_upload_id)
  • list([params])
• fraudWarnings
  • get(fraud_warning_id)
  • list([params])
• paymentMethods
  • create(params)
  • retrieve(payment_method_id)
  • delete(payment_method_id)
  • list([params])

For further information, please refer to our official documentation at https://dev.shift4.com/docs.

Developing

Optionally setup a virtual environment

python -m venv ./venv --clear
source ./venv/bin/activate 

Install the package dependencies:

pip install -r requirements.txt -r test_requirements.txt

To connect to different backend:

import shift4 as api

api.secret_key = 'pk_test_my_secret_key'
api.api_url = 'https://api.myshift4env.com'
api.uploads_url = 'https://uploads.myshift4env.com'

To run tests:

SECRET_KEY=pk_test_my_secret_key pytest tests

Format the package files using black:

black setup.py shift4/ tests/