Enjoy a buttery smooth developer experience with 21 SDK methods
Parameter
refererstringrequired
An allowlisted domain for the merchant.
authentication.entityIdstringrequired
signaturestringrequired
merchantTransactionIdstringrequired
amountstringrequired
paymentTypestringrequired
currencystringrequired
noncestringrequired
shopperResultUrlstringrequired
defaultPaymentMethodstring
forceDefaultMethodstring
merchantInvoiceIdstring
cancelUrlstring
notificationUrlstring
customParameters[name]string
customer.merchantCustomerIdstring
customer.givenNamestring
customer.surnamestring
customer.mobilestring
customer.emailstring
customer.statusstring
customer.birthDatestring
customer.ipstring
customer.phonestring
customer.idNumberstring
billing.street1string
billing.street2string
billing.citystring
billing.companystring
billing.countrystring
billing.statestring
billing.postcodestring
shipping.street1string
shipping.street2string
shipping.citystring
shipping.companystring
shipping.postcodestring
shipping.countrystring
shipping.statestring
cart.taxstring
cart.shippingAmountstring
cart.discountstring
createRegistrationstring
originatorstring
returnTostring
Response
201
400
Invalid authentication information.
500
Internal server error.
Endpoint
post
/checkout/initiate
Parameter
refererstringrequired
An allowlisted domain for the merchant.
authentication.entityIdstringrequired
signaturestringrequired
merchantTransactionIdstringrequired
amountstringrequired
paymentTypestringrequired
currencystringrequired
noncestringrequired
shopperResultUrlstringrequired
defaultPaymentMethodstring
forceDefaultMethodstring
merchantInvoiceIdstring
cancelUrlstring
notificationUrlstring
customParameters[name]string
customer.merchantCustomerIdstring
customer.givenNamestring
customer.surnamestring
customer.mobilestring
customer.emailstring
customer.statusstring
customer.birthDatestring
customer.ipstring
customer.phonestring
customer.idNumberstring
billing.street1string
billing.street2string
billing.citystring
billing.companystring
billing.countrystring
billing.statestring
billing.postcodestring
shipping.street1string
shipping.street2string
shipping.citystring
shipping.companystring
shipping.postcodestring
shipping.countrystring
shipping.statestring
cart.taxstring
cart.shippingAmountstring
cart.discountstring
createRegistrationstring
originatorstring
returnTostring
Response
200
The checkout frontend HTML page.
400
An error page detailing the error that has occured.
500
Internal server error.
Endpoint
post
/checkout
Parameter
refererstringrequired
An allowlisted domain for the merchant.
authentication.entityIdstringrequired
signaturestringrequired
merchantTransactionIdstringrequired
amountstringrequired
paymentTypestringrequired
currencystringrequired
noncestringrequired
shopperResultUrlstringrequired
defaultPaymentMethodstring
forceDefaultMethodstring
merchantInvoiceIdstring
cancelUrlstring
notificationUrlstring
customParameters[name]string
customer.merchantCustomerIdstring
customer.givenNamestring
customer.surnamestring
customer.mobilestring
customer.emailstring
customer.statusstring
customer.birthDatestring
customer.ipstring
customer.phonestring
customer.idNumberstring
billing.street1string
billing.street2string
billing.citystring
billing.companystring
billing.countrystring
billing.statestring
billing.postcodestring
shipping.street1string
shipping.street2string
shipping.citystring
shipping.companystring
shipping.postcodestring
shipping.countrystring
shipping.statestring
cart.taxstring
cart.shippingAmountstring
cart.discountstring
createRegistrationstring
originatorstring
returnTostring
Response
200
400
500
Internal server error.
Endpoint
post
/checkout/validate
Parameter
authenticationEntityIdstringrequired
Merchant's entity ID.
checkoutIdstring
Checkout ID.
merchantTransactionIdstring
Merchant transaction ID.
signaturestringrequired
Signature of data signed with secret key of merchant.
Response
200
400
500
Internal server error.
Endpoint
get
/status
Parameter
authentication.entityIdstringrequired
signaturestringrequired
currencystringrequired
Response
200
Request processed successfully.
400
Invalid authentication information.
500
Internal server error.
Endpoint
post
/merchant_specs
Parameter
refererstringrequired
An allowlisted domain for the merchant.
authentication.entityIdstringrequired
merchantTransactionIdstringrequired
amountnumberrequired
currencystringrequired
noncestringrequired
shopperResultUrlstringrequired
defaultPaymentMethodstring
forceDefaultMethodboolean
merchantInvoiceIdstring
cancelUrlstring
notificationUrlstring
customParametersobject
customerobject
billingobject
shippingobject
createRegistrationboolean
originatorstring
returnTostring
Response
200
400
401
404
500
Endpoint
post
/v2/checkout
How Konfig Works
Konfig collects APIs and automatically generates SDKs so you can focus on building your application.
Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository
We pull OpenAPI Specifications from public sources, fix any errors, and make sure they pass our lint rules. We continually make sure the repository is up-to-date and collect up-time and response time metrics for every API.
Generates AI-Augmented SDKs from openapi-examples
Our SDK generator is trusted by growing API companies and goes through a rigorous testing process to ensure the generated SDKs are high-quality and easy to use.
Publishes to standard package managers
We publish to standard package managers like npm, PyPI, and Maven so you can easily integrate the SDK into your application.
About Peach Payments
Peach Payments enables Simple, Seamless and Secure transactions for business and consumers in Africa. We provide our customers with all the tools and solutions they need to sell across any digital channel while ensuring a safe experience for them and their customers.
Customer service is a core part of our DNA and it is our mission to ensure that our customers are happy as they grow from their first transaction past their millionth
Peach Payments currently powers businesses in South Africa, Kenya and Mauritius.
Keywords
payments
africa
financial_technology
fintech
e_commerce
Start integrating Peach Payments's API with Konfig