Sign in

v1

latestOpenAPI 3.0.12026-07-14134373.9 KB
Payment Service

Retrieve payment methods

Returns a list of available payment methods, along with their corresponding fees.

post/payment/paymentMethods

Request body

subscriptionIdstring

Unique subscription identifier used to retrieve stored payment methods. If not provided, only generally available payment methods are returned.

itemKeystring required

Unique item key used to determine the applicable payment methods and fees.

amountnumber required

Payment amount used to determine the applicable fees for various payment methods.

Example request

{
  "amount": 25.5
}

Response

Retrieved payment methods successfully.

environment'test' | 'prod'

Payment environment.

Example response

{
  "environment": "test",
  "paymentMethods": [
    {
      "name": "Credit Card",
      "type": "creditcard",
      "totalAmount": 10.35,
      "fee": {
        "amount": 1.25
      }
    }
  ],
  "storedPaymentMethods": [
    {
      "name": "Visa ending in 1234",
      "type": "creditcard",
      "totalAmount": 10.35,
      "fee": {
        "amount": 1.25
      }
    }
  ]
}