Invoice Payment Attempts

GET

invoices

{id}

payment-attempts

Invoice payment attempts (settlement history)

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

import requests

url = "https://billing.example.com/v1/invoices/{id}/payment-attempts"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://billing.example.com/v1/invoices/{id}/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/invoices/{id}/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/invoices/{id}/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/invoices/{id}/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": {
    "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attempts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "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"
      }
    ]
  }
}

Returns the invoice’s payment attempts, oldest first — its retry/settlement history: a card’s failed → succeeded, or an ACH debit’s initiated → processing → succeeded → returned. Each attempt carries its status, failure code, gateway and payment-intent reference, amount, and settled-at. Read this alongside the status timeline (what the invoice’s status did) and the journal entries (what the ledger recorded): a succeeded attempt is what produces the invoice’s Code-3 payment posting. See Explain any number.

Example Request

curl "https://api.recurso.dev/v1/invoices/06c151de-8d3a-4b21-9c77-2f0e5a9b4d12/payment-attempts" \
  -H "Authorization: Bearer $API_KEY"

Example Response

{
  "data": {
    "invoice_id": "06c151de-8d3a-4b21-9c77-2f0e5a9b4d12",
    "attempts": [
      {
        "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
        "invoice_id": "06c151de-8d3a-4b21-9c77-2f0e5a9b4d12",
        "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
      },
      {
        "id": "c2d4e6f8-1a3b-4c5d-9e7f-8a9b0c1d2e3f",
        "invoice_id": "06c151de-8d3a-4b21-9c77-2f0e5a9b4d12",
        "gateway": "stripe",
        "method": "card",
        "gateway_payment_intent_id": "pi_3PqR7sK2eZvKYlo2C0Xy1DeF",
        "status": "succeeded",
        "failure_code": "",
        "amount": 118000,
        "created_at": "2026-07-03T14:22:00Z",
        "settled_at": "2026-07-03T14:22:10Z"
      }
    ]
  }
}

Attempt Fields

Field	Type	Description
`id`	string (uuid)	The attempt’s id — fetch it with Get Payment Attempt
`gateway`	string	The gateway that processed the attempt
`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. An existing invoice with no attempts returns an empty attempts list; a missing or cross-tenant id returns 404.

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Response

The invoice's payment attempts.

data

object

Show child attributes

Invoice payment attempts (settlement history)

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

import requests

url = "https://billing.example.com/v1/invoices/{id}/payment-attempts"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://billing.example.com/v1/invoices/{id}/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/invoices/{id}/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/invoices/{id}/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/invoices/{id}/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": {
    "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attempts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "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"
      }
    ]
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Invoice Payment Attempts

Example Request

Example Response

Attempt Fields

Authorizations

Path Parameters

Response

​Example Request

​Example Response

​Attempt Fields

Authorizations

Path Parameters

Response

Example Request

Example Response

Attempt Fields