getAccountById

Get one payment account object by its identifier 🔐 This method requires authorization.

Payments.getAccountById(id)

const value = await Payments.getAccountById(1764)

Schema

id:* number
Identifier of the retrieved payment account object
example: 1764

This method get a single payment account object by its identifier. It returns a Promise that resolves to a payment account object.

Example return:

{
  "id": 2,
  "localizeInfos": {
    "title": "Stripe"
  },
  "identifier": "stripe",
  "type": "stripe",
  "isVisible": true
}

Schema

id: number
object identifier
example: 1764

updatedDate: string
object modification date

version: number
object modification version number
example: 10

identifier: string
text identifier for the recording field
example: catalog

localizeInfos: Record<string, any>
json description of the main page data object taking into account the language "en_US" (for example)
example:

{
  "title": "Catalog",
  "plainContent": "Content for catalog",
  "htmlContent": "<b>Content for catalog</b>",
  "menuTitle": "Catalog"
}

type: string
type may be 'stripe', 'paypal' or 'custom'
example: stripe

isVisible: boolean
visibility indicator of the payment account
example: true