List payment methods

v4 API

This page documents the v4 API (https://www.transdirect.com.au/api), the existing API — fully supported. For new integrations, prefer the v5 typed SDK. New to Transdirect? See v4 vs v5 — which should I use?.

Returns the saved payment methods on your account. Use this to obtain the identifier you pass when charging a booking to a card or PayPal agreement — see how payments work.

Endpoint

GET https://www.transdirect.com.au/api/members/payment-methods

The same path is served on v5 (https://api.transdirect.com.au). The v5 response omits the card_id / agreement_id fields below — it exposes only the opaque id, by design, because v5 accepts that opaque id directly wherever a payment method is needed and never asks you for a raw one.

Authentication

Send your API key in the Api-Key header. No other authentication is required, and nothing needs to be enabled on your account to call this endpoint.

Example request

curl -H "Api-key: YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://www.transdirect.com.au/api/members/payment-methods

Example response

[
  {
    "id": "nab_123",
    "type": "credit_card",
    "card_id": 123,
    "masked_label": "Visa ending 4242",
    "is_default": false
  },
  {
    "id": "paypal_456",
    "type": "paypal",
    "agreement_id": 456,
    "masked_label": "PayPal (billing@example.com.au)",
    "is_default": true
  }
]

Alias

GET /api/v4/members/me/cards serves this same response. It exists for integrations that were given that path previously — prefer /api/members/payment-methods for new work.

Response fields

Field	Type	Description
id	string	The identifier to pass as payment_method when creating a booking. Always prefixed nab_ (saved card) or paypal_ (billing agreement).
type	string	credit_card or paypal.
card_id	integer	v4 only. Cards only. The raw id for the legacy payment.card_id field, so you don’t have to strip the nab_ prefix yourself. Not needed if you use payment_method.
agreement_id	integer	v4 only. PayPal only. The raw id for the legacy payment.agreement_id field.
masked_label	string	Human-readable label safe to display to end users, e.g. Visa ending 4242. Never contains full card details.
is_default	boolean	Whether this method is flagged as the account default.

An empty array means you have no saved payment methods. If you also have no credit account, live bookings will be refused with 403 NO_PAYMENT_METHOD — see how payments work.

Using the id

Pass the id verbatim as payment_method to create and confirm in one call:

{ "payment_method": "nab_123", "courier": "allied", "pickup_date": "2025-08-18" }

Or split the numeric part out to pay at confirm time:

{ "payment": { "method": "card", "card_id": 123 } }

nab_<id> maps to { "method": "card", "card_id": <id> }, and paypal_<id> to { "method": "paypal", "agreement_id": <id> } — or just read card_id / agreement_id straight off the response and skip the conversion.

Always read the id from this endpoint

Do not hard-code an id, and do not copy one out of the members area. This endpoint only returns active methods, and a method that was replaced or removed can still appear as the default in the billing screens while no longer being chargeable. Passing an id that isn’t in this response fails with 400 Payment method not found or unavailable.

For the same reason, is_default can be false on every method returned. Treat the default as a display hint, not a guaranteed selection — if you want to pick automatically, fall back to the first result when nothing is flagged default.

Errors

Status code	Meaning
401	Missing or invalid API key.
429	Rate limit exceeded — see rate limits.

Next steps

• How payments work — which payment routes exist and which applies to you
• Create a booking — create and confirm in one call
• Confirm a booking — pay at confirm time