Merchant Accounts

Overview

To print labels for your shippers, you must add them as merchants under your developer account. When you add a merchant, the merchant receives a unique Shipper ID that identifies the merchant during transaction requests.

The PB Shipping APIs support two models for handling a merchant’s postage payments. Depending on the payment model you choose, either a merchant pays for postage directly by setting up an individual PB Postage Account directly with Pitney Bowes, or you pay postage on behalf of the merchant by setting up a Bulk Postage Account with Pitney Bowes and billing the merchant separately.

If you choose to have your merchants pay postage directly via their own individual PB Postage Accounts, you can either integrate the setup of individual postage accounts directly into your application or you can navigate your merchants to a PB Merchant Portal signup page where they sign up for their individual postage accounts.

When you add merchants, they have access to print USPS labels by default. The PB Shipping APIs integrate with other carriers as well, and once merchants are enrolled with your developer account, you can register their existing carrier accounts for use with the PB Shipping APIs. For available carriers and onboarding instructions, see the carrier reference pages.

Merchant Enrollment Models

The PB Shipping APIs provide three ways to add merchants to your developer account:

Payment & Signup Models
API Description
Individual Postage Account,
Signup is from within your application
Merchant Signup

Merchants sign up for individual PB Postage Accounts from inside your application. The Merchant Signup API provides operations to securely handle a merchant’s payment details and to create the merchant account.

To implement this approach, see the Merchant Signup Tutorial.

Individual Postage Account,
Signup is through PB Merchant Portal
Authorize a Merchant

Merchants sign up for individual PB Postage Accounts through a PB Merchant Portal signup page specific to your developer account. PB Merchant Portal handles each merchant’s payment details and creates the merchant account.

To implement this approach do the following, as described in Authorize a Merchant who Signed up via Merchant Portal:

  1. Direct merchants to the custom signup URL.
  2. Once a merchant signs up, retrieve the merchant’s Shipper ID.
Bulk Postage Account Register a Merchant

You manage postage funds on behalf of all your merchants through a PB Bulk Postage Account. To provide a merchant with a PB Shipper ID, you register the merchant with Pitney Bowes using the Register a Merchant API.

To set up a Bulk Postage Account, please contact Client Services Tech Support at ClientServicesTechSupport@pb.com.

Shipper ID

Every merchant added to your developer account receives a unique Shipper ID. You use the Shipper ID to identify a merchant when requesting transactions. You can retrieve a merchant’s Shipper ID using the Get All Merchants API. A merchant’s Shipper ID is the value found in the postalReportingNumber field of the returned Merchant Object.

Payment Methods

Pitney Bowes offers the following payment methods for PB Postage Accounts. A given postage account can be funded by only one payment method:

Auto Refill

By default, a PB Postage Account is set up to automatically refill when the balance falls falls below a specified threshold. The refill amount and threshold are set when the account is created. You can change the refill settings at any time. You can also manually refill an account. If desired, you can disable automatic refill. For more information on funding PB Postage Accounts, see Payments FAQs.

Subscription Fee

Pitney Bowes has the option to charge a subscription fee to merchants who have their own PB Postage Accounts, which is the case for merchants onboarded through one of the Individual Postage Account enrollment models. For more information, please contact PaymentsAPISupport@pb.com.

Merchant Portal

Merchants who sign up for their own individual PB Postage Accounts have access to their accounts through the PB Merchant Portal. Pitney Bowes provides separate Merchant Portals for the sandbox and production environments:

Environment Merchant Portal Link
Production https://www.pbshippingmerchant.pitneybowes.com
Sandbox https://developer.pbshippingmerchant.pitneybowes.com

FAQs

See the Merchants FAQs.

API Operations for Merchant Accounts

Use the following APIs to manage merchant accounts:

API
Method Endpoint

Merchant Signup APIs

POST
 
POST

/v1/payment/render
 
/v1/developers/{developerId}/merchants/signup
 

Authorize a Merchant (Retrieve Credentials)

POST

/v1/developers/{developerId}/merchants/credentials
 

Register a Merchant in a Bulk Account

POST

/v2/developers/{developerId}/merchants/registration
 

View Merchant Accounts

GET

/v1/developers/{developerId}/merchants
 

Postage Management APIs

GET
 
POST
 
GET
 
POST

/v1/developers/{developerId}/merchants/{postalReportingNumber}/account-balance
 
/v1/developers/{developerId}/merchants/{postalReportingNumber}/account/fund
 
/v1/developers/{developerId}/merchants/{postalReportingNumber}/autorefillrule
 
/v1/developers/{developerId}/merchants/{postalReportingNumber}/autorefillrule
 

Carrier Registration APIs

GET
 
POST

/v1/carrier/license-agreements?carrier={carrier}&originCountryCode={two-character-ISO-code}
 
/v1/developers/{developerId}/merchants/{postalReportingNumber}/carrier-accounts/register?carrier={carrier}
 

Deactivate a Merchant Account

To deactivate a merchant account, please contact our Payments API Support team at PaymentsAPISupport@pb.com or +1 855 393-8874.