Get a payment method

{
  "success": true,
  "message": "Payment method retrieved successfully",
  "traceId": "0HNNN6HH5NE0R:00000015",
  "data": {
    "paymentMethodReference": "019ff142-454b-7721-96a3-c8628b9d568f",
    "type": "bank_account",
    "accountOwner": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
    "ownerType": "business",
    "status": "PENDING",
    "createdAt": "2026-08-11T14:38:00.011776",
    "lastUpdated": "2026-08-11T14:38:00.011776",
    "_links": {
      "self": "/api/v2/payment-methods/019ff142-454b-7721-96a3-c8628b9d568f",
      "owner": "/api/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"
    },
    "nickname": "Operating account",
    "financialInstitution": "Bank of Example",
    "accountType": "Checking",
    "accountNumber": "****6789",
    "routingNumber": "*****0021",
    "usage": [
      "deposits",
      "billing"
    ]
  }
}

Retrieves a payment method by reference. Sensitive fields such as the account and routing numbers are masked.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

paymentMethodReferencestringRequired

The payment method reference.

Response

The payment method.

successboolean

Whether the request succeeded.

messagestring or null

A human-readable result message.

traceIdstring or null

The trace identifier for the request, useful for support.

dataobject or null

The payment method detail.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error