# Payments APIs

The Payment APIs include a variety of operations that allow users to manage payment methods, refill wallet and balance check of accounts.

Version: 1.0.0

## Servers

```
https://api-dev.sendpro360.pitneycloud.com/shippingpaymentmgmt
```

```
https://api-qa.sendpro360.pitneycloud.com/shippingpaymentmgmt
```

Sandbox Server
```
https://api-sandbox.sendpro360.pitneybowes.com/shippingpaymentmgmt
```

Production Server (uses live data)
```
https://api.sendpro360.pitneybowes.com/shippingpaymentmgmt
```

Sandbox Server for Canada
```
https://api-ppd.shipping360.pitneybowes.com/ca/shippingpaymentmgmt
```

Production Server for Canada
```
https://api.shipping360.pitneybowes.com/ca/shippingpaymentmgmt
```

## Security

### basicAuth

Type: http
Scheme: basic

### bearerAuth

Type: http
Scheme: bearer

## Download OpenAPI description

[Payments APIs](https://docs.sendpro360.pitneycloud.com/_bundle/openapi/payment.yaml)

## Payment

### Get Payment Methods

 - [GET /api/v1/payments/methods](https://docs.sendpro360.pitneycloud.com/openapi/payment/payment/getpaymentmethods.md): This operation returns all payment methods (Credit Card, Trust Account , Reserve and Purchase Power accounts) associated with the carrier account (USPS)

### Get Payment account balance

 - [GET /api/v1/payments/accounts/balance](https://docs.sendpro360.pitneycloud.com/openapi/payment/payment/getpaymentbalance.md): This operation returns balance of Wallet or PB Bank (GFS payment method) accounts.

### Set rank of payment method

 - [PATCH /api/v1/payments/methods/rank](https://docs.sendpro360.pitneycloud.com/openapi/payment/payment/setpaymentmethodrank.md): This operation sets rank (priority) of payment method for postage refill and subscription billing .

### Set Payment Method Status

 - [PATCH /api/v1/payments/methods/status](https://docs.sendpro360.pitneycloud.com/openapi/payment/payment/setpaymentmethodstatus.md): This operation sets the Payment Method active or inactive.

### Wallet Refill

 - [POST /api/v1/payments/wallet/refill](https://docs.sendpro360.pitneycloud.com/openapi/payment/payment/walletrefill.md): This operation is used to refill amount to the Wallet