PeachPayments Partner Pydantic library contains Pydantic schemas to help integrate PeachPayments with their partners.
Reason this release was yanked:
Forcing strict str fields breaks FastAPI middleware
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.1.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | db8a1925defc74686cee0ad2f588220efdfc985519edd93b2a5f5114bc71c461 |
|
MD5 | 91162fb409468205dbe8c98dbd23aa45 |
|
BLAKE2b-256 | bff0f7a54e9ff54c6be141dbe371766acc18fe14075563fb36211b3382a4adc6 |
Hashes for peachpayments_partner_pydantic-0.1.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2dd4312bf3ac53742834af2a06656dfc80a5380a6155b77954b914dcc5020d9 |
|
MD5 | 55e463207f145985dd8ad58c91d7bb9a |
|
BLAKE2b-256 | ab6133c3135ab446e7763e020ab9b3b5f80227245eee723c0f4f75964dfbabd3 |