List Collects

List Collects

curl --request GET \
  --url https://service-sandbox.tazapay.com/v3/collect \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://service-sandbox.tazapay.com/v3/collect', 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://service-sandbox.tazapay.com/v3/collect",
  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: Basic <encoded-value>"
  ],
]);

$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://service-sandbox.tazapay.com/v3/collect"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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://service-sandbox.tazapay.com/v3/collect")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "status": "success",
  "message": "",
  "data": {
    "object": "list",
    "has_more": false,
    "results": [
      {
        "amount": 12829,
        "balance_transaction": "btr_u7ftrgipu69og2qj1j1pg",
        "created_at": "2027-08-15T03:43:46.980Z",
        "currency": "SGD",
        "destination": "cva_d2dgk0ka772psfuj1he0",
        "destination_details": {
          "type": "virtual_account",
          "virtual_account": {
            "account_holder_name": "OM Grand Limited",
            "account_number": "0109866363",
            "bank_address": {
              "address_line_1": "",
              "address_line_2": "",
              "city": "",
              "country": "Singapore",
              "postal_code": "",
              "state": ""
            },
            "bank_branch": "8 MARINA BOULEVARD, 27-01, MARINA BAY FINANCIAL CENTRE",
            "bank_codes": {
              "swift_code": "SLSGO2XXX"
            },
            "bank_name": "STANDARD BANK LIMITED",
            "currencies": [
              "SGD"
            ],
            "iban": "",
            "id": "cva_d2dgk0552psfuj1he0",
            "object": "virtual_account"
          }
        },
        "holding_currency": "SGD",
        "id": "col_d2fapsh76og2qj0ej5g",
        "metadata": {},
        "object": "collect",
        "on_behalf_of": "",
        "payer_details": {
          "additional_information": "CM Payment for Order 56",
          "name": "CMC COMPANY",
          "payer_bank": {
            "account_number": "1112019837840",
            "address": null,
            "bank_codes": {
              "swift_code": "AJUM7CHBKXXX"
            },
            "name": "C Bank"
          },
          "reference_id": ""
        },
        "status": "succeeded",
        "tracking_details": null,
        "type": "wire_transfer"
      }
    ]
  }
}

{
  "status": "error",
  "message": "Bad Request : Your request is invalid",
  "errors": [
    {
      "code": 19750,
      "message": "limit is invalid and should be between 1 to 100",
      "remarks": "limit"
    }
  ]
}

GET

collect

List Collects

curl --request GET \
  --url https://service-sandbox.tazapay.com/v3/collect \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://service-sandbox.tazapay.com/v3/collect', 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://service-sandbox.tazapay.com/v3/collect",
  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: Basic <encoded-value>"
  ],
]);

$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://service-sandbox.tazapay.com/v3/collect"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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://service-sandbox.tazapay.com/v3/collect")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "status": "success",
  "message": "",
  "data": {
    "object": "list",
    "has_more": false,
    "results": [
      {
        "amount": 12829,
        "balance_transaction": "btr_u7ftrgipu69og2qj1j1pg",
        "created_at": "2027-08-15T03:43:46.980Z",
        "currency": "SGD",
        "destination": "cva_d2dgk0ka772psfuj1he0",
        "destination_details": {
          "type": "virtual_account",
          "virtual_account": {
            "account_holder_name": "OM Grand Limited",
            "account_number": "0109866363",
            "bank_address": {
              "address_line_1": "",
              "address_line_2": "",
              "city": "",
              "country": "Singapore",
              "postal_code": "",
              "state": ""
            },
            "bank_branch": "8 MARINA BOULEVARD, 27-01, MARINA BAY FINANCIAL CENTRE",
            "bank_codes": {
              "swift_code": "SLSGO2XXX"
            },
            "bank_name": "STANDARD BANK LIMITED",
            "currencies": [
              "SGD"
            ],
            "iban": "",
            "id": "cva_d2dgk0552psfuj1he0",
            "object": "virtual_account"
          }
        },
        "holding_currency": "SGD",
        "id": "col_d2fapsh76og2qj0ej5g",
        "metadata": {},
        "object": "collect",
        "on_behalf_of": "",
        "payer_details": {
          "additional_information": "CM Payment for Order 56",
          "name": "CMC COMPANY",
          "payer_bank": {
            "account_number": "1112019837840",
            "address": null,
            "bank_codes": {
              "swift_code": "AJUM7CHBKXXX"
            },
            "name": "C Bank"
          },
          "reference_id": ""
        },
        "status": "succeeded",
        "tracking_details": null,
        "type": "wire_transfer"
      }
    ]
  }
}

{
  "status": "error",
  "message": "Bad Request : Your request is invalid",
  "errors": [
    {
      "code": 19750,
      "message": "limit is invalid and should be between 1 to 100",
      "remarks": "limit"
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

limit

integer<int32>

default:10

Number of collects to return, from 1 to 100. Default is 10.

Required range: 1 <= x <= 100

starting_after

string

A collect ID (starts with col_) used as a cursor. Returns the collects created after this collect, oldest first. Cannot be used together with ending_before.

ending_before

string

A collect ID (starts with col_) used as a cursor. Returns the collects created before this collect, newest first. Cannot be used together with starting_after.

created.gt

string<date-time>

Returns collects created after this time (RFC 3339, e.g. 2026-10-01T00:00:00Z).

created.gte

string<date-time>

Returns collects created at or after this time. Cannot be used together with created.gt.

created.lt

string<date-time>

Returns collects created before this time.

created.lte

string<date-time>

Returns collects created at or before this time. Cannot be used together with created.lt.

type

string

Filter by the type of the collect, exact match, e.g. wire_transfer, local_bank_transfer, stablecoin_usdc or stablecoin_usdt. local_bank_transfer also returns the currency specific local bank transfers (e.g. local_bank_transfer_eur).

destination

string

Filter by the collection account ID (starts with cva_, cwa_ or cta_).

status

string

Filter by the status of the collect, exact match: compliance_hold, on_hold, detected, succeeded, failed, reversal_initiated or reversed.

currency

string

Filter by the currency of the collect (ISO 4217, e.g. SGD, or a supported stablecoin).

on_behalf_of

string

Filter by the entity the collects were made on behalf of (starts with ent_).

Response

List of collects.

status

string

Status of API request

message

string

Message returned as part of the API response

data

object

Show child attributes

API Overview

Tazapay API

JavaScript SDK

Appendix

Authorizations

Query Parameters

Response