Get payment method

GET https://api.invunion.com/api/v1/payment-methods/:code payment_methods:read Markdown

Get one catalog payment method by code.

Returns the catalog instrument, including the owner counterparty and shared associations. Bank-connection rows are not returned. Identify the instrument with its code (`PM-NNN`).

Path parameters

Name Type Required

code

Payment method code (`code`).

Example: PM-001

string

Max 50

Required

Errors

This operation can return the following errors in addition to generic HTTP failures.

Error	HTTP code	Description
`Missing Bearer token`	401	The Authorization header is missing or is not a Bearer token.
`Invalid or revoked API key`	401	The API key is unknown, malformed, expired, or has been revoked.
`API key is missing scope payment_methods:read`	403	The key does not include payment_methods:read. A write scope does not imply the matching read scope.
`Too many requests, please try again later`	429	Wait and retry. The Retry-After header is the number of seconds to wait.
`Payment method not found`	404	No catalog payment method with this code exists in the authenticated tenant.
`Internal server error`	500	Unexpected server error. The JSON body includes correlationId. Retry with backoff.

Previous: List payment methods Next: Related counterparties

Request

Requests in the examples call https://api.invunion.com/api/v1/payment-methods/PM-001.

curl --request GET \
  --url https://api.invunion.com/api/v1/payment-methods/PM-001 \
  --header 'accept: application/json' \
  --header 'authorization: Bearer uk_live_YOUR_API_KEY'

import requests

url = "https://api.invunion.com/api/v1/payment-methods/PM-001"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer uk_live_YOUR_API_KEY",
}
response = requests.get(url, headers=headers)
print(response.json())

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.invunion.com/api/v1/payment-methods/PM-001")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Accept'] = 'application/json'
request['Authorization'] = 'Bearer uk_live_YOUR_API_KEY'
response = http.request(request)
puts response.body

const response = await fetch("https://api.invunion.com/api/v1/payment-methods/PM-001", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer uk_live_YOUR_API_KEY"
  },
});
const data = await response.json();

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.invunion.com/api/v1/payment-methods/PM-001", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Authorization", "Bearer uk_live_YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

const response = await fetch("https://api.invunion.com/api/v1/payment-methods/PM-001", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer uk_live_YOUR_API_KEY"
  },
});
console.log(await response.json());

200

{
  "success": true,
  "data": {
    "id": "8a1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "tenant_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "counterparty_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "code": "PM-001",
    "type": "bank_account",
    "name": "Leones Cars EUR",
    "iban": "FR7630006000011234567890189",
    "bic": "BNPAFRPP",
    "currency": "EUR",
    "account_type": "checking",
    "bank_name": "BNP Paribas",
    "bank_country": "FR",
    "identifier": null,
    "status": "active",
    "association_mode": "exclusive",
    "purpose": "catalog",
    "instrument_role": null,
    "is_default": false,
    "counterparty_name": "Leones Cars",
    "counterparty_code": "CPT-042",
    "counterparties": [
      {
        "counterparty_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "counterparty_name": "Leones Cars",
        "counterparty_code": "CPT-042"
      }
    ],
    "tx_count": 12,
    "last_transaction_date": "2026-09-12",
    "created_at": "2026-03-04T12:40:56.656Z",
    "updated_at": "2026-09-12T08:15:22.110Z",
    "metadata": {
      "erp_pm": "BANK-042"
    }
  }
}