braintree_refunder

Table of Contents

• Purpose
• Input
• Output
• Contributing
• TODO
• Requirements
• Run the project locally
• Run the tests

Purpose:

Automatically void or refund Braintree transactions.

Input

1. [required] Sandbox or Production API keys for a user with API access and the following permissions:

• Credit Previous Transactions (Refunds)
• Void Transactions

2. [required] A CSV file that includes a header, Braintree transaction IDs, and, optionally, the amount to refund.

id	amount
de48m2c7	3.50
c929kphn
jn3g8509
1geft1mj	1,000,000
rqgqy6yn

3. [optional] A valid U.S. phone number to receive an SMS notification when the job is complete.

Output

1. A CSV formatted file that logs the result of every attempted void or refund.

transaction_id	refunded_transaction_id	status	message
de48m2c7		FAILURE	Credit transactions cannot be refunded.
c929kphn		FAILURE	Transaction has already been completely refunded.
jn3g8509		NO OPERATION	Transaction must have a status in "Authorized, Submitted For Settlement, Settlement Pending, Settling, or Settled."
1geft1mj	1geft1mj	SUCCESS	Transaction voided.
rqgqy6yn	qweby7pq	SUCCESS	Transaction refunded.

2. If phone number was provided, an SMS notification.

Contributing

See CONTRIBUTING.md.

TODO

See TODO.md.

Requirements

• Python3
• pip3
• Django
• Chrome web driver. Get it here.
• An APP_SECRET_KEY. From the Django docs, "A secret key for a particular Django installation. This is used to provide cryptographic signing, and should be set to a unique, unpredictable value." Follow these instructions to generate an APP_SECRET_KEY.
• Braintree Sandbox or Production API keys
• Twilio SID and Token. Find these in your Twilio account.

Run the project locally

1. Clone the repo.
2. Create a virtual environment

python3 -m venv venv

3. Activate the venv

source venv/bin/activate

4. Install requirements

pip3 install -r requirements.txt

5. Copy example.env file to .env file in project root and add keys.

• See requirements

6. Create a files directory in the refunder/ app.

mkdir refunder/files

7. Run the development server

python3 manage.py runserver

Run the tests

1. Run the development server.

python3 manage.py runserver

2. Run the functional tests.

python3 manage.py test functional_tests

3. Run the unit tests

python3 manage.py test refunder

4. Run unit tests for a specific module

python3 manage.py test refunder.test_module_name