---
title: "Get list of payment instruments"
method: GET
path: "/v3/payment-instruments"
tags: ["Payments instruments"]
---

# Get list of payment instruments

`GET /v3/payment-instruments`

## Request

- Base URL: `https://api.sandbox.payall.com`
- URL: `https://api.sandbox.payall.com/v3/payment-instruments`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/v2/oauth/token`

## Query parameters

- `recipient_id` string, uuid
- `page_number` integer
- `page_size` integer

## Response `200`

OK

- object
  - `pagination` Pagination
    - `pageNumber` integer
    - `totalPages` integer
    - `totalElements` integer
    - `pageSize` integer
    - `offset` integer
  - `accounts` union[]
    - union
      - MobileWallet: Abstract class. Use it's implementations instead.
        - `id` string, uuid
        - `category` 'BankAccount' | 'MobileWallet' | 'CashPickup' | 'Card', required
        - `currency` string
        - `mobile_number` string, required
        - `phone_operator` string
      - BankAccount: Abstract class. Use it's implementations instead.
        - `id` string, uuid
        - `category` 'BankAccount' | 'MobileWallet' | 'CashPickup' | 'Card', required
        - `currency` string
        - `routing_number` string
        - `swift_bic_code` string
        - `bank_domestic_code` string
        - `iban` string
        - `swift_intermediary` string
        - `routing_number_intermediary` string
        - `iban_intermediary` string
        - `account_id` string
        - `bank_name` string
        - `bank_branch_name` string
        - `bank_branch_code` string
        - `bank_country` string
        - `bank_address` string
        - `account_number` string
        - `sub_account_number` string
        - `account_type` string
        - `account_name` string
        - `urgency_flag_preference` string
      - CashPickup: Abstract class. Use it's implementations instead.
        - `id` string, uuid
        - `category` 'BankAccount' | 'MobileWallet' | 'CashPickup' | 'Card', required
        - `currency` string
        - `service_provider_name` string
        - `first_name` string
        - `last_name` string
      - Card: Abstract class. Use it's implementations instead.
        - `id` string, uuid
        - `category` 'BankAccount' | 'MobileWallet' | 'CashPickup' | 'Card', required
        - `currency` string
        - `token` string, uuid, required: Card token can be generated using Payall Vault iframe or API. Unencrypted card data should never be sent to this API directly.
        - `masked_number` string

## Other responses

- `404`: Payment instrument is missing

---

[API](https://skmtc.dev/payall/apis/payall-m2m-authentication-api.md) - [All operations](https://skmtc.dev/payall/apis/payall-m2m-authentication-api/llms.txt) - [OpenAPI document](https://skmtc.dev/payall/apis/payall-m2m-authentication-api/revisions/5f561eccd6ce?raw)