Search for a bank account

curl --request GET \
  --url https://api.paj.cash/pub/v2/bank-account \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.paj.cash/pub/v2/bank-account', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paj.cash/pub/v2/bank-account",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.paj.cash/pub/v2/bank-account"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.paj.cash/pub/v2/bank-account")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "someRANDOMid",
  "accountName": "John Doe",
  "accountNumber": "0025635480",
  "bank": "First Bank",
  "address": "FsXpXq8wVTM13NDXxrf2X6PpgJWg9jCxRVuHhtfnojUa"
}

GET

pub

bank-account

Search for a bank account

curl --request GET \
  --url https://api.paj.cash/pub/v2/bank-account \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.paj.cash/pub/v2/bank-account', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paj.cash/pub/v2/bank-account",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.paj.cash/pub/v2/bank-account"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.paj.cash/pub/v2/bank-account")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "someRANDOMid",
  "accountName": "John Doe",
  "accountNumber": "0025635480",
  "bank": "First Bank",
  "address": "FsXpXq8wVTM13NDXxrf2X6PpgJWg9jCxRVuHhtfnojUa"
}

Resolves a single bank account, in either direction:

By address — you saw a deposit land on an address and want to know which bank account it belongs to.
By accountNumber — you have the account number and want the address that pays it.

Pass at least one of the two. Passing neither is a 400; matching nothing is a 404.

This is a lookup, not a registration. An account that has never been through POST /pub/v2/bank-account will not be found here, even if the account number is real.

Authorizations

x-api-key

string

header

required

Query Parameters

address

string

Bank account on-chain address

Example:

"FsXpXq8wVTM13NDXxrf2X6PpgJWg9jCxRVuHhtfnojUa"

accountNumber

string

User's bank account number

Example:

"0025635480"

Response

The matching bank account

string

required

Example:

"someRANDOMid"

accountName

string

required

User's bank acount name

Example:

"John Doe"

accountNumber

string

required

User's bank account number

Example:

"0025635480"

bank

string

required

Bank name

Example:

"First Bank"

address

string

required

Bank Account Address

Example:

"FsXpXq8wVTM13NDXxrf2X6PpgJWg9jCxRVuHhtfnojUa"

⌘I

Bank accounts

Rates

Search for a bank account

Authorizations

Query Parameters

Response