Skip to main content

Bread Pay

Quick Start
  1. Sign up at breadpayments.com and obtain API credentials
  2. Create a terminal in the Admin Console with the parameters below
  3. Start processing — the adapter is pre-built and ready to use

Go to Bread Pay →

Overview

Breadpay — Installment for buyers

Provider IDbreadpay
CategoryBuy Now, Pay Later
Websitebreadpayments.com

Supported operations: Create Cart (payments_authorize) Get Transaction (payments_status) Refund (refund)


Authentication

Method: Basic Auth (api_key:api_secret)
Header format:

Authorization: Basic {base64(api_key:api_secret)}

Example:

import base64

api_key = "api_abc123"
api_secret = "secret_xyz789"
credentials = f"{api_key}:{api_secret}"
encoded = base64.b64encode(credentials.encode()).decode()

# Authorization: Basic {encoded}

Configuration

Required Parameters

ParameterDescription
base_urlBase API URL
api_keyAPI Key
api_secretAPI Secret
callback_urlURL for webhooks (optional)

Status Mapping

Provider Status4pay StatusDescription
PENDINGProcessingTransaction processing
AUTHORIZEDAuthorizedApproved, but not completed
SETTLEDChargedTransaction completed
CANCELEDVoidedTransaction cancelled
REFUNDEDRefundedFunds returned
EXPIREDFailureExpired
succeededRefunded
failedFailure
(other)PartiallyRefunded

API Reference

MethodEndpointDescription
POST/carts
GET/transactions/{id}
POST/transactions/actions/{id}

Resources