List Payment Attempts

GET

payment-attempts

Payments log (tenant-wide payment attempts)

curl --request GET \
  --url https://billing.example.com/v1/payment-attempts \
  --header 'Authorization: Bearer <token>'

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

fetch('https://billing.example.com/v1/payment-attempts', 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://billing.example.com/v1/payment-attempts",
  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://billing.example.com/v1/payment-attempts"

	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://billing.example.com/v1/payment-attempts")

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

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_number": "<string>",
      "currency": "<string>",
      "gateway": "<string>",
      "method": "<string>",
      "gateway_payment_intent_id": "<string>",
      "status": "initiated",
      "failure_code": "<string>",
      "amount": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "settled_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}

Returns every gateway payment attempt for the tenant, newest first, paginated, with an optional status filter. Each row carries its invoice number, so the response reads as the operator’s failed-payments log without a second lookup. A payment attempt is one try at settling an invoice through a gateway — a card charge, an ACH debit, a UPI mandate collection. An invoice can have several (a card’s failed → succeeded, or an ACH debit’s initiated → processing → succeeded → returned); the invoice’s own amount_paid reflects only the ones that settled. See Explain any number for how attempts relate to invoices and the ledger.

Query Parameters

Parameter	Type	Required	Description
`status`	string	No	Filter to one status: `initiated`, `processing`, `succeeded`, `failed`, or `returned`.
`q`	string	No	Case-insensitive substring search on the attempt’s `invoice_number` or gateway payment reference (tenant-scoped), newest first. Backs the command-palette payment lookup; the `status` filter is ignored on the search path.
`page`	integer	No	Page number (default `1`). Ignored when `offset` is given.
`per_page`	integer	No	Rows per page (default `50`, capped at `250`). `limit` is accepted as an alias and wins when both are sent.
`offset`	integer	No	Row offset (default `0`). Overrides the offset computed from `page`.

Example Request

curl -G https://api.recurso.dev/v1/payment-attempts \
  -H "Authorization: Bearer $API_KEY" \
  -d status=failed \
  -d per_page=25

Response

{
  "data": [
    {
      "id": "c2d4e6f8-1a3b-4c5d-9e7f-8a9b0c1d2e3f",
      "invoice_id": "06c151de-8d3a-4b21-9c77-2f0e5a9b4d12",
      "invoice_number": "REC/2026/0042",
      "currency": "USD",
      "gateway": "stripe",
      "method": "card",
      "gateway_payment_intent_id": "pi_3PqR7sK2eZvKYlo2C0Xy1AbC",
      "status": "failed",
      "failure_code": "insufficient_funds",
      "amount": 118000,
      "created_at": "2026-07-02T09:00:00Z",
      "settled_at": null
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1
  }
}

Attempt Fields

Field	Type	Description
`id`	string (uuid)	The attempt’s id — fetch it with Get Payment Attempt
`invoice_id` / `invoice_number`	uuid / string	The invoice the attempt tried to settle
`currency`	string	The invoice’s currency
`gateway`	string	The gateway that processed the attempt (e.g. `stripe`, `razorpay`)
`method`	string	The payment method used
`gateway_payment_intent_id`	string	The gateway’s reference for the attempt
`status`	string	`initiated`, `processing`, `succeeded`, `failed`, or `returned`
`failure_code`	string	Gateway failure or return code; empty when the attempt succeeded
`amount`	integer (int64)	Minor units
`created_at`	string (date-time)	When the attempt was made
`settled_at`	string (date-time), nullable	When funds settled; `null` until then

Read-only. Offline payments recorded by hand live under List Offline Payments, not here.

Authorizations

Authorization

string

header

required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Query Parameters

status

enum<string>

Available options:

initiated,

processing,

succeeded,

failed,

returned

string

Case-insensitive substring search on the attempt's invoice_number or gateway payment reference (tenant-scoped), newest first. Backs the command-palette payment lookup; the status filter is ignored on the search path.

page

integer

default:1

1-based page number.

Required range: x >= 1

per_page

integer

default:50

Records per page (capped at 250).

Required range: 1 <= x <= 250

limit

integer

Alias of per_page (default 50, max 250); when both are sent limit wins.

Required range: 1 <= x <= 250

offset

integer

Row offset (default 0). Overrides the offset computed from page.

Required range: x >= 0

Response

200 - application/json

The payments log page.

data

object[]

Show child attributes

pagination

object

Show child attributes

Payments log (tenant-wide payment attempts)

curl --request GET \
  --url https://billing.example.com/v1/payment-attempts \
  --header 'Authorization: Bearer <token>'

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

fetch('https://billing.example.com/v1/payment-attempts', 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://billing.example.com/v1/payment-attempts",
  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://billing.example.com/v1/payment-attempts"

	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://billing.example.com/v1/payment-attempts")

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

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_number": "<string>",
      "currency": "<string>",
      "gateway": "<string>",
      "method": "<string>",
      "gateway_payment_intent_id": "<string>",
      "status": "initiated",
      "failure_code": "<string>",
      "amount": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "settled_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Query Parameters

Example Request

Response

Attempt Fields

Authorizations

Query Parameters

Response

​Query Parameters

​Example Request

​Response

​Attempt Fields

Authorizations

Query Parameters

Response

Query Parameters

Example Request

Response

Attempt Fields