Skip to content

refunds.md

Latest commit

 

History

History
50 lines (35 loc) · 1.03 KB

refunds.md

File metadata and controls

50 lines (35 loc) · 1.03 KB

Refunds

Refund.create(**kwargs) - Create a refund, which is then processed by the Paystack team.

from paystackapi.refund import Refund
response = Refund.create(**kwargs)

Arguments

  • transaction: Transaction reference or id
  • amount: Amount in kobo to be refunded to the customer (optional).
  • currency: Three-letter ISO currency (Optional)
  • customer_note: Customer reason (Optional)
  • merchant_note: Merchant reason (Optional)

Returns

JSON data from paystack API.

Refund.list(**kwargs) - Get a list of refunds.

from paystackapi.refund import Refund
response = Refund.list(**kwargs)

Arguments

  • reference: Identifier for transaction to be refunded (Optional)
  • currency: Three-letter ISO currency - (Optional)

Returns

JSON data from paystack API.

Refund.fetch(refund_id) - Get a refund by its ID

from paystackapi.refund import Refund
response = Refund.fetch(refund_id=1234)

Arguments

  • refund_id: Refund ID

Returns

JSON data from paystack API.