Get Payment Methods

This operation returns all payment methods (Credit Card, Trust Account , Reserve and Purchase Power accounts) associated with the carrier account (USPS)

SecuritybearerAuth

Request

query Parameters

carrierAccountId

required

string

A unique identifier assigned to the specific carrier account. Its value can be referred from the response of Get Carrier Accounts API

header Parameters

X-PB-Developer-Partner-ID

string

This is the Developer Partner ID. When the developer is the only partner, this field is not required.

Responses

200

The available payment methods returned successfully

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

get/api/v1/payments/methods

Request samples

Response samples

application/json

{"paymentMethods": [{"accountNumber": "1111",
"billingAddress": {"addressLine1": "wall2",
"cityTown": "Danbury",
"countryCode": "US",
"postalCode": "12201-7050",
"residential": false,
"stateProvince": "NY"
},
"createdDate": "2022-09-15 18:05:30",
"ranks": {"postage": 1
},
"expirationDate": "02/2026",
"paymentMethodCode": "CC_Visa",
"paymentMethodDescription": "Visa Card",
"paymentMethodId": "1bcf3299-ab63-43bc-9109-18fe60e26136",
"paymentMethodStatus": "ACTIVE"
},
{"accountNumber": "9818",
"billingAddress": {"addressLine1": "wall2",
"addressLine2": "apartment #2",
"cityTown": "Danbury",
"countryCode": "US",
"postalCode": "12201-7050",
"residential": false,
"stateProvince": "NY"
},
"createdDate": "2021-08-16 13:13:32",
"ranks": {"postage": 2
},
"expirationDate": "09/2022",
"paymentMethodCode": "CC_Discover",
"paymentMethodDescription": "Discover Card",
"paymentMethodId": "4b60dba7-8f01-4f4f-9900-956f1e4cb7bf",
"paymentMethodStatus": "ACTIVE"
}
]
}