{"items":[{"type":"link","label":"Payments APIs","link":"/openapi/payment","routeSlug":"/openapi/payment","content":{"contentType":"overview","meta":{"name":"Payments APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"payment.json","url":"/_bundle/openapi/payment.json?download"},{"kind":"download","label":"payment.yaml","url":"/_bundle/openapi/payment.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Production Server for Canada"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Payments APIs (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The Payment APIs include a variety of operations that allow users to manage payment methods, refill wallet and balance check of accounts."}],"sectionId":"/openapi/payment"}],"sectionId":"/openapi/payment"}]}]}},{"type":"group","label":"Payment","link":"/openapi/payment/payment","routeSlug":"/openapi/payment/payment","items":[{"label":"Get Payment Methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payment/payment/getpaymentmethods","routeSlug":"/openapi/payment/payment/getpaymentmethods","metadata":{"seo":{"title":"Get Payment Methods","description":"This operation returns all payment methods (Credit Card, Trust Account , Reserve and Purchase Power accounts) associated with the carrier account (USPS)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentMethods","name":"Get Payment Methods","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Payment Methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation returns all payment methods (Credit Card, Trust Account , Reserve and Purchase Power accounts) associated with the carrier account (USPS)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"carrierAccountId","in":"query","schemaId":"schema_312","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier assigned to the specific carrier account. Its value can be referred from the response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Carrier Accounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v1~1payments~1methods/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_312","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1payments~1methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/payments/methods","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"carrierAccountId","in":"query","required":true,"schemaId":"schema_312"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_312"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/payments/methods","href":"payment/getpaymentmethods","openApiOperationId":"getPaymentMethods","summary":"Get Payment Methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The available payment methods returned successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/paymentmethods"}},"schemaId":"components/schemas/paymentmethods","headers":{"X-Pb-Transactionid":{"description":"The X-PB-TransactionId is unique id for this request.","schema":{"type":"string"}}},"headerSchemaId":"schema_313"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1payments~1methods/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/paymentmethods","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/paymentmethods"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/getpaymentmethods"}],"panels":[]}]},"httpPath":"/api/v1/payments/methods"},{"label":"Get Payment account balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payment/payment/getpaymentbalance","routeSlug":"/openapi/payment/payment/getpaymentbalance","metadata":{"seo":{"title":"Get Payment account balance","description":"This operation returns balance of Wallet or PB Bank (GFS payment method) accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentBalance","name":"Get Payment account balance","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1accounts~1balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Payment account balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation returns balance of Wallet or PB Bank (GFS payment method) accounts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"accountType","in":"query","schemaId":"schema_314","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An identifier to get balance of Wallet or PB Bank. It accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WALLET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for fetching postage balance and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PBBANK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for fetching GFS balance."},"children":[]}]}]}],"required":true},{"name":"carrierAccountId","in":"query","schemaId":"schema_312","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier assigned to the specific carrier account. Its value can be referred from the response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Carrier Accounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API. It is required when accountType is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WALLET"},"children":[]}]}]}]},{"name":"locationId","in":"query","schemaId":"schema_312","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It specifies the Location Id on which GFS payment method is associated. Its value can be refered from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Location Details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API. It is required when accountType is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PBBANK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1payments~1accounts~1balance/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_312","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1payments~1accounts~1balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/payments/accounts/balance","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"accountType","in":"query","required":true,"schemaId":"schema_314"},{"name":"carrierAccountId","in":"query","schemaId":"schema_312"},{"name":"locationId","in":"query","schemaId":"schema_312"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_312"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/payments/accounts/balance","href":"payment/getpaymentbalance","openApiOperationId":"getPaymentBalance","summary":"Get Payment account balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns account balance","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/balanceResponse"}},"schemaId":"components/schemas/balanceResponse","headers":{"X-Pb-Transactionid":{"description":"The X-PB-TransactionId is unique id for this request.","schema":{"type":"string"}}},"headerSchemaId":"schema_313"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1payments~1accounts~1balance/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/balanceResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/balanceResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/getpaymentbalance"}],"panels":[]}]},"httpPath":"/api/v1/payments/accounts/balance"},{"label":"Set rank of payment method","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payment/payment/setpaymentmethodrank","routeSlug":"/openapi/payment/payment/setpaymentmethodrank","metadata":{"seo":{"title":"Set rank of payment method","description":"This operation sets rank (priority) of payment method for postage refill and subscription billing ."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setPaymentMethodRank","name":"Set rank of payment method","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1methods~1rank/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set rank of payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation sets rank (priority) of payment method for postage refill and subscription billing ."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_312","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1payments~1methods~1rank/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_315","exampleIds":["paths/~1api~1v1~1payments~1methods~1rank/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_315","exampleIds":["paths/~1api~1v1~1payments~1methods~1rank/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1payments~1methods~1rank/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/payments/methods/rank","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_312"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_315","exampleIds":["paths/~1api~1v1~1payments~1methods~1rank/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/payments/methods/rank","href":"payment/setpaymentmethodrank","openApiOperationId":"setPaymentMethodRank","summary":"Set rank of payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Production Server for Canada"}],"schemaId":"schema_315","exampleIds":["paths/~1api~1v1~1payments~1methods~1rank/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_315","exampleIds":["paths/~1api~1v1~1payments~1methods~1rank/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated rank of Payment Method"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1payments~1methods~1rank/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/setpaymentmethodrank"}],"panels":[]}]},"httpPath":"/api/v1/payments/methods/rank"},{"label":"Set Payment Method Status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payment/payment/setpaymentmethodstatus","routeSlug":"/openapi/payment/payment/setpaymentmethodstatus","metadata":{"seo":{"title":"Set Payment Method Status","description":"This operation sets the Payment Method active or inactive."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setPaymentMethodStatus","name":"Set Payment Method Status","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1methods~1status/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set Payment Method Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation sets the Payment Method active or inactive."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_312","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1payments~1methods~1status/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_316"}},"schemaId":"schema_316","pointer":"/paths/~1api~1v1~1payments~1methods~1status/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/payments/methods/status","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_312"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_316"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/payments/methods/status","href":"payment/setpaymentmethodstatus","openApiOperationId":"setPaymentMethodStatus","summary":"Set Payment Method Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Production Server for Canada"}],"schemaId":"schema_316","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_316"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Set Payment Method Status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Empty"}},"schemaId":"components/schemas/Empty"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1payments~1methods~1status/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Empty","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Empty"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/setpaymentmethodstatus"}],"panels":[]}]},"httpPath":"/api/v1/payments/methods/status"},{"label":"Wallet Refill","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payment/payment/walletrefill","routeSlug":"/openapi/payment/payment/walletrefill","metadata":{"seo":{"title":"Wallet Refill","description":"This operation is used to refill amount to the Wallet"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"walletRefill","name":"Wallet Refill","isWebhook":false,"pointer":"/paths/~1api~1v1~1payments~1wallet~1refill/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Wallet Refill","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation is used to refill amount to the Wallet"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_312","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1payments~1wallet~1refill/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_317"}},"schemaId":"schema_317","pointer":"/paths/~1api~1v1~1payments~1wallet~1refill/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/payments/wallet/refill","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_312"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_317"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/payments/wallet/refill","href":"payment/walletrefill","openApiOperationId":"walletRefill","summary":"Wallet Refill"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Production Server for Canada"}],"schemaId":"schema_317","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_317"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Wallet refill is successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/refillresponse"}},"schemaId":"components/schemas/refillresponse","headers":{"X-PB-TransactionId":{"description":"The X-PB-TransactionId is unique id for this request.","schema":{"type":"string"}}},"headerSchemaId":"schema_318"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1payments~1wallet~1refill/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/refillresponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/refillresponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/walletrefill"}],"panels":[]}]},"httpPath":"/api/v1/payments/wallet/refill"}],"content":{"contentType":"group","meta":{"name":"Payment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/payments/methods","summary":"Get Payment Methods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment/getpaymentmethods","deprecated":false},{"title":"/api/v1/payments/accounts/balance","summary":"Get Payment account balance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment/getpaymentbalance","deprecated":false},{"title":"/api/v1/payments/methods/rank","summary":"Set rank of payment method","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/payment/setpaymentmethodrank","deprecated":false},{"title":"/api/v1/payments/methods/status","summary":"Set Payment Method Status","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/payment/setpaymentmethodstatus","deprecated":false},{"title":"/api/v1/payments/wallet/refill","summary":"Wallet Refill","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/walletrefill","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"type":"object","properties":{"message":{"type":"string","description":"This is HTTP 401 Unauthorized response status code, that indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource."}},"required":["message"]}},"components/schemas/Errors":{"id":"components/schemas/Errors","kind":"json-schema","title":"Errors","data":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code(s) that appear due to HTTP  400- Invalid or Bad Request, e.g. validation-error.","example":"validation_error"},"errorDescription":{"type":"string","description":"The HTTP 400 Bad Request response status code indicates that the server cannot process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","example":"Error while getting rates for carrier with carrierAccount eRMnRx4mzPP."},"additionalCode":{"type":"string","description":"A unique identifier for the error, for example 1101055, 0100008, or 1021126."},"additionalInfo":{"type":"string","description":"This is an additional information about the error. This error 'Invalid Request' might appear due to invalid dimension, weight, or serviceid, or if the information is missing."},"additionalParameters":{"type":"array","items":{"type":"string","description":"The field(s) that might be incorrect in the request."}}}}}},"components/schemas/NotFoundErrors":{"id":"components/schemas/NotFoundErrors","kind":"json-schema","title":"NotFoundErrors","data":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","example":"not_found","description":"Error code(s) that appear due HTTP 404 Page or File not found."},"errorDescription":{"type":"string","example":"resource not found","description":"The HTTP 404 Not Found response status code indicates that the server cannot find the requested resource."},"additionalCode":{"type":"string","description":"A unique identifier for the error, for example 0100025, 1110017, or 1090001."},"additionalInfo":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information about the error. This error 'Not Found' might appear due to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shipment Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No Shipments to close"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Original Transaction not found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"additionalParameters":{"type":"array","items":{"type":"string","description":"The field(s) that might be incorrect in the request."}}}}}},"components/schemas/paymentmethods":{"id":"components/schemas/paymentmethods","kind":"json-schema","title":"paymentmethods","data":{"type":"object","properties":{"paymentMethods":{"type":"array","description":"It provides list of payment methods available","items":{"type":"object","properties":{"accountNumber":{"type":"string","description":"It displays the account number of the specific payment method","example":"1111"},"billingAddress":{"type":"object","description":"It displays the address details associated with payment method","properties":{"addressLine1":{"type":"string","example":"wall2"},"addressLine2":{"type":"string","example":"apartment #2"},"cityTown":{"type":"string","example":"Danbury"},"countryCode":{"type":"string","example":"US"},"postalCode":{"type":"string","example":"12201-7050"},"residential":{"type":"boolean","example":false},"stateProvince":{"type":"string","example":"NY"}}},"createdDate":{"type":"string","description":"It displays the date when payment method was registered","example":"2022-09-15 18:05:30"},"ranks":{"type":"object","description":"It displays the priority set for this payment method while dispense. It shows the numeric value where 1 being the highest priority.","properties":{"postage":{"type":"number","description":"It displays the priority for adding funds to the wallet.","example":1},"subscription":{"type":"number","description":"It displays the priority while renewal of subscription.","example":2}}},"expirationDate":{"type":"string","description":"It displays the expiration of payment method (if applicable).","example":"02/2026"},"paymentMethodCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It displays the payment methods. For example- "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CC_Visa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CC_Master"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CC_Discover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GFS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"CC_Visa"},"paymentMethodDescription":{"type":"string","description":"It displays the description of this payment method.","example":"Visa Card"},"paymentMethodId":{"type":"string","description":"It displays the unique id for this payment method.","example":"1bcf3299-ab63-43bc-9109-18fe60e26136"},"paymentMethodStatus":{"type":"string","description":"It displays the payment method whether Active or Inactive.","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE"}}},"example":[{"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"}]}}}},"components/schemas/balanceResponse":{"id":"components/schemas/balanceResponse","kind":"json-schema","title":"balanceResponse","data":{"type":"object","properties":{"walletAccount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It would show when accountType is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WALLET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request."},"children":[]}]}]}],"properties":{"currency":{"type":"string","description":"It displays the currency code","example":"USD"},"balanceAvailable":{"type":"number","description":"It displays the available balance with this account","example":1000},"pendingBalance":{"type":"number","description":"It displays the pending balance","example":1100}}},"trustAccount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It would display when accountType is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PBBANK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and trust account is available"},"children":[]}]}]}],"properties":{"accountId":{"type":"string","description":"It displays the account id with this account","example":"58545575"},"accountEnabled":{"type":"boolean","description":"It displays if account is enabled.","example":true},"balanceAvailable":{"type":"number","description":"It displays the balance available for this account","example":1100}}},"purchasePowerAccount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It would display when accountType is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PBBANK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and purchase power account is available"},"children":[]}]}]}],"properties":{"accountId":{"type":"string","description":"It displays the account id associated with this account","example":"8000900000242952"},"accountEnabled":{"type":"boolean","description":"It displays if account is enabled","example":true},"creditLimit":{"type":"number","description":"It displays the credit limit for this account","example":500},"availableCredit":{"type":"number","description":"It displays the avaiable credit with this account","example":-25426.5},"balanceCurrent":{"type":"number","description":"It displays the current balance with this account","example":10},"minPayDate":{"type":"string","description":"It displays the min pay date","example":"0000-00-00"},"minPayAmount":{"type":"number","description":"It displays the minimum pay amount","example":10}}},"reserveAccount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It would show when accountType is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PBBANK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request and reserve account is available."},"children":[]}]}]}],"properties":{"accountId":{"type":"string","description":"It displays the account id with this account","example":"58545575"}}}}}},"components/schemas/Empty":{"id":"components/schemas/Empty","kind":"json-schema","title":"Empty Schema","data":{"title":"Empty Schema","type":"object"}},"components/schemas/refillresponse":{"id":"components/schemas/refillresponse","kind":"json-schema","title":"refillresponse","data":{"type":"object","properties":{"requestedAmount":{"type":"number","description":"It displays the amount with which wallet refill is done","example":10},"balanceAvailable":{"type":"number","description":"It displays the available balance","example":3734.8},"totalAmount":{"type":"number","description":"It displays the total amount which deducted from payment method","example":10.35},"status":{"type":"string","description":"It displays the status of the transaction","enum":["SUCCESS","PENDING","FAILED"],"example":"SUCCESS"},"transactionDetails":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"It displays the account Id of the payment method used to refill.","example":"1111"},"accountType":{"type":"string","description":"It displays the account type of the payment method used to refill.","example":"Credit Card"},"amount":{"type":"number","description":"It displays the amount which wallet is credited with.","example":10}}},"example":[{"accountId":"1111","accountType":"Credit Card","amount":10},{"accountId":"1111","accountType":"Credit Card Fees","amount":0.35}]}}}},"schema_312":{"kind":"json-schema","data":{"type":"string"},"id":"schema_312"},"schema_313":{"kind":"json-schema","data":{"type":"object","properties":{"X-Pb-Transactionid":{"type":"string","description":"The X-PB-TransactionId is unique id for this request."}}},"id":"schema_313"},"schema_314":{"kind":"json-schema","data":{"type":"string","enum":["WALLET","PBBANK"]},"id":"schema_314"},"schema_315":{"kind":"json-schema","data":{"type":"object","required":["carrierAccountId","paymentMethodId","paymentMethodRankFor","paymentMethodRank"],"properties":{"carrierAccountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It specifies the unique carrier account id. Its value can be referred from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Carrier Accounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API"},"children":[]}]}]}],"example":"gOpvB5GjV8r"},"paymentMethodId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It specifies the payment method id. Its value can be referred from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Payment Methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}],"example":"4b60dba7-8f01-4f4f-9900-956f1e4cb7bf"},"paymentMethodRankFor":{"type":"string","description":"This is to specify Postage or Subscription rank to be set","enum":["POSTAGE","SUBSCRIPTION"],"example":"POSTAGE"},"paymentMethodRank":{"type":"integer","description":"It specify the rank(priority) for the payment method. It takes numeric value, 1 being the highest priority","example":1}}},"id":"schema_315"},"schema_316":{"kind":"json-schema","data":{"type":"object","required":["carrierAccountId","paymentMethodId","paymentMethodStatus"],"properties":{"carrierAccountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier assigned to the specific carrier account. Its value can be referred from the response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Carrier Accounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}],"example":"gOpvB5GjV8r"},"paymentMethodId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It specifies payment method id. Its value can be referred from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Payment Methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}],"example":"4b60dba7-8f01-4f4f-9900-956f1e4cb7bf"},"paymentMethodStatus":{"type":"string","description":"It specified the status to mark ACTIVE or INACTIVE","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE"}},"example":{"carrierAccountId":"gOpvB5GjV8r","paymentMethodId":"4b60dba7-8f01-4f4f-9900-956f1e4cb7bf","paymentMethodStatus":"ACTIVE"}},"id":"schema_316"},"schema_317":{"kind":"json-schema","data":{"type":"object","required":["carrierAccountId","amount"],"properties":{"carrierAccountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier assigned to the specific carrier account. Its value can be referred from the response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Carrier Accounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}],"example":"gOpvB5GjV8r"},"amount":{"type":"number","description":"It specified the required amount with which wallet is to refill.","example":10},"costAccountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It specified the cost account Id with which this transaction can be associated. Its value can be referred from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Cost Accounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API"},"children":[]}]}]}],"example":"abc"}},"example":{"carrierAccountId":"gOpvB5GjV8r","amount":10}},"id":"schema_317"},"schema_318":{"kind":"json-schema","data":{"type":"object","properties":{"X-PB-TransactionId":{"type":"string","description":"The X-PB-TransactionId is unique id for this request."}}},"id":"schema_318"}},"exampleStore":{"paths/~1api~1v1~1payments~1methods~1rank/patch/requestBody/content/application~1json/example":{"value":{"carrierAccountId":"gOpvB5GjV8r","paymentMethodId":"4b60dba7-8f01-4f4f-9900-956f1e4cb7bf","paymentMethodRankFor":"POSTAGE","paymentMethodRank":1},"id":"paths/~1api~1v1~1payments~1methods~1rank/patch/requestBody/content/application~1json/example"}},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic"},"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shippingpaymentmgmt","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shippingpaymentmgmt","description":"Production Server for Canada"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/payment.json?download"},{"url":"/_bundle/openapi/payment.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Payments APIs","description":"The Payment APIs include a variety of operations that allow users to manage payment methods, refill wallet and balance check of accounts."}},"baseSlug":"/openapi/payment","routesMapping":{}}