List Payments - ZBX

List Payments

curl --request GET \
  --url https://mapi.zbx.boomfi.xyz/v1/payments \
  --header 'X-API-KEY: <api-key>'

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

fetch('https://mapi.zbx.boomfi.xyz/v1/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://mapi.zbx.boomfi.xyz/v1/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 => [
    "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://mapi.zbx.boomfi.xyz/v1/payments"

	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://mapi.zbx.boomfi.xyz/v1/payments")

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

{
  "data": {
    "items": [
      {}
    ],
    "last_update": "2021-01-01T00:00:00.000Z",
    "next": 10,
    "total": 10
  },
  "error": true
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

GET

/

payments

List Payments

curl --request GET \
  --url https://mapi.zbx.boomfi.xyz/v1/payments \
  --header 'X-API-KEY: <api-key>'

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

fetch('https://mapi.zbx.boomfi.xyz/v1/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://mapi.zbx.boomfi.xyz/v1/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 => [
    "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://mapi.zbx.boomfi.xyz/v1/payments"

	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://mapi.zbx.boomfi.xyz/v1/payments")

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

{
  "data": {
    "items": [
      {}
    ],
    "last_update": "2021-01-01T00:00:00.000Z",
    "next": 10,
    "total": 10
  },
  "error": true
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

customer_id

string

Filter by customer display ID (cus_...).

invoice_id

string

Filter by invoice display ID (inv_...).

invoice_reference

string

Filter by invoice reference string.

limit

integer

Page size. Defaults to 100. Minimum 1, maximum 100.

Required range: 1 <= x <= 100

page

integer

Page number (1-based). Defaults to 1.

Required range: x >= 1

paylink_id

string

Filter by payment link display ID (plink_...).

payment_method

enum<string>[]

Filter by payment method. Accepts one value or a comma-separated list of the allowed values below.

Available options:

Unknown,

MerchantContract,

ProxyWallet,

Unblock,

Payout,

Card,

GooglePay,

ApplePay,

Paypal,

DirectDebit,

Ramp,

RampCryptoSettlement,

Refund,

Deposit

plan_id

string

Filter by plan display ID (plan_...).

since

string<date-time>

Inclusive lower bound on created_at (RFC3339). When set, results are sorted by created_at.

sort

enum<string>

Sort direction for the primary list key (created_at when since/until are set, otherwise id). Defaults to desc.

Available options:

asc,

desc

status

enum<string>[]

Filter by payment status. Accepts one value or a comma-separated list of the allowed values below.

Available options:

Unknown,

RequiresPaymentMethod,

RequiresConfirmation,

RequiresAction,

Processing,

Succeeded,

Canceled,

Failed

until

string<date-time>

Inclusive upper bound on created_at (RFC3339). When set, results are sorted by created_at.

Response

OK

data

object

Paginated payload.

Show child attributes

error

boolean

True when the request failed.