# paystack.Charge

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**check**](Charge.md#check) | **GET** /charge/{reference} | Check pending charge
[**create**](Charge.md#create) | **POST** /charge | Create Charge
[**submit_address**](Charge.md#submit_address) | **POST** /charge/submit_address | Submit Address
[**submit_birthday**](Charge.md#submit_birthday) | **POST** /charge/submit_birthday | Submit Birthday
[**submit_otp**](Charge.md#submit_otp) | **POST** /charge/submit_otp | Submit OTP
[**submit_phone**](Charge.md#submit_phone) | **POST** /charge/submit_phone | Submit Phone
[**submit_pin**](Charge.md#submit_pin) | **POST** /charge/submit_pin | Submit PIN


# **check**
> Response check(reference)

Check pending charge

### Example

* Bearer Authentication (bearerAuth):
```python
import paystack
from pprint import pprint

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

reference = 'reference_example' # str | 

# Check pending charge

response = paystack.Charge.check(
    reference,
)

pprint(response)
```
### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **reference** | **str**|  | 

### Return type

[**Response**](Response.md)

### Authorization

[bearerAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create**
> Response create(email=email, amount=amount, authorization_code=authorization_code, pin=pin, reference=reference, birthday=birthday, device_id=device_id, metadata=metadata, bank=bank, mobile_money=mobile_money, ussd=ussd, eft=eft)

Create Charge

### Example

* Bearer Authentication (bearerAuth):
```python
import paystack
from pprint import pprint

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


# Create Charge

response = paystack.Charge.create(
)

pprint(response)
```
### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email** | **str**| Customer's email address | [optional] 
 **amount** | **str**| Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR | [optional] 
 **authorization_code** | **str**| An authorization code to charge. | [optional] 
 **pin** | **str**| 4-digit PIN (send with a non-reusable authorization code) | [optional] 
 **reference** | **str**| Unique transaction reference. Only -, .`, = and alphanumeric characters allowed. | [optional] 
 **birthday** | **datetime**| The customer's birthday in the format YYYY-MM-DD e.g 2017-05-16 | [optional] 
 **device_id** | **str**| This is the unique identifier of the device a user uses in making payment.  Only -, .`, = and alphanumeric characters are allowed. | [optional] 
 **metadata** | **str**| Stringified JSON object of custom data | [optional] 
 **bank** | [**Bank**](Bank.md)|  | [optional] 
 **mobile_money** | [**MobileMoney**](MobileMoney.md)|  | [optional] 
 **ussd** | [**USSD**](USSD.md)|  | [optional] 
 **eft** | [**EFT**](EFT.md)|  | [optional] 

### Return type

[**Response**](Response.md)

### Authorization

[bearerAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **submit_address**
> Response submit_address(address, city, state, zipcode, reference)

Submit Address

### Example

* Bearer Authentication (bearerAuth):
```python
import paystack
from pprint import pprint

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

address = 'address_example' # str | Customer's address
city = 'city_example' # str | Customer's city
state = 'state_example' # str | Customer's state
zipcode = 'zipcode_example' # str | Customer's zipcode
reference = 'reference_example' # str | The reference of the ongoing transaction

# Submit Address

response = paystack.Charge.submit_address(
    address,
    city,
    state,
    zipcode,
    reference,
)

pprint(response)
```
### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **address** | **str**| Customer's address | 
 **city** | **str**| Customer's city | 
 **state** | **str**| Customer's state | 
 **zipcode** | **str**| Customer's zipcode | 
 **reference** | **str**| The reference of the ongoing transaction | 

### Return type

[**Response**](Response.md)

### Authorization

[bearerAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **submit_birthday**
> Response submit_birthday(birthday, reference)

Submit Birthday

### Example

* Bearer Authentication (bearerAuth):
```python
import paystack
from pprint import pprint

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

birthday = 'birthday_example' # str | Customer's birthday in the format YYYY-MM-DD e.g 2016-09-21
reference = 'reference_example' # str | The reference of the ongoing transaction

# Submit Birthday

response = paystack.Charge.submit_birthday(
    birthday,
    reference,
)

pprint(response)
```
### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **birthday** | **str**| Customer's birthday in the format YYYY-MM-DD e.g 2016-09-21 | 
 **reference** | **str**| The reference of the ongoing transaction | 

### Return type

[**Response**](Response.md)

### Authorization

[bearerAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **submit_otp**
> Response submit_otp(otp, reference)

Submit OTP

### Example

* Bearer Authentication (bearerAuth):
```python
import paystack
from pprint import pprint

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

otp = 'otp_example' # str | Customer's OTP
reference = 'reference_example' # str | The reference of the ongoing transaction

# Submit OTP

response = paystack.Charge.submit_otp(
    otp,
    reference,
)

pprint(response)
```
### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **otp** | **str**| Customer's OTP | 
 **reference** | **str**| The reference of the ongoing transaction | 

### Return type

[**Response**](Response.md)

### Authorization

[bearerAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **submit_phone**
> Response submit_phone(phone, reference)

Submit Phone

### Example

* Bearer Authentication (bearerAuth):
```python
import paystack
from pprint import pprint

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

phone = 'phone_example' # str | Customer's mobile number
reference = 'reference_example' # str | The reference of the ongoing transaction

# Submit Phone

response = paystack.Charge.submit_phone(
    phone,
    reference,
)

pprint(response)
```
### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **phone** | **str**| Customer's mobile number | 
 **reference** | **str**| The reference of the ongoing transaction | 

### Return type

[**Response**](Response.md)

### Authorization

[bearerAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **submit_pin**
> Response submit_pin(pin, reference)

Submit PIN

### Example

* Bearer Authentication (bearerAuth):
```python
import paystack
from pprint import pprint

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

pin = 'pin_example' # str | Customer's PIN
reference = 'reference_example' # str | Transaction reference that requires the PIN

# Submit PIN

response = paystack.Charge.submit_pin(
    pin,
    reference,
)

pprint(response)
```
### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **pin** | **str**| Customer's PIN | 
 **reference** | **str**| Transaction reference that requires the PIN | 

### Return type

[**Response**](Response.md)

### Authorization

[bearerAuth](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)