List payment methods

{
  "data": [
    {
      "created_at": "2024-03-20T12:00:00Z",
      "updated_at": "2024-03-20T12:00:00Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "payee_id": "987e6543-c21b-43a5-a987-654321098765",
      "account_last_four": "7890",
      "routing_number": "021000021",
      "currency_code": "USD",
      "country_code": "US",
      "verification_status": "verified",
      "is_default": true,
      "supported_rails": [
        "instant_bank",
        "same_day_ach",
        "standard_ach",
        "wire"
      ]
    },
    {
      "created_at": "2024-03-20T12:00:00Z",
      "updated_at": "2024-03-20T12:00:00Z",
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "payee_id": "987e6543-c21b-43a5-a987-654321098765",
      "card_last_four": "1111",
      "card_expiry_date": "2512",
      "currency_code": "USD",
      "country_code": "US",
      "is_default": false,
      "supported_rails": [
        "instant_card"
      ],
      "verification_status": "verified"
    }
  ],
  "has_more": false,
  "total_count": 2
}

Retrieves a paginated list of all payment methods for a specific payee.

Success Responses

Status Code	Description
200	OK - The list of payment methods was successfully retrieved

Error Responses

Status Code	Error Code	Description
400	VALIDATION_ERROR	The provided query parameters failed validation
401	AUTHENTICATION_ERROR	Authentication credentials are invalid or missing
403	AUTHORIZATION_ERROR	You do not have permission to perform this action
404	NOT_FOUND	The specified payee was not found

Retrieves a paginated list of all payment methods for a specific payee. **Success Responses** | Status Code | Description | |-------------|-------------| | 200 | OK - The list of payment methods was successfully retrieved | **Error Responses** | Status Code | Error Code | Description | |-------------|------------|-------------| | 400 | VALIDATION_ERROR | The provided query parameters failed validation | | 401 | AUTHENTICATION_ERROR | Authentication credentials are invalid or missing | | 403 | AUTHORIZATION_ERROR | You do not have permission to perform this action | | 404 | NOT_FOUND | The specified payee was not found |

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Path parameters

payee_idstringRequiredformat: "uuid"

Query parameters

cursorstring or nullOptional

Cursor for pagination. Use the next_cursor from the previous response to get the next page.

limitinteger or nullOptional10-500Defaults to 50

Number of items to return per page. Maximum is 500.

orderenum or nullOptionalDefaults to desc

Sort order by created_at: ‘asc’ for oldest first, ‘desc’ for newest first (default: ‘desc’)

Allowed values:

Response

List of payment methods retrieved successfully

datalist of objects

has_moreboolean

total_countinteger or null>=0Defaults to 0

next_cursorstring or null

previous_cursorstring or null

$	curl https://api.useroot.com/api/payees/payee_id/payment-methods \
>	-H "x-api-key: <apiKey>"