Skip to content

Refunds

AsyncRefund

Bases: BaseAsyncAPI

Provides a wrapper for paystack Refunds API

The Refunds API allows you to create and manage transaction refunds. https://paystack.com/docs/api/refund/

Source code in src/pypaystack2/api/refunds.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
class AsyncRefund(BaseAsyncAPI):
    """Provides a wrapper for paystack Refunds API

    The Refunds API allows you to create and manage transaction refunds.
    https://paystack.com/docs/api/refund/
    """

    async def create(
        self,
        transaction: str,
        amount: Optional[int] = None,
        currency: Optional[Currency] = None,
        customer_note: Optional[str] = None,
        merchant_note: Optional[str] = None,
    ) -> Response:
        """Initiate a refund on your integration

        Args:
            transaction: Transaction reference or id
            amount: Amount ( in kobo if currency is NGN, pesewas, if currency is
                GHS, and cents, if currency is ZAR ) to be refunded to the
                customer. Amount is optional(defaults to original
                transaction amount) and cannot be more than the original
                transaction amount
            currency: Any value from the ``Currency`` enum
            customer_note: Customer reason
            merchant_note: Merchant reason

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        if amount is not None:
            amount = validate_amount(amount)
        url = self._parse_url("/refund")
        payload = {"transaction": transaction}
        optional_params = [
            ("amount", amount),
            ("currency", currency),
            ("customer_note", customer_note),
            ("merchant_note", merchant_note),
        ]
        payload = add_to_payload(optional_params, payload)
        return await self._handle_request(HTTPMethod.POST, url, payload)

    async def get_refunds(
        self,
        reference: Optional[str] = None,
        currency: Optional[Currency] = None,
        pagination: int = 50,
        page: int = 1,
        start_date: Optional[str] = None,
        end_date: Optional[str] = None,
    ) -> Response:
        """Fetch refunds available on your integration.

        Args:
            reference: Identifier for transaction to be refunded
            currency: Any value from the ``Currency`` enum
            pagination: Specifies how many records you want to retrieve per page.
                If not specified we use a default value of 50.
            page: Specifies exactly what refund you want to page.
                If not specified we use a default value of 1.
            start_date: A timestamp from which to start listing refund e.g. 2016-09-21
            end_date: A timestamp at which to stop listing refund e.g. 2016-09-21

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url(f"/refund?perPage={pagination}")
        query_params = [
            ("reference", reference),
            ("currency", currency),
            ("page", page),
            ("start_date", start_date),
            ("end_date", end_date),
        ]
        url = append_query_params(query_params, url)
        return await self._handle_request(HTTPMethod.GET, url)

    async def get_refund(self, reference: str) -> Response:
        """Get details of a refund on your integration.

        Args:
            reference: Identifier for transaction to be refunded

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url(f"/refund/{reference}")
        return await self._handle_request(HTTPMethod.GET, url)

create(transaction, amount=None, currency=None, customer_note=None, merchant_note=None) async

Initiate a refund on your integration

Parameters:

Name Type Description Default
transaction str

Transaction reference or id

 required
amount Optional[int]

Amount ( in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR ) to be refunded to the customer. Amount is optional(defaults to original transaction amount) and cannot be more than the original transaction amount

 None
currency Optional[Currency]

Any value from the Currency enum

 None
customer_note Optional[str]

Customer reason

 None
merchant_note Optional[str]

Merchant reason

 None

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/refunds.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
async def create(
    self,
    transaction: str,
    amount: Optional[int] = None,
    currency: Optional[Currency] = None,
    customer_note: Optional[str] = None,
    merchant_note: Optional[str] = None,
) -> Response:
    """Initiate a refund on your integration

    Args:
        transaction: Transaction reference or id
        amount: Amount ( in kobo if currency is NGN, pesewas, if currency is
            GHS, and cents, if currency is ZAR ) to be refunded to the
            customer. Amount is optional(defaults to original
            transaction amount) and cannot be more than the original
            transaction amount
        currency: Any value from the ``Currency`` enum
        customer_note: Customer reason
        merchant_note: Merchant reason

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    if amount is not None:
        amount = validate_amount(amount)
    url = self._parse_url("/refund")
    payload = {"transaction": transaction}
    optional_params = [
        ("amount", amount),
        ("currency", currency),
        ("customer_note", customer_note),
        ("merchant_note", merchant_note),
    ]
    payload = add_to_payload(optional_params, payload)
    return await self._handle_request(HTTPMethod.POST, url, payload)

get_refund(reference) async

Get details of a refund on your integration.

Parameters:

Name Type Description Default
reference str

Identifier for transaction to be refunded

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/refunds.py 
190
191
192
193
194
195
196
197
198
199
200
201
async def get_refund(self, reference: str) -> Response:
    """Get details of a refund on your integration.

    Args:
        reference: Identifier for transaction to be refunded

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url(f"/refund/{reference}")
    return await self._handle_request(HTTPMethod.GET, url)

get_refunds(reference=None, currency=None, pagination=50, page=1, start_date=None, end_date=None) async

Fetch refunds available on your integration.

Parameters:

Name Type Description Default
reference Optional[str]

Identifier for transaction to be refunded

 None
currency Optional[Currency]

Any value from the Currency enum

 None
pagination int

Specifies how many records you want to retrieve per page. If not specified we use a default value of 50.

 50
page int

Specifies exactly what refund you want to page. If not specified we use a default value of 1.

 1
start_date Optional[str]

A timestamp from which to start listing refund e.g. 2016-09-21

 None
end_date Optional[str]

A timestamp at which to stop listing refund e.g. 2016-09-21

 None

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/refunds.py 
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
async def get_refunds(
    self,
    reference: Optional[str] = None,
    currency: Optional[Currency] = None,
    pagination: int = 50,
    page: int = 1,
    start_date: Optional[str] = None,
    end_date: Optional[str] = None,
) -> Response:
    """Fetch refunds available on your integration.

    Args:
        reference: Identifier for transaction to be refunded
        currency: Any value from the ``Currency`` enum
        pagination: Specifies how many records you want to retrieve per page.
            If not specified we use a default value of 50.
        page: Specifies exactly what refund you want to page.
            If not specified we use a default value of 1.
        start_date: A timestamp from which to start listing refund e.g. 2016-09-21
        end_date: A timestamp at which to stop listing refund e.g. 2016-09-21

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url(f"/refund?perPage={pagination}")
    query_params = [
        ("reference", reference),
        ("currency", currency),
        ("page", page),
        ("start_date", start_date),
        ("end_date", end_date),
    ]
    url = append_query_params(query_params, url)
    return await self._handle_request(HTTPMethod.GET, url)

Refund

Bases: BaseAPI

Provides a wrapper for paystack Refunds API

The Refunds API allows you to create and manage transaction refunds. https://paystack.com/docs/api/refund/

Source code in src/pypaystack2/api/refunds.py 
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
class Refund(BaseAPI):
    """Provides a wrapper for paystack Refunds API

    The Refunds API allows you to create and manage transaction refunds.
    https://paystack.com/docs/api/refund/
    """

    def create(
        self,
        transaction: str,
        amount: Optional[int] = None,
        currency: Optional[Currency] = None,
        customer_note: Optional[str] = None,
        merchant_note: Optional[str] = None,
    ) -> Response:
        """Initiate a refund on your integration

        Args:
            transaction: Transaction reference or id
            amount: Amount ( in kobo if currency is NGN, pesewas, if currency is
                GHS, and cents, if currency is ZAR ) to be refunded to the
                customer. Amount is optional(defaults to original
                transaction amount) and cannot be more than the original
                transaction amount
            currency: Any value from the ``Currency`` enum
            customer_note: Customer reason
            merchant_note: Merchant reason

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        if amount is not None:
            amount = validate_amount(amount)
        url = self._parse_url("/refund")
        payload = {"transaction": transaction}
        optional_params = [
            ("amount", amount),
            ("currency", currency),
            ("customer_note", customer_note),
            ("merchant_note", merchant_note),
        ]
        payload = add_to_payload(optional_params, payload)
        return self._handle_request(HTTPMethod.POST, url, payload)

    def get_refunds(
        self,
        reference: Optional[str] = None,
        currency: Optional[Currency] = None,
        pagination: int = 50,
        page: int = 1,
        start_date: Optional[str] = None,
        end_date: Optional[str] = None,
    ) -> Response:
        """Fetch refunds available on your integration.

        Args:
            reference: Identifier for transaction to be refunded
            currency: Any value from the ``Currency`` enum
            pagination: Specifies how many records you want to retrieve per page.
                If not specified we use a default value of 50.
            page: Specifies exactly what refund you want to page.
                If not specified we use a default value of 1.
            start_date: A timestamp from which to start listing refund e.g. 2016-09-21
            end_date: A timestamp at which to stop listing refund e.g. 2016-09-21

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url(f"/refund?perPage={pagination}")
        query_params = [
            ("reference", reference),
            ("currency", currency),
            ("page", page),
            ("start_date", start_date),
            ("end_date", end_date),
        ]
        url = append_query_params(query_params, url)
        return self._handle_request(HTTPMethod.GET, url)

    def get_refund(self, reference: str) -> Response:
        """Get details of a refund on your integration.

        Args:
            reference: Identifier for transaction to be refunded

        Returns:
            A named tuple containing the response gotten from paystack's server.
        """

        url = self._parse_url(f"/refund/{reference}")
        return self._handle_request(HTTPMethod.GET, url)

create(transaction, amount=None, currency=None, customer_note=None, merchant_note=None)

Initiate a refund on your integration

Parameters:

Name Type Description Default
transaction str

Transaction reference or id

 required
amount Optional[int]

Amount ( in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR ) to be refunded to the customer. Amount is optional(defaults to original transaction amount) and cannot be more than the original transaction amount

 None
currency Optional[Currency]

Any value from the Currency enum

 None
customer_note Optional[str]

Customer reason

 None
merchant_note Optional[str]

Merchant reason

 None

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/refunds.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def create(
    self,
    transaction: str,
    amount: Optional[int] = None,
    currency: Optional[Currency] = None,
    customer_note: Optional[str] = None,
    merchant_note: Optional[str] = None,
) -> Response:
    """Initiate a refund on your integration

    Args:
        transaction: Transaction reference or id
        amount: Amount ( in kobo if currency is NGN, pesewas, if currency is
            GHS, and cents, if currency is ZAR ) to be refunded to the
            customer. Amount is optional(defaults to original
            transaction amount) and cannot be more than the original
            transaction amount
        currency: Any value from the ``Currency`` enum
        customer_note: Customer reason
        merchant_note: Merchant reason

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    if amount is not None:
        amount = validate_amount(amount)
    url = self._parse_url("/refund")
    payload = {"transaction": transaction}
    optional_params = [
        ("amount", amount),
        ("currency", currency),
        ("customer_note", customer_note),
        ("merchant_note", merchant_note),
    ]
    payload = add_to_payload(optional_params, payload)
    return self._handle_request(HTTPMethod.POST, url, payload)

get_refund(reference)

Get details of a refund on your integration.

Parameters:

Name Type Description Default
reference str

Identifier for transaction to be refunded

 required

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/refunds.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def get_refund(self, reference: str) -> Response:
    """Get details of a refund on your integration.

    Args:
        reference: Identifier for transaction to be refunded

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url(f"/refund/{reference}")
    return self._handle_request(HTTPMethod.GET, url)

get_refunds(reference=None, currency=None, pagination=50, page=1, start_date=None, end_date=None)

Fetch refunds available on your integration.

Parameters:

Name Type Description Default
reference Optional[str]

Identifier for transaction to be refunded

 None
currency Optional[Currency]

Any value from the Currency enum

 None
pagination int

Specifies how many records you want to retrieve per page. If not specified we use a default value of 50.

 50
page int

Specifies exactly what refund you want to page. If not specified we use a default value of 1.

 1
start_date Optional[str]

A timestamp from which to start listing refund e.g. 2016-09-21

 None
end_date Optional[str]

A timestamp at which to stop listing refund e.g. 2016-09-21

 None

Returns:

Type Description
Response

A named tuple containing the response gotten from paystack's server.
Source code in src/pypaystack2/api/refunds.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
def get_refunds(
    self,
    reference: Optional[str] = None,
    currency: Optional[Currency] = None,
    pagination: int = 50,
    page: int = 1,
    start_date: Optional[str] = None,
    end_date: Optional[str] = None,
) -> Response:
    """Fetch refunds available on your integration.

    Args:
        reference: Identifier for transaction to be refunded
        currency: Any value from the ``Currency`` enum
        pagination: Specifies how many records you want to retrieve per page.
            If not specified we use a default value of 50.
        page: Specifies exactly what refund you want to page.
            If not specified we use a default value of 1.
        start_date: A timestamp from which to start listing refund e.g. 2016-09-21
        end_date: A timestamp at which to stop listing refund e.g. 2016-09-21

    Returns:
        A named tuple containing the response gotten from paystack's server.
    """

    url = self._parse_url(f"/refund?perPage={pagination}")
    query_params = [
        ("reference", reference),
        ("currency", currency),
        ("page", page),
        ("start_date", start_date),
        ("end_date", end_date),
    ]
    url = append_query_params(query_params, url)
    return self._handle_request(HTTPMethod.GET, url)