Scope: sales:invoicing-settings.read https://api.alladdin.com/api/v2/payment-methods/{paymentMethodId}

Returns a single configured payment method by its ID. The ID comes from the 'id' field in the list endpoint response. Note: this returns a configured payment method (manual or connected gateway such as Stripe, PayPal, GoCardless, Square, Monei, or Wallet) — not an individual transaction. Use /api/v2/payments/{id} to fetch a specific payment transaction.

Parameters

Path parameters

paymentMethodId string required

Payment method identifier

Request

import requests

url = "https://api.alladdin.com/api/v2/payment-methods/507f1f77bcf86cd799439011"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

{
  "id": "507f1f77bcf86cd799439011",
  "name": "string",
  "type": "manual",
  "status": "connected",
  "isDefault": false,
  "bankingAccountId": "507f1f77bcf86cd799439011",
  "dueDays": 0,
  "connectionId": "507f1f77bcf86cd799439011"
}

Success responses

200 Payment method found application/json object id string required

Unique identifier of the payment method

name string required

Display name of the payment method

type string required

Discriminator for the payment method kind: 'manual' for manually created methods, or the provider slug for connected gateways (stripe, paypal, gocardless, square, monei, wallet)

Enum: manual stripe paypal gocardless square monei wallet status string required

Current status of the payment method: 'connected' means active and usable. Online gateways may also have disconnected, access_denied, verification_required, or verification_in_review.

Enum: connected disconnected access_denied verification_required verification_in_review isDefault boolean required

Whether this method is the account default for online payments

bankingAccountId string | null required

Associated banking account ID, if configured

dueDays integer | null required

Number of days until payment is due (manual methods only)

connectionId string | null required

Gateway connection identifier (online methods only)

Error responses

401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Payment method not found application/json 429 Rate limit exceeded application/json

← PreviousList payment methods →