Class PaymentMethods

Returns a list of Payment Methods. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.paymentMethods.list({
  bearer_token: '7381273269536713689562374856'
})

Returns a single Payment Method by its ID. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.paymentMethods.show({
  bearer_token: '7381273269536713689562374856'
  id: '1'
})

Creates a new Payment Method and returns its attributes. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.paymentMethods.create({
  bearer_token: '7381273269536713689562374856',
  payment_method: {
    name: 'Test Payment Method',
    active: true,
    auto_capture: true,
    description: 'This is a test payment method',
    type: 'Spree::Gateway::Bogus',
    display_on: 'both',
    store_ids: ['2'],
    public_metadata: {},
    private_metadata: {}
  }
})

Update selected Payment Method. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.paymentMethods.update({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  payment_method: {
    name: 'Test Payment Method',
    active: true,
    auto_capture: true,
    description: 'This is a test payment method',
    type: 'Spree::Gateway::Bogus',
    display_on: 'both',
    store_ids: ['2'],
    public_metadata: {},
    private_metadata: {}
  }
})

This endpoint removes the specified Payment Method. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.paymentMethods.remove({
  bearer_token: '7381273269536713689562374856',
  id: '1'
})