Skip to main content

getAccounts

Get all payment accounts as an array.

Description​

Fetches the payment accounts configured in the project. Resolves to an array of IAccountsEntity objects.

.getAccounts();

Examples​

Minimal example​

const response = await Payments.getAccounts();

Example response​

[
  {
    "id": 3,
    "identifier": "stripe",
    "isVisible": true,
    "localizeInfos": {
      "title": "Stripe"
    },
    "type": "stripe",
    "isUsed": true,
    "testMode": true,
    "settings": {
      "status": "not_connected"
    },
    "testSettings": {
      "status": "connected",
      "cancelUrl": "https://your-project.oneentry.cloud/",
      "successUrl": "https://your-project.oneentry.cloud/",
      "sessionTimeout": 15,
      "stripeAccountId": "acct_...",
      "signingSecretKey": "whsec_...",
      "stripeRedirectUrl": "https://connect.stripe.com/setup/s/acct_.../...",
      "stripePublishableKey": "pk_test_...",
      "useWebHookValidation": true,
      "stripeOnboardingComplete": true
    },
    "updatedDate": "2025-02-26T13:04:12.806Z"
  },
  {
    "id": 2,
    "identifier": "paypal",
    "isVisible": true,
    "localizeInfos": {
      "title": "PayPal"
    },
    "type": "custom",
    "isUsed": true,
    "testMode": true,
    "settings": {
      "status": "connected"
    },
    "testSettings": {
      "status": "connected"
    },
    "updatedDate": "2025-02-25T08:56:32.384Z"
  },
  {
    "id": 1,
    "identifier": "cash",
    "isVisible": true,
    "localizeInfos": {
      "title": "Cash"
    },
    "type": "custom",
    "isUsed": true,
    "testMode": true,
    "settings": {
      "status": "connected"
    },
    "testSettings": {
      "status": "connected"
    },
    "updatedDate": "2025-02-25T08:55:43.957Z"
  }
]

Response schema​

Schema: IAccountsEntity[]

id: number
Object ID.
example: 12345

localizeInfos: ILocalizeInfo
Localized name and description of the payment account.

identifier: string
Marker of the payment account.
example: "payment_12345"

type: 'stripe' | 'yookassa' | 'midtrans' | 'xendit' | 'custom'
Payment provider type.
example: 'stripe'

isVisible: boolean
Whether the payment account is visible.
example: true

isUsed: boolean
Whether the payment account is in use.
example: false

testMode: boolean
Whether the payment account is in test mode.
example: true

settings: IPaymentAccountSettings
Payment account settings.
example:

{ "status": "connected" }

settings.status: string
Connection status of the live (non-test) payment account.
example: "connected"

testSettings: object
Test mode settings for the payment account.

updatedDate: string
Date the object was last modified.
example: "2025-02-26T10:13:16.839Z"