Skip to content

Latest commit

 

History

History
483 lines (335 loc) · 13.1 KB

Dispute.md

File metadata and controls

483 lines (335 loc) · 13.1 KB

paystack.Dispute

All URIs are relative to https://api.paystack.co

Method HTTP request Description
download GET /dispute/export Export Disputes
evidence POST /dispute/{id}/evidence Add Evidence
fetch GET /dispute/{id} Fetch Dispute
list GET /dispute List Disputes
resolve PUT /dispute/{id}/resolve Resolve a Dispute
transaction GET /dispute/transaction/{id} List Transaction Disputes
update PUT /dispute/{id} Update Dispute
upload_url GET /dispute/{id}/upload_url Get Upload URL

download

Response download(per_page=per_page, page=page, status=status, _from=_from, to=to)

Export Disputes

Example

  • Bearer Authentication (bearerAuth):
import paystack
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'


# Export Disputes

response = paystack.Dispute.download(
)

pprint(response)

Parameters

Name Type Description Notes
per_page int Number of records to fetch per page [optional]
page int The section to retrieve [optional]
status str [optional]
_from datetime The start date [optional]
to datetime The end date [optional]

Return type

Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Request successful -
401 Unauthorized operation -
404 Entity not found -
0 Server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

evidence

Response evidence(id, customer_email, customer_name, customer_phone, service_details, delivery_address=delivery_address, delivery_date=delivery_date)

Add Evidence

Example

  • Bearer Authentication (bearerAuth):
import paystack
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

id = 'id_example' # str | Dispute ID
customer_email = 'customer_email_example' # str | Customer email
customer_name = 'customer_name_example' # str | Customer name
customer_phone = 'customer_phone_example' # str | Customer mobile number
service_details = 'service_details_example' # str | Details of service offered

# Add Evidence

response = paystack.Dispute.evidence(
    id,
    customer_email,
    customer_name,
    customer_phone,
    service_details,
)

pprint(response)

Parameters

Name Type Description Notes
id str Dispute ID
customer_email str Customer email
customer_name str Customer name
customer_phone str Customer mobile number
service_details str Details of service offered
delivery_address str Delivery address [optional]
delivery_date datetime ISO 8601 representation of delivery date (YYYY-MM-DD) [optional]

Return type

Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded, application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Request successful -
401 Unauthorized operation -
0 Server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch

Response fetch(id)

Fetch Dispute

Example

  • Bearer Authentication (bearerAuth):
import paystack
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

id = 'id_example' # str | Dispute ID

# Fetch Dispute

response = paystack.Dispute.fetch(
    id,
)

pprint(response)

Parameters

Name Type Description Notes
id str Dispute ID

Return type

Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Request successful -
401 Unauthorized operation -
404 Entity not found -
0 Server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

Response list(per_page=per_page, page=page, status=status, transaction=transaction, _from=_from, to=to)

List Disputes

Example

  • Bearer Authentication (bearerAuth):
import paystack
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'


# List Disputes

response = paystack.Dispute.list(
)

pprint(response)

Parameters

Name Type Description Notes
per_page int Number of records to fetch per page [optional]
page int The section to retrieve [optional]
status str Dispute Status. Acceptable values are awaiting-merchant-feedback, awaiting-bank-feedback, pending, resolved [optional]
transaction str Transaction ID [optional]
_from datetime The start date [optional]
to datetime The end date [optional]

Return type

Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Request successful -
401 Unauthorized operation -
404 Entity not found -
0 Server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resolve

Response resolve(id, resolution, message, refund_amount, uploaded_filename, evidence=evidence)

Resolve a Dispute

Example

  • Bearer Authentication (bearerAuth):
import paystack
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

id = 'id_example' # str | Dispute ID
resolution = 'resolution_example' # str | Dispute resolution. Accepted values, merchant-accepted, declined
message = 'message_example' # str | Reason for resolving
refund_amount = 'refund_amount_example' # str | The amount to refund, in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR
uploaded_filename = 'uploaded_filename_example' # str | Filename of attachment returned via response from the Dispute upload URL

# Resolve a Dispute

response = paystack.Dispute.resolve(
    id,
    resolution,
    message,
    refund_amount,
    uploaded_filename,
)

pprint(response)

Parameters

Name Type Description Notes
id str Dispute ID
resolution str Dispute resolution. Accepted values, merchant-accepted, declined
message str Reason for resolving
refund_amount str The amount to refund, in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR
uploaded_filename str Filename of attachment returned via response from the Dispute upload URL
evidence int Evidence Id for fraud claims [optional]

Return type

Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded, application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Request successful -
401 Unauthorized operation -
404 Entity not found -
0 Server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

transaction

Response transaction(id)

List Transaction Disputes

Example

  • Bearer Authentication (bearerAuth):
import paystack
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

id = 'id_example' # str | Transaction ID

# List Transaction Disputes

response = paystack.Dispute.transaction(
    id,
)

pprint(response)

Parameters

Name Type Description Notes
id str Transaction ID

Return type

Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Request successful -
401 Unauthorized operation -
404 Entity not found -
0 Server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

Response update(id, refund_amount, uploaded_filename=uploaded_filename)

Update Dispute

Example

  • Bearer Authentication (bearerAuth):
import paystack
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

id = 'id_example' # str | Dispute ID
refund_amount = 'refund_amount_example' # str | The amount to refund, in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR

# Update Dispute

response = paystack.Dispute.update(
    id,
    refund_amount,
)

pprint(response)

Parameters

Name Type Description Notes
id str Dispute ID
refund_amount str The amount to refund, in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR
uploaded_filename str Filename of attachment returned via response from the Dispute upload URL [optional]

Return type

Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded, application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Request successful -
401 Unauthorized operation -
404 Entity not found -
0 Server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_url

Response upload_url(id)

Get Upload URL

Example

  • Bearer Authentication (bearerAuth):
import paystack
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

id = 'id_example' # str | Dispute ID

# Get Upload URL

response = paystack.Dispute.upload_url(
    id,
)

pprint(response)

Parameters

Name Type Description Notes
id str Dispute ID

Return type

Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Request successful -
401 Unauthorized operation -
404 Entity not found -
0 Server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]