---
title: "Payment Method"
method: GET
path: "/v3.0/payment-methods/{slug}/"
tags: ["payment-methods"]
---

# Payment Method

`GET /v3.0/payment-methods/{slug}/`

## Request

- Base URL: `https://api.formaloo.me`
- URL: `https://api.formaloo.me/v3.0/payment-methods/{slug}/`
- Auth: none declared. Required headers: `x-api-key`

## Path parameters

- `slug` string, required

## Query parameters

- `active` string
- `search` string

## Headers

- `x-api-key` string, required
- `x-workspace` string

## Response `200`

- PaymentMethod
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `title` string: payment method's display name.
  - `name` string: payment method's identifying name.
  - `gateway` 'stripe' | 'paypal' | 'square' | 'razorpay', required
  - `payment_type` 'offline' | 'gateway'
  - `logo` string, uri: payment method's logo.
  - `description` string, nullable: any extra description to show with payment method.
  - `active` boolean: shows whether the method is currently active.
  - `terminal_code` string, nullable: the terminal code needed to connect to the gateway.
  - `merchant_code` string, nullable: the merchant code needed to connect to the gateway.
  - `webhook_id` string, nullable: auto-created webhook's id for the payment methods that need it (e.g. Stripe).
  - `private_key` string, nullable: the private key needed to sign the payment data.
  - `order` integer: shows payment method ordering.

---

[API](https://skmtc.dev/formaloo/apis/formaloo-api-documentation.md) · [All operations](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/revisions/47b268aeb656?raw)