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 Enrollment.

Tutorial

If you choose to implement the Merchant Signup enrollment model, see Merchant Signup.

API Operations

API Call Method Endpoint

Render a Payment Iframe for Merchant Signup

POST

/v1/payment/render
 

Sign up a Merchant from within your Application

POST

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

Authorize a Merchant who Signed up via Merchant Portal

POST

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

Register a Merchant as Part of a Bulk Postage Account

POST

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

Get All Merchants

GET

/v1/developers/{developerId}/merchants
 

Get Account Balances

GET

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

Get Refill Settings

GET

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

Update Refill Settings

POST

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

Deactivate a Merchant

POST

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