Merchants

Overview

You must enroll each of your merchants with your Pitney Bowes developer account to provide each with a unique Shipper ID. Once you enroll a merchant, you can use the merchant’s Shipper ID to print labels and request transactions on the merchant’s behalf. Pitney Bowes provides multiple models for enrolling a merchant, as described in Merchant Accounts.

Tutorial

The Merchant Signup Tutorial describes how to implement the Merchant Signup enrollment model.

API Operations

API Method Endpoint

Merchant Signup API

POST
 
POST

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

Authorize a Merchant who Enrolled via Merchant Portal

POST

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

Register a Merchant as a Known Shipper

POST

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

Get All Merchants

GET

/v1/developers/{developerId}/merchants
 

Get Account Balances

GET

/v1/developers/{developerId}/merchants/{postalReportingNumber}/balance
 

Manually Refill Postage Account

POST

/v1/developers/{developerId}/merchants/{postalReportingNumber}/account/fund

Get Auto Refill Settings

GET

/v1/developers/{developerId}/merchants/{postalReportingNumber}/autorefillrule
 

Update Auto Refill Settings

POST

/v1/developers/{developerId}/merchants/{postalReportingNumber}/autorefillrule
 

Deactivate a Merchant

POST

/v2/developers/{developerId}/accounts/{postalReportingNumber}/deactivate