v1

latestOpenAPI 3.0.02026-07-14121153292.2 KB
account

Get the available payment methods under an account.

get/account/billing/methods

Query parameters

ffstring[]

The set of opt in feature flags which cause breaking changes to responses.

While Rocket APIs look to avoid breaking changes under the active major version, the formats of responses may need to evolve over this time.

These feature flags allow clients to select which response formats they expect and avoid breaking clients as these formats evolve under the current major version.

Flags

  • all - Enable all flags. Useful for testing. Don't use in production.
  • idp - Dynamic item detail pages with schedulable rows.
  • ldp - Dynamic list detail pages with schedulable rows.
  • hb - Hubble formatted image urls.
  • rpt - Updated resume point threshold logic.
  • cas - "Custom Asset Search", inlcude customAssets in search results.
  • lrl - Do not pre-populate related list if more than max_list_prefetch down the page.
  • cd - Custom Destination support.

See the feature-flags.md for available flag details.

langstring

Language code for the preferred language to be returned in the response.

Parameter value is case-insensitive and should be

  • a valid 2 letter language code without region such as en, de
  • or with region such as en_us, en_au

If undefined then defaults to 'en', unless the server has been configured with a custom default.

See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

Response

The list of available payment methods.

balancenumber float

The balance of the wallet if the payment method is a wallet.

brand'Visa' | 'MasterCard' | 'AmericanExpress' | 'Other'

The brand of the card if the payment method is a card.

currencystring

The currency code of the wallet if the payment method is a wallet.

descriptionstring required

A short description of a payment method.

If the payment method is of type Wallet this will be "My Wallet"

For Card type payment methods the format of this description may differ depending on the payment gateway in use. In the case of Stripe, this will be in the format "Visa (**** 4242, exp 08/19)"

expiryMonthnumber

The expiry month of the card if the payment method is a card.

expiryYearnumber

The expiry year of the card if the payment method is a card.

idstring required

The unique identifier of a payment method.

lastDigitsnumber

The last digits of the card if the payment method is a card. Depending on the payment gateway in use this value may be undefined.

type'Card' | 'Wallet' required

The type of payment method.