PeachPayments Partner Pydantic library contains Pydantic schemas to help integrate PeachPayments with their partners.
Project description
PeachPayments Partner Pydantic Library
Overview
PeachPayments Partner Pydantic Library is a platform-agnostic Python package to help Payment Service Providers in integrating with PeachPayments. This library provides functionality to validate request and response data using Pydantic Python library.
Source Code: https://gitlab.com/peachpayments/peach-partner-pydantic/
Key terms
Term | Definition |
---|---|
Partner API | A service provided by Peach Payments to enable Payment Service Providers to become available on the Peach Platform |
Payment Service Provider | A payment service provider who integrates with the Partner API |
Outbound API call | API calls sent from Partner API to the Payment Service Provider |
Inbound API call | API calls sent from Payment Service Provider to Partner API |
Usage
Package requires Python 3.9+
Installation
# pip
$ pip3 install peachpayments-partner-pydantic
# poetry
$ poetry add peachpayments-partner-pydantic
Field validation
Scenario: Payment Service Provider written in FastAPI receives a debit request from PeachPayments.
# ... imports
from peachpayments_partner_pydantic.schemas import DebitRequest, DebitResponse
@router.post(
"/v1/debit",
response_model=schemas.DebitResponse,
)
def debit_request(
*, debit_in: schemas.DebitRequest
) -> Any:
# Store the transaction
transaction = Transaction.create_from_debit(debit_in)
# Validate the debit response
debit_response = DebitResponse(**transaction.to_debit_response_fields())
return debit_response.dict()
Translating exception to PeachPayments error response
Scenario: Payment Service Provider written in FastAPI receives a request with a validation error from PeachPayments.
1. Write validation exception handler
# app/exception_handlers.py
from fastapi import Request, status
from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse
from peachpayments_partner_pydantic.exception_handlers import exception_to_response
async def validation_exception_handler(request: Request, exc: RequestValidationError) -> JSONResponse:
return JSONResponse(status_code=status.HTTP_400_BAD_REQUEST, content=exception_to_response(exc))
2. Connect it to the application
# app/main.py
from fastapi import FastAPI
from fastapi.exceptions import RequestValidationError
from app.exception_handlers import validation_exception_handler
application = FastAPI(
exception_handlers={RequestValidationError: validation_exception_handler},
)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for peachpayments-partner-pydantic-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25cb630caa38ce01b076aa3e06914971b772bb01c4e11c984c57890ae6d1add2 |
|
MD5 | 1284d352eb509f2df0a9c328fc98a32c |
|
BLAKE2b-256 | 7b14feb21190c8448b7f3eb45bd15cf04a2767c22c8f3ec9ea89f3b284e4fdae |
Hashes for peachpayments_partner_pydantic-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0cf429e86c271fae4d399cd6768167d945aaef087c7d956d989b84eed0117af |
|
MD5 | cbadf079a6ed77c75aca42bc9f06eb79 |
|
BLAKE2b-256 | 105a8ffcce7fbf012f97f057ef4cb71f3942e6da6c4e1e95b2b5ee918190cd45 |