Manually Refill Postage Account

HTTP Request

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

Summary

This operation lets a merchant manually add funds to a PB Postage Account. The operation performs a one-time refill, separate from the automatic refill process. The manual refill uses the payment method on file.

Note: Merchants can also perform manual refill through the Merchant Portal.

See also:

Request URIs

Sandbox: https://api-sandbox.pitneybowes.com/shippingservices/v1/developers/{developerId}/merchants/{postalReportingNumber}/account/fund
Production: https://api.pitneybowes.com/shippingservices/v1/developers/{developerId}/merchants/{postalReportingNumber}/account/fund

Request Headers

Name Description
Authorization Required. OAuth token generated using the Generate an OAuth Token API.
Content-Type Required. The media type of the request entity. Set this to application/json.
X-PB-TransactionId

Required. A unique identifier for the transaction, up to 25 characters.

Important: You must ensure this is a unique id.

X-PB-UnifiedErrorStructure (new)
Recommended. Set this to true to use the standard error object if an error occurs.

Request / Response Elements

Name Data Type Description
amount integer Required. The amount to add to the merchant’s PB Postage Account. You must enter the amount as an integer.
currencyCode String Required. ISO Currency Code. Currently supported currency code: USD

Sample Request

curl -X POST .../v1/developers/<developer_id>/merchants/<postal_reporting_number>/account/fund \
–H "Authorization: Bearer <oauth_token>" \
-H "Content-Type: application/json" \
-H "X-PB-TransactionId: 2805501872" \
-H "isErrorUnified: true" \
-d '
{
    "amount": 500,
    "currencyCode": "USD"
}'

Sample Response

{
    "amount": 500,
    "currencyCode": "USD"
}

Error Codes

For a list of all PB Complete Shipping APIs error codes, see Error Codes.