List Payments

Intent

Reads the available payments as a pageable collection without changing them.

When to call it

Call this when an interface, sync, or support workflow needs to inspect payments. Use the filters and paging controls shown below to limit the result.

Access boundary

Authorize the request with a token that carries payments:read.

Successful result

A successful request returns 200. The response schema below defines the body your integration receives.

Operational notes

List payments.

Scopes: payments:read

GET

payments

List Payments

curl --request GET \
  --url https://api.getruba.com/v1/payments/ \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.getruba.com/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://api.getruba.com/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 => [
    "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.getruba.com/v1/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.getruba.com/v1/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

{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "processor": "stripe",
      "amount": 123,
      "currency": "<string>",
      "method": "<string>",
      "decline_reason": "insufficient_funds",
      "decline_message": "Your card has insufficient funds.",
      "organization_id": "<string>",
      "checkout_id": "e4b478fa-cd25-4253-9f1f-8a41e6370ede",
      "order_id": "e4b478fa-cd25-4253-9f1f-8a41e6370ede",
      "method_metadata": {
        "brand": "<string>",
        "last4": "<string>"
      },
      "trigger": "subscription_cycle",
      "processor_metadata": {}
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

You can generate a Personal Access Token from your settings.

Query Parameters

organization_id

Filter by organization ID. The organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

checkout_id

Filter by checkout ID.

order_id

Filter by order ID.

customer_id

Filter by customer ID. The customer ID.

status

Filter by payment status.

Available options:

pending,

succeeded,

failed

method

Filter by payment method.

customer_email

Filter by customer email.

page

integer

default:1

Page number, defaults to 1.

limit

integer

default:10

Size of a page, defaults to 10. Maximum is 100.

sorting

enum<string>[] | null

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Available options:

created_at,

-created_at,

status,

-status,

amount,

-amount,

method,

-method

Response

Successful Response

items

(CardPayment · object | GenericPayment · object)[]

required

Schema of a payment with a card payment method.

CardPayment
GenericPayment

Show child attributes

pagination

Pagination · object

required

Show child attributes

List Refunds### Intent Reads the available refunds as a pageable collection without changing them. ### When to call it Call this when an interface, sync, or support workflow needs to inspect refunds. Use the filters and paging controls shown below to limit the result. ### Access boundary Authorize the request with a token that carries `refunds:read` or `refunds:write`. ### Successful result A successful request returns `200`. The response schema below defines the body your integration receives. ### Operational notes List refunds. **Scopes**: `refunds:read` `refunds:write`

List Payments

curl --request GET \
  --url https://api.getruba.com/v1/payments/ \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.getruba.com/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://api.getruba.com/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 => [
    "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.getruba.com/v1/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.getruba.com/v1/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

{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "processor": "stripe",
      "amount": 123,
      "currency": "<string>",
      "method": "<string>",
      "decline_reason": "insufficient_funds",
      "decline_message": "Your card has insufficient funds.",
      "organization_id": "<string>",
      "checkout_id": "e4b478fa-cd25-4253-9f1f-8a41e6370ede",
      "order_id": "e4b478fa-cd25-4253-9f1f-8a41e6370ede",
      "method_metadata": {
        "brand": "<string>",
        "last4": "<string>"
      },
      "trigger": "subscription_cycle",
      "processor_metadata": {}
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Read This First

Create a Sale

Collect and Reconcile

Manage Recurring Revenue

Model Customer Access

Power the Customer Portal

Configure the Platform

React to State Changes

List Payments

Intent

When to call it

Access boundary

Successful result

Operational notes

Authorizations

Query Parameters

Response