List Payments

curl --request GET \
  --url https://api.prod.finverse.net/payments \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prod.finverse.net/payments', 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.prod.finverse.net/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.prod.finverse.net/payments"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.prod.finverse.net/payments")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "payments": [
    {
      "amount": 500,
      "amount_total_with_surcharge": 752,
      "created_at": "2025-06-21T06:11:19.848Z",
      "currency": "HKD",
      "fees": [
        {
          "amount": 252,
          "currency": "HKD",
          "paid_by": "SENDER",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        },
        {
          "amount": 261,
          "currency": "HKD",
          "paid_by": "RECIPIENT",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        }
      ],
      "metadata": {
        "branch": "branch1",
        "key": "value",
        "stripe_charge_id": "ch_3RcKe4JXxo5qMAzS1Ue37Jxk",
        "stripe_payment_intent_id": "pi_3RcKe4JXxo5qMAzS1nVrP2kt"
      },
      "payment_details": {
        "collection_entity_name": "Finverse Test",
        "description": "Test payment",
        "external_transaction_reference": "1750486279",
        "references": {
          "finverse_transaction_reference": "FV250101GGBB"
        }
      },
      "payment_id": "01JY8HSSGS0GA6VJXYWQ32RYNR",
      "payment_method": {
        "card": {
          "card_details": {
            "brand": "Visa",
            "funding": "UNKNOWN",
            "last4": "4242"
          }
        }
      },
      "payment_method_id": "01JY8H414WA2G39Y18G6E62DFY",
      "recipient": {
        "name": "Finverse Test"
      },
      "recipient_account": {
        "account_id": "01JY8AKPF2CBDBQ6F66N78NA47",
        "account_type": "SETTLEMENT_ACCOUNT"
      },
      "sender": {
        "external_user_id": "user_id_1||1750485561",
        "name": "John Doe",
        "user_details": [],
        "user_id": "01JY8H3WCKB99VSEVZ2P3ZRG35",
        "user_type": "UNKNOWN"
      },
      "status": "EXECUTED",
      "surcharge_amount": 252,
      "type": "CARD",
      "updated_at": "2025-06-21T06:11:21.603Z"
    },
    {
      "amount": 10000,
      "amount_total_with_surcharge": 10575,
      "created_at": "2025-06-21T05:54:42.800Z",
      "currency": "HKD",
      "fees": [
        {
          "amount": 575,
          "currency": "HKD",
          "paid_by": "SENDER",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        },
        {
          "amount": 595,
          "currency": "HKD",
          "paid_by": "RECIPIENT",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        }
      ],
      "metadata": {
        "contract_id": "1234",
        "key": "value",
        "storeganise_invoice_ids": "ABCD",
        "stripe_charge_id": "ch_3RcKOIJXxo5qMAzS1O7zX6Jn",
        "stripe_payment_intent_id": "pi_3RcKOIJXxo5qMAzS1hKaqKIj",
        "user_address": "1 Admiralty Drive",
        "user_city": "Hong Kong",
        "user_country": "HK",
        "user_first_name": "John",
        "user_last_name": "Doe"
      },
      "payment_details": {
        "collection_entity_name": "Finverse Test",
        "description": "TEST Payment",
        "external_transaction_reference": "INV12345",
        "references": {
          "finverse_transaction_reference": "FV250101FFBB"
        }
      },
      "payment_id": "01JY8GVBWG929X02BEDBGPJGPS",
      "payment_method": {
        "card": {
          "card_details": {
            "brand": "Visa",
            "last4": "4242"
          }
        }
      },
      "recipient": {
        "name": "Finverse Test"
      },
      "recipient_account": {
        "account_id": "01JY8AKPF2CBDBQ6F66N78NA47",
        "account_type": "SETTLEMENT_ACCOUNT"
      },
      "sender": {
        "external_user_id": "user_id_1||1750485272",
        "name": "John Doe",
        "user_details": [],
        "user_id": "01JY8GV2MA6X5QRMY2Q8HABFQJ",
        "user_type": "UNKNOWN"
      },
      "status": "EXECUTED",
      "surcharge_amount": 575,
      "type": "CARD",
      "updated_at": "2025-06-21T05:55:05.215Z"
    },
    {
      "amount": 10000,
      "amount_total_with_surcharge": 10575,
      "created_at": "2025-06-21T05:39:28.452Z",
      "currency": "HKD",
      "fees": [
        {
          "amount": 575,
          "currency": "HKD",
          "paid_by": "SENDER",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        },
        {
          "amount": 595,
          "currency": "HKD",
          "paid_by": "RECIPIENT",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        }
      ],
      "metadata": {
        "contract_id": "1234",
        "key": "value",
        "storeganise_invoice_ids": "ABCD",
        "stripe_charge_id": "ch_3RcK9dJXxo5qMAzS0mk3bRL9",
        "stripe_payment_intent_id": "pi_3RcK9dJXxo5qMAzS0WsG04wW",
        "user_address": "1 Admiralty Drive",
        "user_city": "Hong Kong",
        "user_country": "HK",
        "user_first_name": "John",
        "user_last_name": "Doe"
      },
      "payment_details": {
        "collection_entity_name": "Finverse Test",
        "description": "TEST Payment",
        "external_transaction_reference": "INV12345",
        "references": {
          "finverse_transaction_reference": "FV250621EEBB"
        }
      },
      "payment_id": "01JY8FZEZXR3RG0Z8XZQ5CCZB3",
      "payment_method": {
        "card": {
          "card_details": {
            "brand": "Visa",
            "last4": "4242"
          }
        }
      },
      "payment_method_id": "01JY8FZF0TTC86M1WWGH3G98SG",
      "recipient": {
        "name": "Finverse Test"
      },
      "recipient_account": {
        "account_id": "01JY8AKPF2CBDBQ6F66N78NA47",
        "account_type": "SETTLEMENT_ACCOUNT"
      },
      "sender": {
        "external_user_id": "user_id_1||1750484358",
        "name": "John Doe",
        "user_details": [],
        "user_id": "01JY8FZ5XEAQFW3GZZRYK72M1G",
        "user_type": "UNKNOWN"
      },
      "status": "EXECUTED",
      "surcharge_amount": 575,
      "type": "CARD",
      "updated_at": "2025-06-21T05:39:57.257Z"
    },
    {
      "amount": 500,
      "amount_total_with_surcharge": 752,
      "created_at": "2025-06-21T05:26:27.104Z",
      "currency": "HKD",
      "fees": [
        {
          "amount": 252,
          "currency": "HKD",
          "paid_by": "SENDER",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        },
        {
          "amount": 261,
          "currency": "HKD",
          "paid_by": "RECIPIENT",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        }
      ],
      "metadata": {
        "branch": "branch1",
        "key": "updated_value",
        "new_key": "new_value",
        "stripe_charge_id": "ch_3RcJwdJXxo5qMAzS1mMWGQUe",
        "stripe_payment_intent_id": "pi_3RcJwdJXxo5qMAzS1ktHHSbS"
      },
      "payment_details": {
        "collection_entity_name": "Finverse Test",
        "description": "Test payment",
        "external_transaction_reference": "1750483586",
        "references": {
          "finverse_transaction_reference": "FV250621DDBB"
        }
      },
      "payment_id": "01JY8F7KVAW66HAVWTNRGF6RSV",
      "payment_method": {
        "card": {
          "card_details": {
            "brand": "Visa",
            "funding": "UNKNOWN",
            "last4": "4242"
          }
        }
      },
      "payment_method_id": "01JY8DW4DAQY5STF25AE22W5C7",
      "recipient": {
        "name": "Finverse Test"
      },
      "recipient_account": {
        "account_id": "01JY8AKPF2CBDBQ6F66N78NA47",
        "account_type": "SETTLEMENT_ACCOUNT"
      },
      "sender": {
        "external_user_id": "user_id_1||1750482147",
        "name": "John Doe",
        "user_details": [],
        "user_id": "01JY8DVPA28N4TB11N9H57J5CX",
        "user_type": "UNKNOWN"
      },
      "status": "EXECUTED",
      "surcharge_amount": 252,
      "type": "CARD",
      "updated_at": "2025-06-21T05:27:12.719Z"
    },
    {
      "amount": 500,
      "amount_total_with_surcharge": 752,
      "created_at": "2025-06-21T05:24:50.021Z",
      "currency": "HKD",
      "fees": [
        {
          "amount": 252,
          "currency": "HKD",
          "paid_by": "SENDER",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        },
        {
          "amount": 261,
          "currency": "HKD",
          "paid_by": "RECIPIENT",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        }
      ],
      "metadata": {
        "branch": "branch1",
        "key": "value",
        "stripe_charge_id": "ch_3RcJv4JXxo5qMAzS1lyWmNJY",
        "stripe_payment_intent_id": "pi_3RcJv4JXxo5qMAzS189b3VkG"
      },
      "payment_details": {
        "collection_entity_name": "Finverse Test",
        "description": "Test payment",
        "external_transaction_reference": "1750483489",
        "references": {
          "finverse_transaction_reference": "FV250621BBCC"
        }
      },
      "payment_id": "01JY8F4N0WSJMW9P2T73XDF0NX",
      "payment_method": {
        "card": {
          "card_details": {
            "brand": "Visa",
            "funding": "UNKNOWN",
            "last4": "4242"
          }
        }
      },
      "payment_method_id": "01JY8DW4DAQY5STF25AE22W5C7",
      "recipient": {
        "name": "Finverse Test"
      },
      "recipient_account": {
        "account_id": "01JY8AKPF2CBDBQ6F66N78NA47",
        "account_type": "SETTLEMENT_ACCOUNT"
      },
      "sender": {
        "external_user_id": "user_id_1||1750482147",
        "name": "John Doe",
        "user_details": [],
        "user_id": "01JY8DVPA28N4TB11N9H57J5CX",
        "user_type": "UNKNOWN"
      },
      "status": "EXECUTED",
      "surcharge_amount": 252,
      "type": "CARD",
      "updated_at": "2025-06-21T05:24:52.179Z"
    },
    {
      "amount": 10000,
      "amount_total_with_surcharge": 10575,
      "created_at": "2025-06-21T05:02:42.165Z",
      "currency": "HKD",
      "fees": [
        {
          "amount": 575,
          "currency": "HKD",
          "paid_by": "SENDER",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        },
        {
          "amount": 595,
          "currency": "HKD",
          "paid_by": "RECIPIENT",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        }
      ],
      "metadata": {
        "contract_id": "1234",
        "key": "value",
        "storeganise_invoice_ids": "ABCD",
        "stripe_charge_id": "ch_3RcJa1JXxo5qMAzS1JQLl4Nl",
        "stripe_payment_intent_id": "pi_3RcJa1JXxo5qMAzS1T13AcoE",
        "user_address": "1 Admiralty Drive",
        "user_city": "Hong Kong",
        "user_country": "HK",
        "user_first_name": "John",
        "user_last_name": "Doe"
      },
      "payment_details": {
        "collection_entity_name": "Finverse Test",
        "description": "TEST Payment",
        "external_transaction_reference": "INV12345",
        "references": {
          "finverse_transaction_reference": "FV250621AABB"
        }
      },
      "payment_id": "01JY8DW4CGB3Z0WTBHZFSZTJZ4",
      "payment_method": {
        "card": {
          "card_details": {
            "brand": "Visa",
            "last4": "4242"
          }
        }
      },
      "payment_method_id": "01JY8DW4DAQY5STF25AE22W5C7",
      "recipient": {
        "name": "Finverse Test"
      },
      "recipient_account": {
        "account_id": "01JY8AKPF2CBDBQ6F66N78NA47",
        "account_type": "SETTLEMENT_ACCOUNT"
      },
      "sender": {
        "external_user_id": "user_id_1||1750482147",
        "name": "John Doe",
        "user_details": [],
        "user_id": "01JY8DVPA28N4TB11N9H57J5CX",
        "user_type": "UNKNOWN"
      },
      "status": "EXECUTED",
      "surcharge_amount": 575,
      "type": "CARD",
      "updated_at": "2025-06-21T05:03:09.340Z"
    }
  ],
  "total_payments": 6
}

GET

payments

List Payments

curl --request GET \
  --url https://api.prod.finverse.net/payments \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prod.finverse.net/payments', 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.prod.finverse.net/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.prod.finverse.net/payments"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.prod.finverse.net/payments")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "payments": [
    {
      "amount": 500,
      "amount_total_with_surcharge": 752,
      "created_at": "2025-06-21T06:11:19.848Z",
      "currency": "HKD",
      "fees": [
        {
          "amount": 252,
          "currency": "HKD",
          "paid_by": "SENDER",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        },
        {
          "amount": 261,
          "currency": "HKD",
          "paid_by": "RECIPIENT",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        }
      ],
      "metadata": {
        "branch": "branch1",
        "key": "value",
        "stripe_charge_id": "ch_3RcKe4JXxo5qMAzS1Ue37Jxk",
        "stripe_payment_intent_id": "pi_3RcKe4JXxo5qMAzS1nVrP2kt"
      },
      "payment_details": {
        "collection_entity_name": "Finverse Test",
        "description": "Test payment",
        "external_transaction_reference": "1750486279",
        "references": {
          "finverse_transaction_reference": "FV250101GGBB"
        }
      },
      "payment_id": "01JY8HSSGS0GA6VJXYWQ32RYNR",
      "payment_method": {
        "card": {
          "card_details": {
            "brand": "Visa",
            "funding": "UNKNOWN",
            "last4": "4242"
          }
        }
      },
      "payment_method_id": "01JY8H414WA2G39Y18G6E62DFY",
      "recipient": {
        "name": "Finverse Test"
      },
      "recipient_account": {
        "account_id": "01JY8AKPF2CBDBQ6F66N78NA47",
        "account_type": "SETTLEMENT_ACCOUNT"
      },
      "sender": {
        "external_user_id": "user_id_1||1750485561",
        "name": "John Doe",
        "user_details": [],
        "user_id": "01JY8H3WCKB99VSEVZ2P3ZRG35",
        "user_type": "UNKNOWN"
      },
      "status": "EXECUTED",
      "surcharge_amount": 252,
      "type": "CARD",
      "updated_at": "2025-06-21T06:11:21.603Z"
    },
    {
      "amount": 10000,
      "amount_total_with_surcharge": 10575,
      "created_at": "2025-06-21T05:54:42.800Z",
      "currency": "HKD",
      "fees": [
        {
          "amount": 575,
          "currency": "HKD",
          "paid_by": "SENDER",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        },
        {
          "amount": 595,
          "currency": "HKD",
          "paid_by": "RECIPIENT",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        }
      ],
      "metadata": {
        "contract_id": "1234",
        "key": "value",
        "storeganise_invoice_ids": "ABCD",
        "stripe_charge_id": "ch_3RcKOIJXxo5qMAzS1O7zX6Jn",
        "stripe_payment_intent_id": "pi_3RcKOIJXxo5qMAzS1hKaqKIj",
        "user_address": "1 Admiralty Drive",
        "user_city": "Hong Kong",
        "user_country": "HK",
        "user_first_name": "John",
        "user_last_name": "Doe"
      },
      "payment_details": {
        "collection_entity_name": "Finverse Test",
        "description": "TEST Payment",
        "external_transaction_reference": "INV12345",
        "references": {
          "finverse_transaction_reference": "FV250101FFBB"
        }
      },
      "payment_id": "01JY8GVBWG929X02BEDBGPJGPS",
      "payment_method": {
        "card": {
          "card_details": {
            "brand": "Visa",
            "last4": "4242"
          }
        }
      },
      "recipient": {
        "name": "Finverse Test"
      },
      "recipient_account": {
        "account_id": "01JY8AKPF2CBDBQ6F66N78NA47",
        "account_type": "SETTLEMENT_ACCOUNT"
      },
      "sender": {
        "external_user_id": "user_id_1||1750485272",
        "name": "John Doe",
        "user_details": [],
        "user_id": "01JY8GV2MA6X5QRMY2Q8HABFQJ",
        "user_type": "UNKNOWN"
      },
      "status": "EXECUTED",
      "surcharge_amount": 575,
      "type": "CARD",
      "updated_at": "2025-06-21T05:55:05.215Z"
    },
    {
      "amount": 10000,
      "amount_total_with_surcharge": 10575,
      "created_at": "2025-06-21T05:39:28.452Z",
      "currency": "HKD",
      "fees": [
        {
          "amount": 575,
          "currency": "HKD",
          "paid_by": "SENDER",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        },
        {
          "amount": 595,
          "currency": "HKD",
          "paid_by": "RECIPIENT",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        }
      ],
      "metadata": {
        "contract_id": "1234",
        "key": "value",
        "storeganise_invoice_ids": "ABCD",
        "stripe_charge_id": "ch_3RcK9dJXxo5qMAzS0mk3bRL9",
        "stripe_payment_intent_id": "pi_3RcK9dJXxo5qMAzS0WsG04wW",
        "user_address": "1 Admiralty Drive",
        "user_city": "Hong Kong",
        "user_country": "HK",
        "user_first_name": "John",
        "user_last_name": "Doe"
      },
      "payment_details": {
        "collection_entity_name": "Finverse Test",
        "description": "TEST Payment",
        "external_transaction_reference": "INV12345",
        "references": {
          "finverse_transaction_reference": "FV250621EEBB"
        }
      },
      "payment_id": "01JY8FZEZXR3RG0Z8XZQ5CCZB3",
      "payment_method": {
        "card": {
          "card_details": {
            "brand": "Visa",
            "last4": "4242"
          }
        }
      },
      "payment_method_id": "01JY8FZF0TTC86M1WWGH3G98SG",
      "recipient": {
        "name": "Finverse Test"
      },
      "recipient_account": {
        "account_id": "01JY8AKPF2CBDBQ6F66N78NA47",
        "account_type": "SETTLEMENT_ACCOUNT"
      },
      "sender": {
        "external_user_id": "user_id_1||1750484358",
        "name": "John Doe",
        "user_details": [],
        "user_id": "01JY8FZ5XEAQFW3GZZRYK72M1G",
        "user_type": "UNKNOWN"
      },
      "status": "EXECUTED",
      "surcharge_amount": 575,
      "type": "CARD",
      "updated_at": "2025-06-21T05:39:57.257Z"
    },
    {
      "amount": 500,
      "amount_total_with_surcharge": 752,
      "created_at": "2025-06-21T05:26:27.104Z",
      "currency": "HKD",
      "fees": [
        {
          "amount": 252,
          "currency": "HKD",
          "paid_by": "SENDER",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        },
        {
          "amount": 261,
          "currency": "HKD",
          "paid_by": "RECIPIENT",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        }
      ],
      "metadata": {
        "branch": "branch1",
        "key": "updated_value",
        "new_key": "new_value",
        "stripe_charge_id": "ch_3RcJwdJXxo5qMAzS1mMWGQUe",
        "stripe_payment_intent_id": "pi_3RcJwdJXxo5qMAzS1ktHHSbS"
      },
      "payment_details": {
        "collection_entity_name": "Finverse Test",
        "description": "Test payment",
        "external_transaction_reference": "1750483586",
        "references": {
          "finverse_transaction_reference": "FV250621DDBB"
        }
      },
      "payment_id": "01JY8F7KVAW66HAVWTNRGF6RSV",
      "payment_method": {
        "card": {
          "card_details": {
            "brand": "Visa",
            "funding": "UNKNOWN",
            "last4": "4242"
          }
        }
      },
      "payment_method_id": "01JY8DW4DAQY5STF25AE22W5C7",
      "recipient": {
        "name": "Finverse Test"
      },
      "recipient_account": {
        "account_id": "01JY8AKPF2CBDBQ6F66N78NA47",
        "account_type": "SETTLEMENT_ACCOUNT"
      },
      "sender": {
        "external_user_id": "user_id_1||1750482147",
        "name": "John Doe",
        "user_details": [],
        "user_id": "01JY8DVPA28N4TB11N9H57J5CX",
        "user_type": "UNKNOWN"
      },
      "status": "EXECUTED",
      "surcharge_amount": 252,
      "type": "CARD",
      "updated_at": "2025-06-21T05:27:12.719Z"
    },
    {
      "amount": 500,
      "amount_total_with_surcharge": 752,
      "created_at": "2025-06-21T05:24:50.021Z",
      "currency": "HKD",
      "fees": [
        {
          "amount": 252,
          "currency": "HKD",
          "paid_by": "SENDER",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        },
        {
          "amount": 261,
          "currency": "HKD",
          "paid_by": "RECIPIENT",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        }
      ],
      "metadata": {
        "branch": "branch1",
        "key": "value",
        "stripe_charge_id": "ch_3RcJv4JXxo5qMAzS1lyWmNJY",
        "stripe_payment_intent_id": "pi_3RcJv4JXxo5qMAzS189b3VkG"
      },
      "payment_details": {
        "collection_entity_name": "Finverse Test",
        "description": "Test payment",
        "external_transaction_reference": "1750483489",
        "references": {
          "finverse_transaction_reference": "FV250621BBCC"
        }
      },
      "payment_id": "01JY8F4N0WSJMW9P2T73XDF0NX",
      "payment_method": {
        "card": {
          "card_details": {
            "brand": "Visa",
            "funding": "UNKNOWN",
            "last4": "4242"
          }
        }
      },
      "payment_method_id": "01JY8DW4DAQY5STF25AE22W5C7",
      "recipient": {
        "name": "Finverse Test"
      },
      "recipient_account": {
        "account_id": "01JY8AKPF2CBDBQ6F66N78NA47",
        "account_type": "SETTLEMENT_ACCOUNT"
      },
      "sender": {
        "external_user_id": "user_id_1||1750482147",
        "name": "John Doe",
        "user_details": [],
        "user_id": "01JY8DVPA28N4TB11N9H57J5CX",
        "user_type": "UNKNOWN"
      },
      "status": "EXECUTED",
      "surcharge_amount": 252,
      "type": "CARD",
      "updated_at": "2025-06-21T05:24:52.179Z"
    },
    {
      "amount": 10000,
      "amount_total_with_surcharge": 10575,
      "created_at": "2025-06-21T05:02:42.165Z",
      "currency": "HKD",
      "fees": [
        {
          "amount": 575,
          "currency": "HKD",
          "paid_by": "SENDER",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        },
        {
          "amount": 595,
          "currency": "HKD",
          "paid_by": "RECIPIENT",
          "paid_by_account_id": "01JY8AKPF2CBDBQ6F66N78NA47"
        }
      ],
      "metadata": {
        "contract_id": "1234",
        "key": "value",
        "storeganise_invoice_ids": "ABCD",
        "stripe_charge_id": "ch_3RcJa1JXxo5qMAzS1JQLl4Nl",
        "stripe_payment_intent_id": "pi_3RcJa1JXxo5qMAzS1T13AcoE",
        "user_address": "1 Admiralty Drive",
        "user_city": "Hong Kong",
        "user_country": "HK",
        "user_first_name": "John",
        "user_last_name": "Doe"
      },
      "payment_details": {
        "collection_entity_name": "Finverse Test",
        "description": "TEST Payment",
        "external_transaction_reference": "INV12345",
        "references": {
          "finverse_transaction_reference": "FV250621AABB"
        }
      },
      "payment_id": "01JY8DW4CGB3Z0WTBHZFSZTJZ4",
      "payment_method": {
        "card": {
          "card_details": {
            "brand": "Visa",
            "last4": "4242"
          }
        }
      },
      "payment_method_id": "01JY8DW4DAQY5STF25AE22W5C7",
      "recipient": {
        "name": "Finverse Test"
      },
      "recipient_account": {
        "account_id": "01JY8AKPF2CBDBQ6F66N78NA47",
        "account_type": "SETTLEMENT_ACCOUNT"
      },
      "sender": {
        "external_user_id": "user_id_1||1750482147",
        "name": "John Doe",
        "user_details": [],
        "user_id": "01JY8DVPA28N4TB11N9H57J5CX",
        "user_type": "UNKNOWN"
      },
      "status": "EXECUTED",
      "surcharge_amount": 575,
      "type": "CARD",
      "updated_at": "2025-06-21T05:03:09.340Z"
    }
  ],
  "total_payments": 6
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

date_from

string<date>

Start date for filtering (applied to Payment updated_at field)

date_to

string<date>

End date for filtering (applied to Payment updated_at field)

statuses

enum<string>[]

Comma-separated filter for specific Payment statuses. Example: statuses=SUCCEEDED FAILED. Refer to Payment statuses in GET /payments/{payment_id}

Available options:

AUTHORIZATION_REQUIRED,

AUTHORIZING,

PROCESSING,

SUBMITTED,

EXECUTED,

FAILED,

REVOKED,

CANCELLED,

CREATED

sender_type

enum<string>

Filter for a specific sender type. Refer to Payment sender_type in GET /payments/{payment_id}

Available options:

INDIVIDUAL,

BUSINESS

user_id

string

[Coming soon] Finverse unique ID for the user.

institution_id

string

Filter for a specific Institution ID

payment_type

enum<string>

Deprecated - The type of payment

Available options:

MANDATE,

SINGLE,

CARD,

MANUAL,

WALLET

payment_types

enum<string>[]

Comma-separated filter for specific Payment types. Refer to payment_type in GET /payments/{payment_id}

Available options:

MANDATE,

SINGLE,

CARD,

MANUAL,

WALLET

mandate_id

string

Filter for Payments under a specific Mandate

currency

string

Deprecated - The currency the payment is made in

currencies

string[]

Comma-separated filter for a specific of currencies

offset

integer

default:0

Pagination offset (default: 0)

limit

integer

default:500

Maximum number of records per page (default: 500, max: 1000)

Required range: 1 <= x <= 1000

Response

Successful

total_payments

integer

required

Total number of Payment records available for the selected filtering criteria (can be used to inform pagination requests)

payments

object[]

List of Payment objects that satisfy the filters in the request. Refer to Payment object data model in GET /payments/{payment_id}

Show child attributes